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.



18396
18397
18398
18399
18400
18401
18402
18403
18404
18405
18406
18407
18408
18409
18410
18411
18412
18413
18414
18415
18416
18417
18418
 
# File 'lib/models/porcelain.rb', line 18396

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.



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

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.



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

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.



18376
18377
18378
 
# File 'lib/models/porcelain.rb', line 18376

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



18378
18379
18380
 
# File 'lib/models/porcelain.rb', line 18378

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



18380
18381
18382
 
# File 'lib/models/porcelain.rb', line 18380

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



18382
18383
18384
 
# File 'lib/models/porcelain.rb', line 18382

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.



18388
18389
18390
 
# File 'lib/models/porcelain.rb', line 18388

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



18390
18391
18392
 
# File 'lib/models/porcelain.rb', line 18390

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



18392
18393
18394
 
# File 'lib/models/porcelain.rb', line 18392

def name
  @name
end

#weight ⇒ Object

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



18394
18395
18396
 
# File 'lib/models/porcelain.rb', line 18394

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



18420
18421
18422
18423
18424
18425
18426
 
# File 'lib/models/porcelain.rb', line 18420

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