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.



11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
 
# File 'lib/models/porcelain.rb', line 11065

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.



11047
11048
11049
 
# File 'lib/models/porcelain.rb', line 11047

def 
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.



11049
11050
11051
 
# File 'lib/models/porcelain.rb', line 11049

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.



11051
11052
11053
 
# File 'lib/models/porcelain.rb', line 11051

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.



11053
11054
11055
 
# File 'lib/models/porcelain.rb', line 11053

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.



11055
11056
11057
 
# File 'lib/models/porcelain.rb', line 11055

def name
  @name
end

#permissions ⇒ Object

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



11057
11058
11059
 
# File 'lib/models/porcelain.rb', line 11057

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.



11059
11060
11061
 
# File 'lib/models/porcelain.rb', line 11059

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.



11061
11062
11063
 
# File 'lib/models/porcelain.rb', line 11061

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.



11063
11064
11065
 
# File 'lib/models/porcelain.rb', line 11063

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



11087
11088
11089
11090
11091
11092
11093
 
# File 'lib/models/porcelain.rb', line 11087

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