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.



15464
15465
15466
15467
15468
15469
15470
15471
15472
15473
15474
15475
15476
15477
15478
15479
15480
15481
15482
15483
15484
15485
15486
 
# File 'lib/models/porcelain.rb', line 15464

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.



15439
15440
15441
 
# File 'lib/models/porcelain.rb', line 15439

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.



15442
15443
15444
 
# File 'lib/models/porcelain.rb', line 15442

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.



15444
15445
15446
 
# File 'lib/models/porcelain.rb', line 15444

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



15446
15447
15448
 
# File 'lib/models/porcelain.rb', line 15446

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



15448
15449
15450
 
# File 'lib/models/porcelain.rb', line 15448

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



15450
15451
15452
 
# File 'lib/models/porcelain.rb', line 15450

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.



15456
15457
15458
 
# File 'lib/models/porcelain.rb', line 15456

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



15458
15459
15460
 
# File 'lib/models/porcelain.rb', line 15458

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



15460
15461
15462
 
# File 'lib/models/porcelain.rb', line 15460

def name
  @name
end

#weight ⇒ Object

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



15462
15463
15464
 
# File 'lib/models/porcelain.rb', line 15462

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



15488
15489
15490
15491
15492
15493
15494
 
# File 'lib/models/porcelain.rb', line 15488

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