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.



14612
14613
14614
14615
14616
14617
14618
14619
14620
14621
14622
14623
14624
14625
14626
14627
14628
14629
14630
14631
14632
 
# File 'lib/models/porcelain.rb', line 14612

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.



14594
14595
14596
 
# File 'lib/models/porcelain.rb', line 14594

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



14596
14597
14598
 
# File 'lib/models/porcelain.rb', line 14596

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



14598
14599
14600
 
# File 'lib/models/porcelain.rb', line 14598

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



14600
14601
14602
 
# File 'lib/models/porcelain.rb', line 14600

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



14602
14603
14604
 
# File 'lib/models/porcelain.rb', line 14602

def name
  @name
end

#permissions ⇒ Object

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



14604
14605
14606
 
# File 'lib/models/porcelain.rb', line 14604

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



14606
14607
14608
 
# File 'lib/models/porcelain.rb', line 14606

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



14608
14609
14610
 
# File 'lib/models/porcelain.rb', line 14608

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



14610
14611
14612
 
# File 'lib/models/porcelain.rb', line 14610

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



14634
14635
14636
14637
14638
14639
14640
 
# File 'lib/models/porcelain.rb', line 14634

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