apiUsers

Updates the specified API user.

Changed on

Updates the specified API user's name or role. Names must remain unique, and the target role must be active and non-guest.

<Check title="Required Permissions" icon="key">The user must be an admin or have workspace-manage-config:write permissions.</Check>

put/apiusers/{apiUserId}

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/apiusers/{apiUserId}
  • Auth: HTTP bearer

Path parameters

apiUserIdstring uuid required

The id of the API user to update.

Request body

namestring required

The name of the API user.

roleIdstring uuid nullable

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

Response

OK

namestring required

The name of the API user.

roleIdstring uuid nullable

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

clientIdstring nullable

The client id this API user belongs to.

idstring uuid

The id of the API user.

createdOnstring date-time

The date this user was created.

createdBystring uuid

The id of the user who created this user.

updatedOnstring date-time

The date when this user was last updated.

updatedBystring uuid

The id of the user who updated the entity.

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PutApiUserById removed and replaced with apiUsers_PutApiUserById