API v1 ReferenceAPI Users

Updates the API user with the specified id.

<Check title="Required Permissions">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.

Request

The new API user values.
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.
idstring or nullformat: "uuid"
The id of the API user.
createdOnstring or nullformat: "date-time"
The date this user was created.
createdBystring or nullformat: "uuid"
The id of the user who created this user.
updatedOnstring or nullformat: "date-time"
The date when this user was last updated.
updatedBystring or nullformat: "uuid"
The id of the user who updated the entity.