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.



18897
18898
18899
18900
18901
18902
18903
18904
18905
18906
18907
18908
18909
18910
18911
18912
18913
18914
18915
18916
18917
18918
18919
 
# File 'lib/models/porcelain.rb', line 18897

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.



18872
18873
18874
 
# File 'lib/models/porcelain.rb', line 18872

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.



18875
18876
18877
 
# File 'lib/models/porcelain.rb', line 18875

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.



18877
18878
18879
 
# File 'lib/models/porcelain.rb', line 18877

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



18879
18880
18881
 
# File 'lib/models/porcelain.rb', line 18879

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



18881
18882
18883
 
# File 'lib/models/porcelain.rb', line 18881

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



18883
18884
18885
 
# File 'lib/models/porcelain.rb', line 18883

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.



18889
18890
18891
 
# File 'lib/models/porcelain.rb', line 18889

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



18891
18892
18893
 
# File 'lib/models/porcelain.rb', line 18891

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



18893
18894
18895
 
# File 'lib/models/porcelain.rb', line 18893

def name
  @name
end

#weight ⇒ Object

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



18895
18896
18897
 
# File 'lib/models/porcelain.rb', line 18895

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



18921
18922
18923
18924
18925
18926
18927
 
# File 'lib/models/porcelain.rb', line 18921

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