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.



17094
17095
17096
17097
17098
17099
17100
17101
17102
17103
17104
17105
17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
 
# File 'lib/models/porcelain.rb', line 17094

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.



17069
17070
17071
 
# File 'lib/models/porcelain.rb', line 17069

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.



17072
17073
17074
 
# File 'lib/models/porcelain.rb', line 17072

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.



17074
17075
17076
 
# File 'lib/models/porcelain.rb', line 17074

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



17076
17077
17078
 
# File 'lib/models/porcelain.rb', line 17076

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



17078
17079
17080
 
# File 'lib/models/porcelain.rb', line 17078

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



17080
17081
17082
 
# File 'lib/models/porcelain.rb', line 17080

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.



17086
17087
17088
 
# File 'lib/models/porcelain.rb', line 17086

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



17088
17089
17090
 
# File 'lib/models/porcelain.rb', line 17088

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



17090
17091
17092
 
# File 'lib/models/porcelain.rb', line 17090

def name
  @name
end

#weight ⇒ Object

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



17092
17093
17094
 
# File 'lib/models/porcelain.rb', line 17092

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



17118
17119
17120
17121
17122
17123
17124
 
# File 'lib/models/porcelain.rb', line 17118

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