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.



17871
17872
17873
17874
17875
17876
17877
17878
17879
17880
17881
17882
17883
17884
17885
17886
17887
17888
17889
17890
17891
17892
17893
 
# File 'lib/models/porcelain.rb', line 17871

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.



17846
17847
17848
 
# File 'lib/models/porcelain.rb', line 17846

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.



17849
17850
17851
 
# File 'lib/models/porcelain.rb', line 17849

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.



17851
17852
17853
 
# File 'lib/models/porcelain.rb', line 17851

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



17853
17854
17855
 
# File 'lib/models/porcelain.rb', line 17853

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



17855
17856
17857
 
# File 'lib/models/porcelain.rb', line 17855

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



17857
17858
17859
 
# File 'lib/models/porcelain.rb', line 17857

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.



17863
17864
17865
 
# File 'lib/models/porcelain.rb', line 17863

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



17865
17866
17867
 
# File 'lib/models/porcelain.rb', line 17865

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



17867
17868
17869
 
# File 'lib/models/porcelain.rb', line 17867

def name
  @name
end

#weight ⇒ Object

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



17869
17870
17871
 
# File 'lib/models/porcelain.rb', line 17869

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



17895
17896
17897
17898
17899
17900
17901
 
# File 'lib/models/porcelain.rb', line 17895

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