ApiKeysListResponse

response_codeinteger

HTTP status code of the response for reference purposes.

Default value: 200

Example: 200

successboolean

Indicates whether the request was successful (normally true if it's not an error response).

Default value: true

uristring

URL of the current request / resource, for reference purposes.

Example: https://example.apps.journyx.com/api/v1/users

statusstring[]

An array of status (confirmation) messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a green icon.

errorsstring[]

An array of error messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a red error icon.

warningsstring[]

An array of warning messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a yellow warning icon.

infostring[]

An array of informational messages that occurred during the request. This field may be empty.

In the UI, these are sometimes displayed with a blue info icon.

results object[]

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.

Array [

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.

]

ApiKeysListResponse

{
  "response_code": 200,
  "success": true,
  "uri": "https://example.apps.journyx.com/api/v1/users",
  "status": [
    "string"
  ],
  "errors": [
    "string"
  ],
  "warnings": [
    "string"
  ],
  "info": [
    "string"
  ],
  "results": [
    {
      "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"
      ]
    }
  ]
}