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.



12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385
12386
12387
12388
12389
12390
12391
12392
 
# File 'lib/models/porcelain.rb', line 12372

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.



12354
12355
12356
 
# File 'lib/models/porcelain.rb', line 12354

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



12356
12357
12358
 
# File 'lib/models/porcelain.rb', line 12356

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



12358
12359
12360
 
# File 'lib/models/porcelain.rb', line 12358

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



12360
12361
12362
 
# File 'lib/models/porcelain.rb', line 12360

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



12362
12363
12364
 
# File 'lib/models/porcelain.rb', line 12362

def name
  @name
end

#permissions ⇒ Object

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



12364
12365
12366
 
# File 'lib/models/porcelain.rb', line 12364

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



12366
12367
12368
 
# File 'lib/models/porcelain.rb', line 12366

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



12368
12369
12370
 
# File 'lib/models/porcelain.rb', line 12368

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



12370
12371
12372
 
# File 'lib/models/porcelain.rb', line 12370

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



12394
12395
12396
12397
12398
12399
12400
 
# File 'lib/models/porcelain.rb', line 12394

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