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.



17462
17463
17464
17465
17466
17467
17468
17469
17470
17471
17472
17473
17474
17475
17476
17477
17478
17479
17480
17481
17482
17483
17484
 
# File 'lib/models/porcelain.rb', line 17462

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.



17437
17438
17439
 
# File 'lib/models/porcelain.rb', line 17437

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.



17440
17441
17442
 
# File 'lib/models/porcelain.rb', line 17440

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.



17442
17443
17444
 
# File 'lib/models/porcelain.rb', line 17442

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



17444
17445
17446
 
# File 'lib/models/porcelain.rb', line 17444

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



17446
17447
17448
 
# File 'lib/models/porcelain.rb', line 17446

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



17448
17449
17450
 
# File 'lib/models/porcelain.rb', line 17448

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.



17454
17455
17456
 
# File 'lib/models/porcelain.rb', line 17454

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



17456
17457
17458
 
# File 'lib/models/porcelain.rb', line 17456

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



17458
17459
17460
 
# File 'lib/models/porcelain.rb', line 17458

def name
  @name
end

#weight ⇒ Object

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



17460
17461
17462
 
# File 'lib/models/porcelain.rb', line 17460

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



17486
17487
17488
17489
17490
17491
17492
 
# File 'lib/models/porcelain.rb', line 17486

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