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.



10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
 
# File 'lib/models/porcelain.rb', line 10922

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.



10904
10905
10906
 
# File 'lib/models/porcelain.rb', line 10904

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



10906
10907
10908
 
# File 'lib/models/porcelain.rb', line 10906

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



10908
10909
10910
 
# File 'lib/models/porcelain.rb', line 10908

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



10910
10911
10912
 
# File 'lib/models/porcelain.rb', line 10910

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



10912
10913
10914
 
# File 'lib/models/porcelain.rb', line 10912

def name
  @name
end

#permissions ⇒ Object

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



10914
10915
10916
 
# File 'lib/models/porcelain.rb', line 10914

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



10916
10917
10918
 
# File 'lib/models/porcelain.rb', line 10916

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



10918
10919
10920
 
# File 'lib/models/porcelain.rb', line 10918

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



10920
10921
10922
 
# File 'lib/models/porcelain.rb', line 10920

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



10944
10945
10946
10947
10948
10949
10950
 
# File 'lib/models/porcelain.rb', line 10944

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