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.



18090
18091
18092
18093
18094
18095
18096
18097
18098
18099
18100
18101
18102
18103
18104
18105
18106
18107
18108
18109
18110
18111
18112
 
# File 'lib/models/porcelain.rb', line 18090

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.



18065
18066
18067
 
# File 'lib/models/porcelain.rb', line 18065

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.



18068
18069
18070
 
# File 'lib/models/porcelain.rb', line 18068

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.



18070
18071
18072
 
# File 'lib/models/porcelain.rb', line 18070

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



18072
18073
18074
 
# File 'lib/models/porcelain.rb', line 18072

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



18074
18075
18076
 
# File 'lib/models/porcelain.rb', line 18074

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



18076
18077
18078
 
# File 'lib/models/porcelain.rb', line 18076

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.



18082
18083
18084
 
# File 'lib/models/porcelain.rb', line 18082

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



18084
18085
18086
 
# File 'lib/models/porcelain.rb', line 18084

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



18086
18087
18088
 
# File 'lib/models/porcelain.rb', line 18086

def name
  @name
end

#weight ⇒ Object

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



18088
18089
18090
 
# File 'lib/models/porcelain.rb', line 18088

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



18114
18115
18116
18117
18118
18119
18120
 
# File 'lib/models/porcelain.rb', line 18114

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