clientApplications

Registers a new client application.

Changed on

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

post/clientapplications

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/clientapplications
  • Auth: HTTP bearer

Request body

clientIdstring nullable

The client application's identifier.

displayNamestring nullable

The client application's display name.

redirectUrisstring[] nullable

The redirect URIs.

isConfidentialboolean

Indicates whether the client application is confidential. Backend integrations are considered confidential as the secret is never shipped to a user, while web apps or CLI integrations are not.

Response

OK

clientIdstring nullable

The client application's identifier.

displayNamestring nullable

The client application's display name.

redirectUrisstring[] nullable

The redirect URIs.

isConfidentialboolean

Indicates whether the client application is confidential. Backend integrations are considered confidential as the secret is never shipped to a user, while web apps or CLI integrations are not.

clientSecretstring nullable

The client application's secret.

createdOnstring date-time

The date this entity was created.

updatedOnstring date-time

The date this entity was last modified.

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 PostClientApplications removed and replaced with clientApplications_PostClientApplications