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.



13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
13394
13395
13396
 
# File 'lib/models/porcelain.rb', line 13374

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.



13349
13350
13351
 
# File 'lib/models/porcelain.rb', line 13349

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.



13352
13353
13354
 
# File 'lib/models/porcelain.rb', line 13352

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.



13354
13355
13356
 
# File 'lib/models/porcelain.rb', line 13354

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



13356
13357
13358
 
# File 'lib/models/porcelain.rb', line 13356

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



13358
13359
13360
 
# File 'lib/models/porcelain.rb', line 13358

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



13360
13361
13362
 
# File 'lib/models/porcelain.rb', line 13360

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.



13366
13367
13368
 
# File 'lib/models/porcelain.rb', line 13366

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



13368
13369
13370
 
# File 'lib/models/porcelain.rb', line 13368

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



13370
13371
13372
 
# File 'lib/models/porcelain.rb', line 13370

def name
  @name
end

#weight ⇒ Object

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



13372
13373
13374
 
# File 'lib/models/porcelain.rb', line 13372

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



13398
13399
13400
13401
13402
13403
13404
 
# File 'lib/models/porcelain.rb', line 13398

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