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.



14784
14785
14786
14787
14788
14789
14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
14803
14804
 
# File 'lib/models/porcelain.rb', line 14784

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.



14766
14767
14768
 
# File 'lib/models/porcelain.rb', line 14766

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



14768
14769
14770
 
# File 'lib/models/porcelain.rb', line 14768

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



14770
14771
14772
 
# File 'lib/models/porcelain.rb', line 14770

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



14772
14773
14774
 
# File 'lib/models/porcelain.rb', line 14772

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



14774
14775
14776
 
# File 'lib/models/porcelain.rb', line 14774

def name
  @name
end

#permissions ⇒ Object

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



14776
14777
14778
 
# File 'lib/models/porcelain.rb', line 14776

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



14778
14779
14780
 
# File 'lib/models/porcelain.rb', line 14778

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



14780
14781
14782
 
# File 'lib/models/porcelain.rb', line 14780

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



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

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



14806
14807
14808
14809
14810
14811
14812
 
# File 'lib/models/porcelain.rb', line 14806

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