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.



11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
 
# File 'lib/models/porcelain.rb', line 11977

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.



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

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



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

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



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

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



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

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



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

def name
  @name
end

#permissions ⇒ Object

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



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

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



11971
11972
11973
 
# File 'lib/models/porcelain.rb', line 11971

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



11973
11974
11975
 
# File 'lib/models/porcelain.rb', line 11973

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



11975
11976
11977
 
# File 'lib/models/porcelain.rb', line 11975

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



11999
12000
12001
12002
12003
12004
12005
 
# File 'lib/models/porcelain.rb', line 11999

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