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.



15500
15501
15502
15503
15504
15505
15506
15507
15508
15509
15510
15511
15512
15513
15514
15515
15516
15517
15518
15519
15520
15521
15522
 
# File 'lib/models/porcelain.rb', line 15500

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.



15475
15476
15477
 
# File 'lib/models/porcelain.rb', line 15475

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.



15478
15479
15480
 
# File 'lib/models/porcelain.rb', line 15478

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.



15480
15481
15482
 
# File 'lib/models/porcelain.rb', line 15480

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



15482
15483
15484
 
# File 'lib/models/porcelain.rb', line 15482

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



15484
15485
15486
 
# File 'lib/models/porcelain.rb', line 15484

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



15486
15487
15488
 
# File 'lib/models/porcelain.rb', line 15486

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.



15492
15493
15494
 
# File 'lib/models/porcelain.rb', line 15492

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



15494
15495
15496
 
# File 'lib/models/porcelain.rb', line 15494

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



15496
15497
15498
 
# File 'lib/models/porcelain.rb', line 15496

def name
  @name
end

#weight ⇒ Object

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



15498
15499
15500
 
# File 'lib/models/porcelain.rb', line 15498

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



15524
15525
15526
15527
15528
15529
15530
 
# File 'lib/models/porcelain.rb', line 15524

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