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.



17954
17955
17956
17957
17958
17959
17960
17961
17962
17963
17964
17965
17966
17967
17968
17969
17970
17971
17972
17973
17974
17975
17976
 
# File 'lib/models/porcelain.rb', line 17954

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.



17929
17930
17931
 
# File 'lib/models/porcelain.rb', line 17929

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.



17932
17933
17934
 
# File 'lib/models/porcelain.rb', line 17932

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.



17934
17935
17936
 
# File 'lib/models/porcelain.rb', line 17934

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



17936
17937
17938
 
# File 'lib/models/porcelain.rb', line 17936

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



17938
17939
17940
 
# File 'lib/models/porcelain.rb', line 17938

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



17940
17941
17942
 
# File 'lib/models/porcelain.rb', line 17940

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.



17946
17947
17948
 
# File 'lib/models/porcelain.rb', line 17946

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



17948
17949
17950
 
# File 'lib/models/porcelain.rb', line 17948

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



17950
17951
17952
 
# File 'lib/models/porcelain.rb', line 17950

def name
  @name
end

#weight ⇒ Object

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



17952
17953
17954
 
# File 'lib/models/porcelain.rb', line 17952

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



17978
17979
17980
17981
17982
17983
17984
 
# File 'lib/models/porcelain.rb', line 17978

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