Remove Roles

URL:
https://<root>/security/users/removeRoles
Methods:
POST
Required Capability:
Access allowed with either the "Update", "Delete", "Security and Infrastructure", or "Servers" privileges
Version Introduced:
10.1

Description

The removeRoles operation removes roles that have been previously assigned to a user account. This operation is supported only when the user and role store supports reads and writes.

Request parameters

ParameterDescription

username

The username of the user from which the roles are being removed.

Example
Use dark colors for code blocksCopy
1
username=jwhite

roles

A comma-separated list of role names assigned to the user.

Example
Use dark colors for code blocksCopy
1
roles=editors,planners

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the removeRoles operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /webadaptor/admin/security/users/removeRoles HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

username=jwhite&roles=editors,planners&f=json

JSON Response example

Use dark colors for code blocksCopy
1
{"status": "success"}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.