API v1 ReferenceClient Applications

Generates an API key for the specified client application.

Generates an API key for the specified client application. Requires an API user. <Check title="Required Permissions">The user must be an admin or have `workspace-manage-config:read` permissions.</Check>

Path parameters

clientIdstringRequired
The id of the client application.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

The model to generate an API key.
apiUserIdstringOptionalformat: "uuid"
The API user to generate the key for.

Response

OK
token_typestring or null
The type of the token, typically 'Bearer'.
expires_inlong or null
The expiration date of the access token, in seconds.
access_tokenstring or null
The access token.
refresh_tokenstring or null
The refresh token to get a new access token.