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.



18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
18040
18041
18042
18043
18044
18045
18046
18047
18048
 
# File 'lib/models/porcelain.rb', line 18026

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.



18001
18002
18003
 
# File 'lib/models/porcelain.rb', line 18001

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.



18004
18005
18006
 
# File 'lib/models/porcelain.rb', line 18004

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.



18006
18007
18008
 
# File 'lib/models/porcelain.rb', line 18006

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



18008
18009
18010
 
# File 'lib/models/porcelain.rb', line 18008

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



18010
18011
18012
 
# File 'lib/models/porcelain.rb', line 18010

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



18012
18013
18014
 
# File 'lib/models/porcelain.rb', line 18012

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.



18018
18019
18020
 
# File 'lib/models/porcelain.rb', line 18018

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



18020
18021
18022
 
# File 'lib/models/porcelain.rb', line 18020

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



18022
18023
18024
 
# File 'lib/models/porcelain.rb', line 18022

def name
  @name
end

#weight ⇒ Object

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



18024
18025
18026
 
# File 'lib/models/porcelain.rb', line 18024

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



18050
18051
18052
18053
18054
18055
18056
 
# File 'lib/models/porcelain.rb', line 18050

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