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.



14601
14602
14603
14604
14605
14606
14607
14608
14609
14610
14611
14612
14613
14614
14615
14616
14617
14618
14619
14620
14621
 
# File 'lib/models/porcelain.rb', line 14601

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.



14583
14584
14585
 
# File 'lib/models/porcelain.rb', line 14583

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



14585
14586
14587
 
# File 'lib/models/porcelain.rb', line 14585

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



14587
14588
14589
 
# File 'lib/models/porcelain.rb', line 14587

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



14589
14590
14591
 
# File 'lib/models/porcelain.rb', line 14589

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



14591
14592
14593
 
# File 'lib/models/porcelain.rb', line 14591

def name
  @name
end

#permissions ⇒ Object

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



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

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



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

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



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

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



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

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



14623
14624
14625
14626
14627
14628
14629
 
# File 'lib/models/porcelain.rb', line 14623

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