Class: SDM::Token

Inherits:

Object

• Object
• SDM::Token

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

• #account_type ⇒ Object

  Corresponds to the type of token, e.g.

• #deadline ⇒ Object

  The timestamp when the Token will expire.

• #duration ⇒ Object

  Duration from token creation to expiration.

• #id ⇒ Object

  Unique identifier of the Token.

• #name ⇒ Object

  Unique human-readable name of the Token.

• #permissions ⇒ Object

  Permissions assigned to the token, e.g.

• #rekeyed ⇒ Object

  The timestamp when the Token was last rekeyed.

• #suspended ⇒ Object

  Reserved for future use.

• #tags ⇒ Object

  Tags is a map of key, value pairs.

Instance Method Summary

• #initialize(account_type: nil, deadline: nil, duration: nil, id: nil, name: nil, permissions: nil, rekeyed: nil, suspended: nil, tags: nil) ⇒ Token constructor

  A new instance of Token.

• #to_json(options = {}) ⇒ Object

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.

# File 'lib/models/porcelain.rb', line 12735

def initialize(
  account_type: nil,
  deadline: nil,
  duration: nil,
  id: nil,
  name: nil,
  permissions: nil,
  rekeyed: nil,
  suspended: nil,
  tags: nil
)
  @account_type = account_type == nil ? "" : account_type
  @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.

# File 'lib/models/porcelain.rb', line 12717

def account_type
  @account_type
end

#deadline ⇒ Object

The timestamp when the Token will expire.

# File 'lib/models/porcelain.rb', line 12719

def deadline
  @deadline
end

#duration ⇒ Object

Duration from token creation to expiration.

# File 'lib/models/porcelain.rb', line 12721

def duration
  @duration
end

#id ⇒ Object

Unique identifier of the Token.

# File 'lib/models/porcelain.rb', line 12723

def id
  @id
end

#name ⇒ Object

Unique human-readable name of the Token.

# File 'lib/models/porcelain.rb', line 12725

def name
  @name
end

#permissions ⇒ Object

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

# File 'lib/models/porcelain.rb', line 12727

def permissions
  @permissions
end

#rekeyed ⇒ Object

The timestamp when the Token was last rekeyed.

# File 'lib/models/porcelain.rb', line 12729

def rekeyed
  @rekeyed
end

#suspended ⇒ Object

Reserved for future use. Always false for tokens.

# File 'lib/models/porcelain.rb', line 12731

def suspended
  @suspended
end

#tags ⇒ Object

Tags is a map of key, value pairs.

# File 'lib/models/porcelain.rb', line 12733

def tags
  @tags
end

Instance Method Details

#to_json(options = {}) ⇒ Object

# File 'lib/models/porcelain.rb', line 12757

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