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.



10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
# File 'lib/models/porcelain.rb', line 10580

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_typeObject

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



10562
10563
10564
# File 'lib/models/porcelain.rb', line 10562

def 
  @account_type
end

#deadlineObject

The timestamp when the Token will expire.



10564
10565
10566
# File 'lib/models/porcelain.rb', line 10564

def deadline
  @deadline
end

#durationObject

Duration from token creation to expiration.



10566
10567
10568
# File 'lib/models/porcelain.rb', line 10566

def duration
  @duration
end

#idObject

Unique identifier of the Token.



10568
10569
10570
# File 'lib/models/porcelain.rb', line 10568

def id
  @id
end

#nameObject

Unique human-readable name of the Token.



10570
10571
10572
# File 'lib/models/porcelain.rb', line 10570

def name
  @name
end

#permissionsObject

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



10572
10573
10574
# File 'lib/models/porcelain.rb', line 10572

def permissions
  @permissions
end

#rekeyedObject

The timestamp when the Token was last rekeyed.



10574
10575
10576
# File 'lib/models/porcelain.rb', line 10574

def rekeyed
  @rekeyed
end

#suspendedObject

Reserved for future use. Always false for tokens.



10576
10577
10578
# File 'lib/models/porcelain.rb', line 10576

def suspended
  @suspended
end

#tagsObject

Tags is a map of key, value pairs.



10578
10579
10580
# File 'lib/models/porcelain.rb', line 10578

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object



10602
10603
10604
10605
10606
10607
10608
# File 'lib/models/porcelain.rb', line 10602

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