Class: SDM::Workflow

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

Overview

Workflows are the collection of rules that define the resources to which access can be requested, the users that can request that access, and the mechanism for approving those requests which can either but automatic approval or a set of users authorized to approve the requests.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(access_request_fixed_duration: nil, access_request_max_duration: nil, access_rules: nil, approval_flow_id: nil, auto_grant: nil, description: nil, enabled: nil, id: nil, name: nil, weight: nil) ⇒ Workflow

Returns a new instance of Workflow.



19123
19124
19125
19126
19127
19128
19129
19130
19131
19132
19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
 
# File 'lib/models/porcelain.rb', line 19123

def initialize(
  access_request_fixed_duration: nil,
  access_request_max_duration: nil,
  access_rules: nil,
  approval_flow_id: nil,
  auto_grant: nil,
  description: nil,
  enabled: nil,
  id: nil,
  name: nil,
  weight: nil
)
  @access_request_fixed_duration = access_request_fixed_duration == nil ? nil : access_request_fixed_duration
  @access_request_max_duration = access_request_max_duration == nil ? nil : access_request_max_duration
  @access_rules = access_rules == nil ? SDM::_porcelain_zero_value_access_rules() : access_rules
  @approval_flow_id = approval_flow_id == nil ? "" : approval_flow_id
  @auto_grant = auto_grant == nil ? false : auto_grant
  @description = description == nil ? "" : description
  @enabled = enabled == nil ? false : enabled
  @id = id == nil ? "" : id
  @name = name == nil ? "" : name
  @weight = weight == nil ? 0 : weight
end

Instance Attribute Details

#access_request_fixed_duration ⇒ Object

Fixed Duration of access requests bound to this workflow. If fixed duration is provided, max duration must be empty. If neither max nor fixed duration are provided, requests that bind to this workflow will use the organization-level settings.



19098
19099
19100
 
# File 'lib/models/porcelain.rb', line 19098

def access_request_fixed_duration
  @access_request_fixed_duration
end

#access_request_max_duration ⇒ Object

Maximum Duration of access requests bound to this workflow. If max duration is provided, fixed duration must be empty. If neither max nor fixed duration are provided, requests that bind to this workflow will use the organization-level settings.



19101
19102
19103
 
# File 'lib/models/porcelain.rb', line 19101

def access_request_max_duration
  @access_request_max_duration
end

#access_rules ⇒ Object

AccessRules is a list of access rules defining the resources this Workflow provides access to.



19103
19104
19105
 
# File 'lib/models/porcelain.rb', line 19103

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

Optional approval flow ID identifies an approval flow that linked to the workflow



19105
19106
19107
 
# File 'lib/models/porcelain.rb', line 19105

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

Optional auto grant setting to automatically approve requests or not, defaults to false.



19107
19108
19109
 
# File 'lib/models/porcelain.rb', line 19107

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



19109
19110
19111
 
# File 'lib/models/porcelain.rb', line 19109

def description
  @description
end

#enabled ⇒ Object

Optional enabled state for workflow. This setting may be overridden by the system if the workflow doesn't meet the requirements to be enabled or if other conditions prevent enabling the workflow. The requirements to enable a workflow are that the workflow must be either set up for with auto grant enabled or have one or more WorkflowApprovers created for the workflow.



19115
19116
19117
 
# File 'lib/models/porcelain.rb', line 19115

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



19117
19118
19119
 
# File 'lib/models/porcelain.rb', line 19117

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



19119
19120
19121
 
# File 'lib/models/porcelain.rb', line 19119

def name
  @name
end

#weight ⇒ Object

Optional weight for workflow to specify it's priority in matching a request.



19121
19122
19123
 
# File 'lib/models/porcelain.rb', line 19121

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



19147
19148
19149
19150
19151
19152
19153
 
# File 'lib/models/porcelain.rb', line 19147

def to_json(options = {})
  hash = {}
  self.instance_variables.each do |var|
    hash[var.id2name.delete_prefix("@")] = self.instance_variable_get var
  end
  hash.to_json
end