User and Group Collection
Manage collections of users and groups.
Create a user and group collection
Creates a user and group collection from the object you send and returns it. Collection names are not required to be unique.
Add users and groups to a collection
Adds the listed users and groups to a collection and returns the number added. Entries that are already members are skipped and not counted.
Copy a user and group collection
Creates a new collection under a new name with the same users and groups as an existing collection, and returns the new collection. The description and reviewer flag come from your request, not from the original. The new name must differ from the original and must not already be in use; the name check ignores case.
List user and group collection names
Returns the ID and name of each user and group collection. Use filterText to narrow the list to names that contain the text, ignoring case.
Remove users and groups from a collection
Removes members from a collection. List the members to remove, or set all to true to remove every member, optionally narrowed by filterText and entityType.
Search the members of a collection
Returns a page of the users and groups that belong to one user and group collection. Use it to list or filter the collection's members.
Delete a user and group collection
Deletes the collection and removes any console access that was granted through it.
Get a user and group collection
Returns one user and group collection: its ID, name, description, reviewer flag and timestamps. The member and access policy lists in the response are returned empty; use the Search route to list the members.
Update a user and group collection
Updates the name and details of a collection. The ID in the route must match the ID in the body. The collection is replaced with the object you send, so a description or reviewer flag you leave out is cleared.