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.



15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
15610
15611
15612
15613
15614
 
# File 'lib/models/porcelain.rb', line 15592

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.



15567
15568
15569
 
# File 'lib/models/porcelain.rb', line 15567

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.



15570
15571
15572
 
# File 'lib/models/porcelain.rb', line 15570

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.



15572
15573
15574
 
# File 'lib/models/porcelain.rb', line 15572

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



15574
15575
15576
 
# File 'lib/models/porcelain.rb', line 15574

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



15576
15577
15578
 
# File 'lib/models/porcelain.rb', line 15576

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



15578
15579
15580
 
# File 'lib/models/porcelain.rb', line 15578

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.



15584
15585
15586
 
# File 'lib/models/porcelain.rb', line 15584

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



15586
15587
15588
 
# File 'lib/models/porcelain.rb', line 15586

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



15588
15589
15590
 
# File 'lib/models/porcelain.rb', line 15588

def name
  @name
end

#weight ⇒ Object

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



15590
15591
15592
 
# File 'lib/models/porcelain.rb', line 15590

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



15616
15617
15618
15619
15620
15621
15622
 
# File 'lib/models/porcelain.rb', line 15616

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