Class: SDM::Token

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

Overview

A Token is an account providing tokenized access for automation or integration use. Tokens include admin tokens, API keys, and SCIM tokens.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(account_type: nil, deadline: nil, duration: nil, id: nil, name: nil, permissions: nil, rekeyed: nil, suspended: nil, tags: nil) ⇒ Token

Returns a new instance of Token.



14460
14461
14462
14463
14464
14465
14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
14476
14477
14478
14479
14480
 
# File 'lib/models/porcelain.rb', line 14460

def initialize(
  account_type: nil,
  deadline: nil,
  duration: nil,
  id: nil,
  name: nil,
  permissions: nil,
  rekeyed: nil,
  suspended: nil,
  tags: nil
)
  @account_type =  == nil ? "" : 
  @deadline = deadline == nil ? nil : deadline
  @duration = duration == nil ? nil : duration
  @id = id == nil ? "" : id
  @name = name == nil ? "" : name
  @permissions = permissions == nil ? [] : permissions
  @rekeyed = rekeyed == nil ? nil : rekeyed
  @suspended = suspended == nil ? false : suspended
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
end

Instance Attribute Details

#account_type ⇒ Object

Corresponds to the type of token, e.g. api or admin-token.



14442
14443
14444
 
# File 'lib/models/porcelain.rb', line 14442

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



14444
14445
14446
 
# File 'lib/models/porcelain.rb', line 14444

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



14446
14447
14448
 
# File 'lib/models/porcelain.rb', line 14446

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



14448
14449
14450
 
# File 'lib/models/porcelain.rb', line 14448

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



14450
14451
14452
 
# File 'lib/models/porcelain.rb', line 14450

def name
  @name
end

#permissions ⇒ Object

Permissions assigned to the token, e.g. role:create.



14452
14453
14454
 
# File 'lib/models/porcelain.rb', line 14452

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



14454
14455
14456
 
# File 'lib/models/porcelain.rb', line 14454

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



14456
14457
14458
 
# File 'lib/models/porcelain.rb', line 14456

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



14458
14459
14460
 
# File 'lib/models/porcelain.rb', line 14458

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



14482
14483
14484
14485
14486
14487
14488
 
# File 'lib/models/porcelain.rb', line 14482

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