REST API Reference

Back Next

Updating role assignments

You can add or remove role assignments for a user.

You cannot update a user's role assigments if your organization enabled the Map SAML Groups and Roles option for SAML single sign-on. For more information, see

User Administration

in the Administrator help.

Assign roles

To assign a role to a user, send a PUT request using one of the following URIs:

/public/core/v3/users/<user ID>/addRoles

/public/core/v3/users/name/<user name>/addRoles

Include an array of the roles that you want to assign to the user.

For example, to assign the Admin and Business Manager roles to a user, you might use the following request:

PUT <baseApiUrl>/public/core/v3/users/cPYWk02I4aBeuLEvYRtaMS/addRoles
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
    "roles" : ["Admin", "Business Manager"]
}

You can use the roles resource to get a list of roles that you can assign. For more information, see Roles.

The response includes a success code if successful or an error object if errors occur.

Remove roles

To remove a role assignment from a user, send a PUT request using one of the following URIs:

/public/core/v3/users/<user ID>/removeRoles

/public/core/v3/users/name/<user name>/removeRoles

Include an array of roles to unassign.

For example, to remove the Designer role assignment from a user, you might use the following request:

PUT <baseApiUrl>/public/core/v3/users/cPYWk02I4aBeuLEvYRtaMS/removeRoles
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
    "roles" : "Designer"
}

Page Not Found

Table of Contents

REST API Reference

REST API Reference

Updating role assignments

Updating role assignments

Assign roles

Remove roles

Rename Saved Search

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Updating role assignments

Updating role assignments

Assign roles

Remove roles