Creates a new API user.

POST

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.

Request

This endpoint expects an object.
namestringRequired>=1 character

The name of the API user.

roleIdstringOptionalformat: "uuid"

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

clientIdstringOptional

The client id this API user belongs to.

Response

OK

namestring>=1 character

The name of the API user.

roleIdstringOptionalformat: "uuid"

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

clientIdstringOptional

The client id this API user belongs to.

idstringOptionalformat: "uuid"

The id of the API user.

createdOndatetimeOptional

The date this user was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this user.

updatedOndatetimeOptional

The date when this user was last updated.

updatedBystringOptionalformat: "uuid"

The id of the user who updated the entity.

Built with