clientApplications

Generates an API key for the specified client application.

Changed on

<Check title="Required Permissions" icon="key">The user must be an admin or have workspace-manage-config:read permissions.</Check>

post/clientapplications/{clientId}/generateapikey

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/clientapplications/{clientId}/generateapikey
  • Auth: HTTP bearer

Path parameters

clientIdstring required

The id of the client application.

Request body

apiUserIdstring uuid

The API user to generate the key for.

Response

OK

token_typestring nullable

The type of the token, typically 'Bearer'.

expires_ininteger

The expiration date of the access token, in seconds.

access_tokenstring nullable

The access token.

refresh_tokenstring nullable

The refresh token to get a new access token.

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PostClientApplicationsGenerateApiKeyByClientId removed and replaced with clientApplications_PostClientApplicationsGenerateApiKeyByClientId