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.



10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
 
# File 'lib/models/porcelain.rb', line 10442

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.



10424
10425
10426
 
# File 'lib/models/porcelain.rb', line 10424

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



10426
10427
10428
 
# File 'lib/models/porcelain.rb', line 10426

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



10428
10429
10430
 
# File 'lib/models/porcelain.rb', line 10428

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



10430
10431
10432
 
# File 'lib/models/porcelain.rb', line 10430

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



10432
10433
10434
 
# File 'lib/models/porcelain.rb', line 10432

def name
  @name
end

#permissions ⇒ Object

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



10434
10435
10436
 
# File 'lib/models/porcelain.rb', line 10434

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



10436
10437
10438
 
# File 'lib/models/porcelain.rb', line 10436

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



10438
10439
10440
 
# File 'lib/models/porcelain.rb', line 10438

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



10440
10441
10442
 
# File 'lib/models/porcelain.rb', line 10440

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



10464
10465
10466
10467
10468
10469
10470
 
# File 'lib/models/porcelain.rb', line 10464

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