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.



14392
14393
14394
14395
14396
14397
14398
14399
14400
14401
14402
14403
14404
14405
14406
14407
14408
14409
14410
14411
14412
 
# File 'lib/models/porcelain.rb', line 14392

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.



14374
14375
14376
 
# File 'lib/models/porcelain.rb', line 14374

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



14376
14377
14378
 
# File 'lib/models/porcelain.rb', line 14376

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



14378
14379
14380
 
# File 'lib/models/porcelain.rb', line 14378

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



14380
14381
14382
 
# File 'lib/models/porcelain.rb', line 14380

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



14382
14383
14384
 
# File 'lib/models/porcelain.rb', line 14382

def name
  @name
end

#permissions ⇒ Object

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



14384
14385
14386
 
# File 'lib/models/porcelain.rb', line 14384

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



14386
14387
14388
 
# File 'lib/models/porcelain.rb', line 14386

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



14388
14389
14390
 
# File 'lib/models/porcelain.rb', line 14388

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



14390
14391
14392
 
# File 'lib/models/porcelain.rb', line 14390

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



14414
14415
14416
14417
14418
14419
14420
 
# File 'lib/models/porcelain.rb', line 14414

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