Assign Roles

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

Description

The assignRoles operation assigns roles to a user account when working with a user and role store that support reads and writes. By assigning a role to a user, the user account automatically inherits all the permissions that have been assigned to the role.

Request parameters

ParameterDetails

username

The name of the user.

Example
Use dark colors for code blocksCopy
1
username=jwhite

roles

A comma-separated list of role names. Each of the listed role names must exist in the role store.

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 assignRoles operation:

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

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

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.