API v1 Reference › Client Applications

Registers a new client application.

POSThttps://api.awork.com/api/v1/clientapplications
POST https://api.awork.com/api/v1/clientapplications

Authentication

AuthorizationBearer

Send your token in the Authorization: Bearer <token> header. See Authentication for API keys and OAuth.

Request body Required

The client application model.

application/json

clientIdstring or nullOptional

The client application's identifier.

displayNamestring or nullOptional

The client application's display name.

redirectUrisarray of string or nullOptional

The redirect URIs.

isConfidentialbooleanOptional

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.

Responses

200 OK

application/json

clientIdstring or nullOptional

The client application's identifier.

displayNamestring or nullOptional

The client application's display name.

redirectUrisarray of string or nullOptional

The redirect URIs.

isConfidentialbooleanOptional

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 or nullOptional

The client application's secret.

createdOnstringOptional
format: date-time

The date this entity was created.

updatedOnstringOptional
format: date-time

The date this entity was last modified.

400 Bad Request

application/json

codestringRequired
minLength: 1

The error code.

descriptionstringRequired
minLength: 1

The description of the error.

linkstringRequired
minLength: 1

The link to the API documentation page.

detailsarray of string or nullOptional

A list of details describing the error.

validationErrorsarray of object or nullOptional

If a validation error occurred, this contains the validation errors for each property.

Show 2 properties
propertystring or nullOptional

The name of the property that failed validation.

messagestring or nullOptional

The reason why this property failed validation.

traceIdstring or nullOptional

The request trace id for tracking the request.

Search documentation