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.



12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
 
# File 'lib/models/porcelain.rb', line 12294

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.



12276
12277
12278
 
# File 'lib/models/porcelain.rb', line 12276

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



12278
12279
12280
 
# File 'lib/models/porcelain.rb', line 12278

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



12280
12281
12282
 
# File 'lib/models/porcelain.rb', line 12280

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



12282
12283
12284
 
# File 'lib/models/porcelain.rb', line 12282

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



12284
12285
12286
 
# File 'lib/models/porcelain.rb', line 12284

def name
  @name
end

#permissions ⇒ Object

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



12286
12287
12288
 
# File 'lib/models/porcelain.rb', line 12286

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



12288
12289
12290
 
# File 'lib/models/porcelain.rb', line 12288

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



12290
12291
12292
 
# File 'lib/models/porcelain.rb', line 12290

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



12292
12293
12294
 
# File 'lib/models/porcelain.rb', line 12292

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



12316
12317
12318
12319
12320
12321
12322
 
# File 'lib/models/porcelain.rb', line 12316

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