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.



13830
13831
13832
13833
13834
13835
13836
13837
13838
13839
13840
13841
13842
13843
13844
13845
13846
13847
13848
13849
13850
13851
13852
 
# File 'lib/models/porcelain.rb', line 13830

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.



13805
13806
13807
 
# File 'lib/models/porcelain.rb', line 13805

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.



13808
13809
13810
 
# File 'lib/models/porcelain.rb', line 13808

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.



13810
13811
13812
 
# File 'lib/models/porcelain.rb', line 13810

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



13812
13813
13814
 
# File 'lib/models/porcelain.rb', line 13812

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



13814
13815
13816
 
# File 'lib/models/porcelain.rb', line 13814

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



13816
13817
13818
 
# File 'lib/models/porcelain.rb', line 13816

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.



13822
13823
13824
 
# File 'lib/models/porcelain.rb', line 13822

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



13824
13825
13826
 
# File 'lib/models/porcelain.rb', line 13824

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



13826
13827
13828
 
# File 'lib/models/porcelain.rb', line 13826

def name
  @name
end

#weight ⇒ Object

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



13828
13829
13830
 
# File 'lib/models/porcelain.rb', line 13828

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



13854
13855
13856
13857
13858
13859
13860
 
# File 'lib/models/porcelain.rb', line 13854

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