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.



12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
 
# File 'lib/models/porcelain.rb', line 12957

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.



12939
12940
12941
 
# File 'lib/models/porcelain.rb', line 12939

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



12941
12942
12943
 
# File 'lib/models/porcelain.rb', line 12941

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



12943
12944
12945
 
# File 'lib/models/porcelain.rb', line 12943

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



12945
12946
12947
 
# File 'lib/models/porcelain.rb', line 12945

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



12947
12948
12949
 
# File 'lib/models/porcelain.rb', line 12947

def name
  @name
end

#permissions ⇒ Object

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



12949
12950
12951
 
# File 'lib/models/porcelain.rb', line 12949

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



12951
12952
12953
 
# File 'lib/models/porcelain.rb', line 12951

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



12953
12954
12955
 
# File 'lib/models/porcelain.rb', line 12953

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



12955
12956
12957
 
# File 'lib/models/porcelain.rb', line 12955

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



12979
12980
12981
12982
12983
12984
12985
 
# File 'lib/models/porcelain.rb', line 12979

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