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.



13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
 
# File 'lib/models/porcelain.rb', line 13511

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.



13486
13487
13488
 
# File 'lib/models/porcelain.rb', line 13486

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.



13489
13490
13491
 
# File 'lib/models/porcelain.rb', line 13489

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.



13491
13492
13493
 
# File 'lib/models/porcelain.rb', line 13491

def access_rules
  @access_rules
end

#approval_flow_id ⇒ Object

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



13493
13494
13495
 
# File 'lib/models/porcelain.rb', line 13493

def approval_flow_id
  @approval_flow_id
end

#auto_grant ⇒ Object

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



13495
13496
13497
 
# File 'lib/models/porcelain.rb', line 13495

def auto_grant
  @auto_grant
end

#description ⇒ Object

Optional description of the Workflow.



13497
13498
13499
 
# File 'lib/models/porcelain.rb', line 13497

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.



13503
13504
13505
 
# File 'lib/models/porcelain.rb', line 13503

def enabled
  @enabled
end

#id ⇒ Object

Unique identifier of the Workflow.



13505
13506
13507
 
# File 'lib/models/porcelain.rb', line 13505

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Workflow.



13507
13508
13509
 
# File 'lib/models/porcelain.rb', line 13507

def name
  @name
end

#weight ⇒ Object

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



13509
13510
13511
 
# File 'lib/models/porcelain.rb', line 13509

def weight
  @weight
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



13535
13536
13537
13538
13539
13540
13541
 
# File 'lib/models/porcelain.rb', line 13535

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