ApiKey

An API Key metadata (description) object.

Important: many of these fields will only be shown if the key in question belongs to the current user.

id_api_keystring

The internal ID of the API key.

id_userstring

The internal ID of the user associated with the API key.

id_user_fullnamestring

The full name of the user associated with the API key.

pnamestring

The display name (label) of the API key.

display_keystring

This is the actual API Key to be used as a password to authenticate with the system. This will only be returned to the user who owns the key.

versionstring

The format version of the API key; normally 2.

read_onlyboolean

If true, the API key is for read-only access.

expiredboolean

If true, the API key has already expired.

expires_daysinteger

The number of days until the API key expires.

expires_timestampnumber

The Unix timestamp when the API key expires.

creatorstring

The internal ID of the user who created the API key; not necessarily the owner (the user associated with the key).

creator_fullnamestring

The full name of the user who created the API key.

create_timestampnumber

The Unix timestamp when the API key was created.

modifierstring

The internal ID of the user who last modified the API key.

modifier_fullnamestring

The full name of the user who last modified the API key.

modify_timestampnumber

The Unix timestamp when the API key was last modified.

propertiesobject

Any custom properties associated with the API key.

scopestring[]

The list of abilities associated with the API key. If empty, the API key has full access.

ApiKey

{
  "id_api_key": "string",
  "id_user": "string",
  "id_user_fullname": "string",
  "pname": "string",
  "display_key": "string",
  "version": "string",
  "read_only": true,
  "expired": true,
  "expires_days": 0,
  "expires_timestamp": 0,
  "creator": "string",
  "creator_fullname": "string",
  "create_timestamp": 0,
  "modifier": "string",
  "modifier_fullname": "string",
  "modify_timestamp": 0,
  "properties": {},
  "scope": [
    "string"
  ]
}