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.



19207
19208
19209
19210
19211
19212
19213
19214
19215
19216
19217
19218
19219
19220
19221
19222
19223
19224
19225
19226
19227
19228
19229
 
# File 'lib/models/porcelain.rb', line 19207

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.



19182
19183
19184
 
# File 'lib/models/porcelain.rb', line 19182

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.



19185
19186
19187
 
# File 'lib/models/porcelain.rb', line 19185

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.



19187
19188
19189
 
# File 'lib/models/porcelain.rb', line 19187

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



19189
19190
19191
 
# File 'lib/models/porcelain.rb', line 19189

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



19191
19192
19193
 
# File 'lib/models/porcelain.rb', line 19191

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



19193
19194
19195
 
# File 'lib/models/porcelain.rb', line 19193

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.



19199
19200
19201
 
# File 'lib/models/porcelain.rb', line 19199

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



19201
19202
19203
 
# File 'lib/models/porcelain.rb', line 19201

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



19203
19204
19205
 
# File 'lib/models/porcelain.rb', line 19203

def name
  @name
end

#weight ⇒ Object

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



19205
19206
19207
 
# File 'lib/models/porcelain.rb', line 19205

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



19231
19232
19233
19234
19235
19236
19237
 
# File 'lib/models/porcelain.rb', line 19231

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