apiUsers

Creates an API user.

Changed on

Creates an archived API user for the specified client application. The client application must exist, the name must be unique, and the selected role must be active and non-guest. If no role is supplied, the active admin role is used.

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

post/apiusers

Request

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

Request body

namestring required

The name of the API user.

roleIdstring uuid nullable

The role the user should be in. If no role is specified, the user will become an admin.

clientIdstring nullable

The client id this API user belongs to.

Response

OK

namestring required

The name of the API user.

roleIdstring uuid nullable

The role the user should be in. If no role is specified, the user will become an admin.

clientIdstring nullable

The client id this API user belongs to.

idstring uuid

The id of the API user.

createdOnstring date-time

The date this user was created.

createdBystring uuid

The id of the user who created this user.

updatedOnstring date-time

The date when this user was last updated.

updatedBystring uuid

The id of the user who updated the entity.

Changes