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.



10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
 
# File 'lib/models/porcelain.rb', line 10515

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.



10497
10498
10499
 
# File 'lib/models/porcelain.rb', line 10497

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



10499
10500
10501
 
# File 'lib/models/porcelain.rb', line 10499

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



10501
10502
10503
 
# File 'lib/models/porcelain.rb', line 10501

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



10503
10504
10505
 
# File 'lib/models/porcelain.rb', line 10503

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



10505
10506
10507
 
# File 'lib/models/porcelain.rb', line 10505

def name
  @name
end

#permissions ⇒ Object

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



10507
10508
10509
 
# File 'lib/models/porcelain.rb', line 10507

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



10509
10510
10511
 
# File 'lib/models/porcelain.rb', line 10509

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



10511
10512
10513
 
# File 'lib/models/porcelain.rb', line 10511

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



10513
10514
10515
 
# File 'lib/models/porcelain.rb', line 10513

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



10537
10538
10539
10540
10541
10542
10543
 
# File 'lib/models/porcelain.rb', line 10537

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