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.



14533
14534
14535
14536
14537
14538
14539
14540
14541
14542
14543
14544
14545
14546
14547
14548
14549
14550
14551
14552
14553
 
# File 'lib/models/porcelain.rb', line 14533

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.



14515
14516
14517
 
# File 'lib/models/porcelain.rb', line 14515

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



14517
14518
14519
 
# File 'lib/models/porcelain.rb', line 14517

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



14519
14520
14521
 
# File 'lib/models/porcelain.rb', line 14519

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



14521
14522
14523
 
# File 'lib/models/porcelain.rb', line 14521

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



14523
14524
14525
 
# File 'lib/models/porcelain.rb', line 14523

def name
  @name
end

#permissions ⇒ Object

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



14525
14526
14527
 
# File 'lib/models/porcelain.rb', line 14525

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



14527
14528
14529
 
# File 'lib/models/porcelain.rb', line 14527

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



14529
14530
14531
 
# File 'lib/models/porcelain.rb', line 14529

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



14531
14532
14533
 
# File 'lib/models/porcelain.rb', line 14531

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



14555
14556
14557
14558
14559
14560
14561
 
# File 'lib/models/porcelain.rb', line 14555

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