API v1 ReferenceAPI Users

Updates the API user with the specified id.

<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.

Path parameters

apiUserIdstringRequiredformat: "uuid"
The id of the API user to update.

Request

The model to update 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.

Response

OK
namestring>=1 character
The name of the API user.
roleIdstring or nullformat: "uuid"
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.
idstringformat: "uuid"
The id of the API user.
createdOndatetime
The date this user was created.
createdBystringformat: "uuid"
The id of the user who created this user.
updatedOndatetime
The date when this user was last updated.
updatedBystringformat: "uuid"
The id of the user who updated the entity.

Errors

400
Bad Request Error
404
Not Found Error