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.



14688
14689
14690
14691
14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
14708
 
# File 'lib/models/porcelain.rb', line 14688

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.



14670
14671
14672
 
# File 'lib/models/porcelain.rb', line 14670

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



14672
14673
14674
 
# File 'lib/models/porcelain.rb', line 14672

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



14674
14675
14676
 
# File 'lib/models/porcelain.rb', line 14674

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



14676
14677
14678
 
# File 'lib/models/porcelain.rb', line 14676

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



14678
14679
14680
 
# File 'lib/models/porcelain.rb', line 14678

def name
  @name
end

#permissions ⇒ Object

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



14680
14681
14682
 
# File 'lib/models/porcelain.rb', line 14680

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



14682
14683
14684
 
# File 'lib/models/porcelain.rb', line 14682

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



14684
14685
14686
 
# File 'lib/models/porcelain.rb', line 14684

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



14686
14687
14688
 
# File 'lib/models/porcelain.rb', line 14686

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



14710
14711
14712
14713
14714
14715
14716
 
# File 'lib/models/porcelain.rb', line 14710

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