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.



11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
 
# File 'lib/models/porcelain.rb', line 11300

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.



11282
11283
11284
 
# File 'lib/models/porcelain.rb', line 11282

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



11284
11285
11286
 
# File 'lib/models/porcelain.rb', line 11284

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



11286
11287
11288
 
# File 'lib/models/porcelain.rb', line 11286

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



11288
11289
11290
 
# File 'lib/models/porcelain.rb', line 11288

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



11290
11291
11292
 
# File 'lib/models/porcelain.rb', line 11290

def name
  @name
end

#permissions ⇒ Object

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



11292
11293
11294
 
# File 'lib/models/porcelain.rb', line 11292

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



11294
11295
11296
 
# File 'lib/models/porcelain.rb', line 11294

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



11296
11297
11298
 
# File 'lib/models/porcelain.rb', line 11296

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



11298
11299
11300
 
# File 'lib/models/porcelain.rb', line 11298

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



11322
11323
11324
11325
11326
11327
11328
 
# File 'lib/models/porcelain.rb', line 11322

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