REST API Reference

Back Next

User groups

Use this resource to create, update, and delete user groups.

Use the userGroups resource along with the users and roles resources to manage user privileges. Users and groups can perform tasks and access assets based on the roles that you assign to them.

You can send the following requests:

To get details about all of the user groups or a particular user group, send a GET request.

To create a user group, use a POST request.

To add roles or users to a user group, use a PUT request.

To delete a user group, use a DELETE request.

This resource uses a dynamic rate limit. When the system experiences a large volume or size of requests, responses might be slow or fail with the error message, "too many requests."

For information about using the users and roles REST API resources, see the following topics:

Users

Roles

For general information about users, user groups, and roles, see the Administrator help.

The number of users, user groups, and roles combined cannot exceed 1000 for an organization.

Platform REST API version 3 resources

Getting user group details

Creating a user group

Updating a user group

Deleting a user group

Download Guide

Watch