Remove Role

Removes a role or optional entitleable action from a user’s account.

Request Example

curl -X POST \ \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -H 'sessiontoken: SESSION_TOKEN' \
  -d '{"id" : "L2_SUPPORT"}'

If you remove a role from a user’s account, all optional entitleable actions that are associated with that role and assigned to the user are also removed. For example, removing COMPLIANCE_OFFICER also removes COMPLIANCE_OFFICER.MONITOR_ROOMS and COMPLIANCE_OFFICER.MONITOR_WALL_POSTS.

To remove only the optional entitleable action and retain the role, call this endpoint with the complete {roleID}.{optionalEA} value in payload. For example, removing COMPLIANCE_OFFICER.MONITOR_ROOMS disables the user’s ability to monitor rooms but retains his or her role as a compliance officer.

🚧 Required Permissions

Calling this endpoint requires the User Provisioning role with ACCESS_USER_PROVISIONING_API privilege. See Bot Permissions for a list of roles and associated privileges.

Last updated