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.



11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
 
# File 'lib/models/porcelain.rb', line 11453

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.



11435
11436
11437
 
# File 'lib/models/porcelain.rb', line 11435

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



11437
11438
11439
 
# File 'lib/models/porcelain.rb', line 11437

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



11439
11440
11441
 
# File 'lib/models/porcelain.rb', line 11439

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



11441
11442
11443
 
# File 'lib/models/porcelain.rb', line 11441

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



11443
11444
11445
 
# File 'lib/models/porcelain.rb', line 11443

def name
  @name
end

#permissions ⇒ Object

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



11445
11446
11447
 
# File 'lib/models/porcelain.rb', line 11445

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



11447
11448
11449
 
# File 'lib/models/porcelain.rb', line 11447

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



11449
11450
11451
 
# File 'lib/models/porcelain.rb', line 11449

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



11451
11452
11453
 
# File 'lib/models/porcelain.rb', line 11451

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



11475
11476
11477
11478
11479
11480
11481
 
# File 'lib/models/porcelain.rb', line 11475

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