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.



19255
19256
19257
19258
19259
19260
19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
19277
 
# File 'lib/models/porcelain.rb', line 19255

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.



19230
19231
19232
 
# File 'lib/models/porcelain.rb', line 19230

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.



19233
19234
19235
 
# File 'lib/models/porcelain.rb', line 19233

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.



19235
19236
19237
 
# File 'lib/models/porcelain.rb', line 19235

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



19237
19238
19239
 
# File 'lib/models/porcelain.rb', line 19237

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



19239
19240
19241
 
# File 'lib/models/porcelain.rb', line 19239

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



19241
19242
19243
 
# File 'lib/models/porcelain.rb', line 19241

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.



19247
19248
19249
 
# File 'lib/models/porcelain.rb', line 19247

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



19249
19250
19251
 
# File 'lib/models/porcelain.rb', line 19249

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



19251
19252
19253
 
# File 'lib/models/porcelain.rb', line 19251

def name
  @name
end

#weight ⇒ Object

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



19253
19254
19255
 
# File 'lib/models/porcelain.rb', line 19253

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



19279
19280
19281
19282
19283
19284
19285
 
# File 'lib/models/porcelain.rb', line 19279

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