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.



10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
 
# File 'lib/models/porcelain.rb', line 10985

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.



10967
10968
10969
 
# File 'lib/models/porcelain.rb', line 10967

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



10969
10970
10971
 
# File 'lib/models/porcelain.rb', line 10969

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



10971
10972
10973
 
# File 'lib/models/porcelain.rb', line 10971

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



10973
10974
10975
 
# File 'lib/models/porcelain.rb', line 10973

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



10975
10976
10977
 
# File 'lib/models/porcelain.rb', line 10975

def name
  @name
end

#permissions ⇒ Object

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



10977
10978
10979
 
# File 'lib/models/porcelain.rb', line 10977

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



10979
10980
10981
 
# File 'lib/models/porcelain.rb', line 10979

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



10981
10982
10983
 
# File 'lib/models/porcelain.rb', line 10981

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



10983
10984
10985
 
# File 'lib/models/porcelain.rb', line 10983

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



11007
11008
11009
11010
11011
11012
11013
 
# File 'lib/models/porcelain.rb', line 11007

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