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.



14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
14811
14812
14813
14814
14815
14816
14817
14818
14819
14820
 
# File 'lib/models/porcelain.rb', line 14800

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.



14782
14783
14784
 
# File 'lib/models/porcelain.rb', line 14782

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



14784
14785
14786
 
# File 'lib/models/porcelain.rb', line 14784

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



14786
14787
14788
 
# File 'lib/models/porcelain.rb', line 14786

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



14788
14789
14790
 
# File 'lib/models/porcelain.rb', line 14788

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



14790
14791
14792
 
# File 'lib/models/porcelain.rb', line 14790

def name
  @name
end

#permissions ⇒ Object

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



14792
14793
14794
 
# File 'lib/models/porcelain.rb', line 14792

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



14794
14795
14796
 
# File 'lib/models/porcelain.rb', line 14794

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



14796
14797
14798
 
# File 'lib/models/porcelain.rb', line 14796

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



14798
14799
14800
 
# File 'lib/models/porcelain.rb', line 14798

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



14822
14823
14824
14825
14826
14827
14828
 
# File 'lib/models/porcelain.rb', line 14822

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