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.



15382
15383
15384
15385
15386
15387
15388
15389
15390
15391
15392
15393
15394
15395
15396
15397
15398
15399
15400
15401
15402
15403
15404
 
# File 'lib/models/porcelain.rb', line 15382

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.



15357
15358
15359
 
# File 'lib/models/porcelain.rb', line 15357

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.



15360
15361
15362
 
# File 'lib/models/porcelain.rb', line 15360

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.



15362
15363
15364
 
# File 'lib/models/porcelain.rb', line 15362

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



15364
15365
15366
 
# File 'lib/models/porcelain.rb', line 15364

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



15366
15367
15368
 
# File 'lib/models/porcelain.rb', line 15366

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



15368
15369
15370
 
# File 'lib/models/porcelain.rb', line 15368

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.



15374
15375
15376
 
# File 'lib/models/porcelain.rb', line 15374

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



15376
15377
15378
 
# File 'lib/models/porcelain.rb', line 15376

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



15378
15379
15380
 
# File 'lib/models/porcelain.rb', line 15378

def name
  @name
end

#weight ⇒ Object

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



15380
15381
15382
 
# File 'lib/models/porcelain.rb', line 15380

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



15406
15407
15408
15409
15410
15411
15412
 
# File 'lib/models/porcelain.rb', line 15406

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