Sign in
Users

Unassign User from Role

Use this endpoint to remove a Role from a User.

delete/users/{userId}/site-roles

Request body

site_idstring required

Identifier of the site from which the role should be removed. Only the assignment at this site is revoked; the user's roles at other sites are unaffected.

role_idstring required

Identifier of the role to revoke. Must match a role currently assigned to the user at the given site_id; no-op if the user does not hold this role at this site.

Example request

{
  "site_id": "beddda88-947d-4bd8-8f0c-828b187f93b2",
  "role_id": "beddda88-947d-4bd8-8f0c-828b187f93b3"
}

Response

The role was successfully removed.

Changes

No recorded changes to this endpoint across all 1 revision of this API.