API v1 ReferenceAPI Users

Creates a new API user.

Creates a new API user. Beware: API users will also be returned in the /users response when including archived users.

Required Permissions
The user must be an admin or have workspace-manage-config:write permissions.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
namestringRequired>=1 character
The name of the API user.
roleIdUUID or nullOptional
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.
roleIdUUID or null
The role the user should be in. If no role is specified, the user will become an admin.
clientIdstring or null
The client id this API user belongs to.
idUUID or null
The id of the API user.
createdOndatetime or null
The date this user was created.
createdByUUID or null
The id of the user who created this user.
updatedOndatetime or null
The date when this user was last updated.
updatedByUUID or null
The id of the user who updated the entity.