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.



15668
15669
15670
15671
15672
15673
15674
15675
15676
15677
15678
15679
15680
15681
15682
15683
15684
15685
15686
15687
15688
15689
15690
 
# File 'lib/models/porcelain.rb', line 15668

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.



15643
15644
15645
 
# File 'lib/models/porcelain.rb', line 15643

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.



15646
15647
15648
 
# File 'lib/models/porcelain.rb', line 15646

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.



15648
15649
15650
 
# File 'lib/models/porcelain.rb', line 15648

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



15650
15651
15652
 
# File 'lib/models/porcelain.rb', line 15650

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



15652
15653
15654
 
# File 'lib/models/porcelain.rb', line 15652

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



15654
15655
15656
 
# File 'lib/models/porcelain.rb', line 15654

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.



15660
15661
15662
 
# File 'lib/models/porcelain.rb', line 15660

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



15662
15663
15664
 
# File 'lib/models/porcelain.rb', line 15662

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



15664
15665
15666
 
# File 'lib/models/porcelain.rb', line 15664

def name
  @name
end

#weight ⇒ Object

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



15666
15667
15668
 
# File 'lib/models/porcelain.rb', line 15666

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



15692
15693
15694
15695
15696
15697
15698
 
# File 'lib/models/porcelain.rb', line 15692

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