Remove Role

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

Remove a role from a user

POSTyourpodURL.symphony.com/pod/v1/admin/user/{uid}/roles/remove

Path parameters

uid*integer (int64)

User ID as a decimal integer

Header parameters

Body

application/json

idstring

Example: "xhGxbTcvTDK6EIMMrwdOrX___quztr2HdA"

Response

200400401403404500

Success

Body

application/json

formatenum

Example: "TEXT"

TEXTXML

messagestring

Example: "Success"

Request

JavaScriptCurlPython

const response = await fetch('yourpodURL.symphony.com/pod/v1/admin/user/{uid}/roles/remove', {
    method: 'POST',
    headers: {
      "sessionToken": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404500

{
  "format": "TEXT",
  "message": "Success"
}

Request Example

curl -X POST \
  https://acme.symphony.com/pod/v1/admin/user/346147139412345/roles/remove \
  -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.