Sign in

v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Users

Update Partner User

Updates a user's assigned permissions roles.

🚧 Requires partner key

User endpoints are only accessible using partner keys.

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

put/api/organizations/{org_id}/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.

org_idstring uuid required

Unique identifier of the organization the user belongs to.

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

Unique identifier of the organization the user belongs to.

Headers

X-Polytomic-Versionstring

Request body

emailstring required

Email address used to sign the user in and receive notifications.

rolestring

Deprecated legacy role name. Use role_ids instead; setting both role and role_ids in the same request is rejected.

role_idsstring[]

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

Example request

{
  "email": "mail@example.com",
  "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"
    ]
  }
}