Class: BrickFTP::Types::UserAPIKey

Inherits:
Struct
  • Object
show all
Includes:
IgnoreUndefinedAttributes
Defined in:
lib/brick_ftp/types/user_api_key.rb

Overview

The API key object

ATTRIBUTE TYPE DESCRIPTION
id integer Globally unique identifier of each user API key. Each user API key is given an ID automatically upon creation.
key string The API key itself. This property is read-only.
name string Name to identify the user API key. For your reference. Maximum of 100 characters.
permission_set string The permission set for the user API key. Can be desktop_app or full.
platform string The platform for the user API key. Can be win32, macos, linux, or none. Applies only to API keys with a permission_set of desktop_app.
expires_at datetime The date that this API key is valid through.
created_at datetime Creation date of the user API key. This property is read-only.

See Also:

Instance Attribute Summary collapse

Method Summary

Methods included from IgnoreUndefinedAttributes

#initialize

Instance Attribute Details

#created_at ⇒ Object

Returns the value of attribute created_at

Returns:

  • (Object) —

    the current value of created_at



21
22
23
 
# File 'lib/brick_ftp/types/user_api_key.rb', line 21

def created_at
  @created_at
end

#expires_at ⇒ Object

Returns the value of attribute expires_at

Returns:

  • (Object) —

    the current value of expires_at



21
22
23
 
# File 'lib/brick_ftp/types/user_api_key.rb', line 21

def expires_at
  @expires_at
end

#id ⇒ Object

Returns the value of attribute id

Returns:

  • (Object) —

    the current value of id



21
22
23
 
# File 'lib/brick_ftp/types/user_api_key.rb', line 21

def id
  @id
end

#key ⇒ Object

Returns the value of attribute key

Returns:

  • (Object) —

    the current value of key



21
22
23
 
# File 'lib/brick_ftp/types/user_api_key.rb', line 21

def key
  @key
end

#name ⇒ Object

Returns the value of attribute name

Returns:

  • (Object) —

    the current value of name



21
22
23
 
# File 'lib/brick_ftp/types/user_api_key.rb', line 21

def name
  @name
end

#permission_set ⇒ Object

Returns the value of attribute permission_set

Returns:

  • (Object) —

    the current value of permission_set



21
22
23
 
# File 'lib/brick_ftp/types/user_api_key.rb', line 21

def permission_set
  @permission_set
end

#platform ⇒ Object

Returns the value of attribute platform

Returns:

  • (Object) —

    the current value of platform



21
22
23
 
# File 'lib/brick_ftp/types/user_api_key.rb', line 21

def platform
  @platform
end