ClientCredential

ClientCredential object

idstring

ID is the unique UUID for the client_credential.

user_idstring

UserID is the ID of the user owning this client credential.

target object

ApiTargetHandle represents a reference to an API target (ID and optional metadata)

idstringrequired

API target unique identifier

namestring

Optional human readable API target name

deletedboolean

Whether the API target has been deleted

not_beforestring<date-time>

NotBefore specifies the start of the client credential validity period.

not_afterstring<date-time>

NotAfter specifies the end of the client credential validity period.

source_addressstring[]

Optional IP address and/or CIDRs from which requests using this client credential are allowed.

enabledboolean

Whether this client credential is enabled or not. Disabled credentials are rejected.

typestring

Client credential type

Possible values: [token, basicauth, certificate]

basic_auth_usernamestring

Username for client credentials of type "basicauth"

certificatestring

Certificate for client credentials of type "certificate"

namestring

Human readable name for the client credential

commentstring

Optional human readable comment

last_usedstring<date-time>

Approximate timestamp of when the client credential was last used

createdstring<date-time>

authorstring

updatedstring<date-time>

updated_bystring

ClientCredential

{
  "id": "string",
  "user_id": "string",
  "target": {
    "id": "string",
    "name": "string",
    "deleted": true
  },
  "not_before": "2024-07-29T15:51:28.071Z",
  "not_after": "2024-07-29T15:51:28.071Z",
  "source_address": [
    "string"
  ],
  "enabled": true,
  "type": "token",
  "basic_auth_username": "string",
  "certificate": "string",
  "name": "string",
  "comment": "string",
  "last_used": "2024-07-29T15:51:28.071Z",
  "created": "2024-07-29T15:51:28.071Z",
  "author": "string",
  "updated": "2024-07-29T15:51:28.071Z",
  "updated_by": "string"
}