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.

roleIdstringOptional

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.

roleIdstringOptional

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.

idstringOptional

The id of the API user.

createdOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The date this user was created.

createdBystringOptional

The id of the user who created this user.

updatedOndatetimeOptionalDefaults to 1970-01-01T00:00:00.000Z

The date when this user was last updated.

updatedBystringOptional

The id of the user who updated the entity.