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.



11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
 
# File 'lib/models/porcelain.rb', line 11626

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.



11608
11609
11610
 
# File 'lib/models/porcelain.rb', line 11608

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



11610
11611
11612
 
# File 'lib/models/porcelain.rb', line 11610

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



11612
11613
11614
 
# File 'lib/models/porcelain.rb', line 11612

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



11614
11615
11616
 
# File 'lib/models/porcelain.rb', line 11614

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



11616
11617
11618
 
# File 'lib/models/porcelain.rb', line 11616

def name
  @name
end

#permissions ⇒ Object

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



11618
11619
11620
 
# File 'lib/models/porcelain.rb', line 11618

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



11620
11621
11622
 
# File 'lib/models/porcelain.rb', line 11620

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



11622
11623
11624
 
# File 'lib/models/porcelain.rb', line 11622

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



11624
11625
11626
 
# File 'lib/models/porcelain.rb', line 11624

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



11648
11649
11650
11651
11652
11653
11654
 
# File 'lib/models/porcelain.rb', line 11648

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