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.



16793
16794
16795
16796
16797
16798
16799
16800
16801
16802
16803
16804
16805
16806
16807
16808
16809
16810
16811
16812
16813
16814
16815
 
# File 'lib/models/porcelain.rb', line 16793

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.



16768
16769
16770
 
# File 'lib/models/porcelain.rb', line 16768

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.



16771
16772
16773
 
# File 'lib/models/porcelain.rb', line 16771

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.



16773
16774
16775
 
# File 'lib/models/porcelain.rb', line 16773

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



16775
16776
16777
 
# File 'lib/models/porcelain.rb', line 16775

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



16777
16778
16779
 
# File 'lib/models/porcelain.rb', line 16777

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



16779
16780
16781
 
# File 'lib/models/porcelain.rb', line 16779

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.



16785
16786
16787
 
# File 'lib/models/porcelain.rb', line 16785

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



16787
16788
16789
 
# File 'lib/models/porcelain.rb', line 16787

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



16789
16790
16791
 
# File 'lib/models/porcelain.rb', line 16789

def name
  @name
end

#weight ⇒ Object

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



16791
16792
16793
 
# File 'lib/models/porcelain.rb', line 16791

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



16817
16818
16819
16820
16821
16822
16823
 
# File 'lib/models/porcelain.rb', line 16817

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