Group Manager (REST)

The Group Manager service exposes the API to create, read, update, and delete the groups. Sample use cases for Group Manager API include:

  • creating a new group;
  • adding users to a group;
  • removing users from a group.

You can also use the Group Manager service through the .NET API. For more information, see Group Manager API.

This page contains the following information:

Fundamentals for managing groups

The URLs for REST endpoints contain path parameters that you need to set before making a call:

  • Set the {versionNumber} placeholder to the version of the REST API that you want to use, using the format lowercase v and the version number, for example v1 or v2
  • Set other path parameters in the URLs to the Artifact ID of a given entity, for example setting {workspaceID} to the Artifact ID of a workspace.
  • Note: To indicate the admin-level context, set the {workspaceID} path parameter to -1.

Client code sample

Create a group

Read a group

Update a group

Delete a group

Query users of a group

Query groups assigned to a user

Add users to a group

Remove users from a group

Mass add users to groups

Mass remove users from groups

Query eligible clients

Query eligible users