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.



11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
 
# File 'lib/models/porcelain.rb', line 11970

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.



11952
11953
11954
 
# File 'lib/models/porcelain.rb', line 11952

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



11954
11955
11956
 
# File 'lib/models/porcelain.rb', line 11954

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



11956
11957
11958
 
# File 'lib/models/porcelain.rb', line 11956

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



11958
11959
11960
 
# File 'lib/models/porcelain.rb', line 11958

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



11960
11961
11962
 
# File 'lib/models/porcelain.rb', line 11960

def name
  @name
end

#permissions ⇒ Object

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



11962
11963
11964
 
# File 'lib/models/porcelain.rb', line 11962

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



11964
11965
11966
 
# File 'lib/models/porcelain.rb', line 11964

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



11966
11967
11968
 
# File 'lib/models/porcelain.rb', line 11966

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



11968
11969
11970
 
# File 'lib/models/porcelain.rb', line 11968

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



11992
11993
11994
11995
11996
11997
11998
 
# File 'lib/models/porcelain.rb', line 11992

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