Users

Update an existing user by authId

Changed on

Required scope - write_user. Assigning a privileged role (e.g. super_admin) additionally requires the caller to hold the root scope.

put/api/v1/users/{authId}

Request

  • The document declares no server URL.
  • Auth
    OAuth 2
    Client credentials
    Token URL: /oauth2/v1/token

Path parameters

authIdstring required

The authId of the user

Request body

firstNamestring
lastNamestring
isActiveboolean
localestring
orgSlugstring
rolesstring[]
attributesobject

Example request

{
  "attributes": {
    "1": "value for attributeId 1",
    "2": "value for attributeId 2"
  }
}

Response

Example response

{
  "user": {
    "attributes": {
      "attribute name 1": "value for attribute name 1",
      "attribute name 2": "value for attribute name 2"
    }
  }
}

Changes

  • 74c633c2da2cRevision changes
    • info

      added the optional property ///// to the response with the status

  • e8542f1e3a76Revision changes
    • info

      added the required property ///// to the response with the status