API v1 ReferenceAPI Users

Creates an API user.

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>

Authentication

AuthorizationBearer

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

Request

The model to create the API user.
namestringRequired>=1 character
The name of the API user.
roleIdstring or nullOptionalformat: "uuid"
The role the user should be in. If no role is specified, the user will become an admin.
clientIdstring or nullOptional
The client id this API user belongs to.

Response

OK
namestring>=1 character
The name of the API user.
roleIdstring or nullOptionalformat: "uuid"
The role the user should be in. If no role is specified, the user will become an admin.
clientIdstring or nullOptional
The client id this API user belongs to.
idstringOptionalformat: "uuid"
The id of the API user.
createdOnstringOptionalformat: "date-time"
The date this user was created.
createdBystringOptionalformat: "uuid"
The id of the user who created this user.
updatedOnstringOptionalformat: "date-time"
The date when this user was last updated.
updatedBystringOptionalformat: "uuid"
The id of the user who updated the entity.

Errors

400
Bad Request Error
404
Not Found Error