Updates the API user with the specified id.

PUT

Updates the API user with the specified id.

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

Path parameters

apiUserIdstringRequired

The id of the API user.

Request

This endpoint expects an object.
namestringRequired

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.

Response

Success

namestring

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.

createdOndatetimeOptional

The date this user was created.

createdBystringOptional

The id of the user who created this user.

updatedOndatetimeOptional

The date when this user was last updated.

updatedBystringOptional

The id of the user who updated the entity.