v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Users

Update Current Org User

Updates the permissions roles assigned to a user in the caller's current organization.

Only the user's role assignments are modified. Profile information such as name and email address is not affected by this endpoint.

put/api/organization/users/{id}

Path parameters

idstring uuid required

Unique identifier of the user to update.

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Unique identifier of the user to update.

Headers

X-Polytomic-Versionstring

Request body

rolestring

Deprecated legacy role name. Use role_ids instead.

role_idsstring[]

Identifiers of the permissions roles to assign to the user. Must contain at least one entry when provided.

Example request

{
  "role": "admin",
  "role_ids": [
    "248df4b7-aa70-47b8-a036-33ac447e668d"
  ]
}

Response

OK

Example response

{
  "data": {
    "email": "mail@example.com",
    "role": "admin",
    "role_ids": [
      "248df4b7-aa70-47b8-a036-33ac447e668d"
    ]
  }
}