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.



12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
 
# File 'lib/models/porcelain.rb', line 12117

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.



12099
12100
12101
 
# File 'lib/models/porcelain.rb', line 12099

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



12101
12102
12103
 
# File 'lib/models/porcelain.rb', line 12101

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



12103
12104
12105
 
# File 'lib/models/porcelain.rb', line 12103

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



12105
12106
12107
 
# File 'lib/models/porcelain.rb', line 12105

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



12107
12108
12109
 
# File 'lib/models/porcelain.rb', line 12107

def name
  @name
end

#permissions ⇒ Object

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



12109
12110
12111
 
# File 'lib/models/porcelain.rb', line 12109

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



12111
12112
12113
 
# File 'lib/models/porcelain.rb', line 12111

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



12113
12114
12115
 
# File 'lib/models/porcelain.rb', line 12113

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



12115
12116
12117
 
# File 'lib/models/porcelain.rb', line 12115

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



12139
12140
12141
12142
12143
12144
12145
 
# File 'lib/models/porcelain.rb', line 12139

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