REST API Reference

Back Next

Updating user group assignments

You can add or remove user group assignments for a user.

You cannot update a user's user group assignments 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 user groups

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

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

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

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

For example, to assign the Workflow Manager and MDM Admin user groups to a user, you might use the following request:

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

You can use the userGroups resource to get a list of user groups that you can assign. For more information, see User groups.

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

Remove user group assignments

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

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

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

Include an array of user group assignments to remove from the user.

For example, to remove the MDM Admin user group assignment, you might use the following request:

PUT <baseApiUrl>/public/core/v3/users/name/LarryR/removeGroups
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
    "groups" : ["MDM Admin"]
}

Page Not Found

Table of Contents

REST API Reference

REST API Reference

Updating user group assignments

Updating user group assignments

Assign user groups

Remove user group assignments

Rename Saved Search

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Updating user group assignments

Updating user group assignments

Assign user groups

Remove user group assignments