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.



18376
18377
18378
18379
18380
18381
18382
18383
18384
18385
18386
18387
18388
18389
18390
18391
18392
18393
18394
18395
18396
18397
18398
 
# File 'lib/models/porcelain.rb', line 18376

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.



18351
18352
18353
 
# File 'lib/models/porcelain.rb', line 18351

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.



18354
18355
18356
 
# File 'lib/models/porcelain.rb', line 18354

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.



18356
18357
18358
 
# File 'lib/models/porcelain.rb', line 18356

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



18358
18359
18360
 
# File 'lib/models/porcelain.rb', line 18358

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



18360
18361
18362
 
# File 'lib/models/porcelain.rb', line 18360

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



18362
18363
18364
 
# File 'lib/models/porcelain.rb', line 18362

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.



18368
18369
18370
 
# File 'lib/models/porcelain.rb', line 18368

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



18370
18371
18372
 
# File 'lib/models/porcelain.rb', line 18370

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



18372
18373
18374
 
# File 'lib/models/porcelain.rb', line 18372

def name
  @name
end

#weight ⇒ Object

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



18374
18375
18376
 
# File 'lib/models/porcelain.rb', line 18374

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



18400
18401
18402
18403
18404
18405
18406
 
# File 'lib/models/porcelain.rb', line 18400

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