Groups API
Use context.Group to retrieve groups and manage group membership in the connected AI Command Center.
Choose a method
Use GetAllGroupsAsync to retrieve the complete group list, GetGroupByNameAsync when you know the group name, or QueryAsync for paging, filtering, and sorting.
QueryAsync and GetGroupByNameAsync require the updated AI Command Center group endpoint. These APIs were verified with AICC 8.3.120.4 and Tool build 8.3.120.1. Older servers without the new endpoint cannot serve these two requests; GetAllGroupsAsync remains supported. Reference an SDK assembly that includes the required methods.
Follow Get started to configure the SDK and connection. See SDK usage for connection lifetime and error handling.
API
Below is a list of APIs available in the group category.
| API | Description |
|---|---|
| QueryAsync | Gets groups with optional paging, filtering, and sorting. |
| GetAllGroupsAsync | Gets all groups for the current tenant. |
| GetGroupByNameAsync | Retrieves a group by name. |
| GetUsersAsync | Gets the list of users associated with the specified group using the group ID. |
| GetUsersByNameAsync | Gets the list of users associated with the specified group using the group name. |
| AddUsersIntoGroupAsync | Adds one or more users to the specified group. |
| RemoveUserFromGroupAsync | Removes one or more users from the specified group. |
Models
Below is a list of data models used by the group APIs.
| Model | Description |
|---|---|
| QueryOptions | Shared paging, filter, and sort options used by query APIs. |
| GetGroupResponse | Represents a group returned by the group query APIs. |
| AddUserResponse | Contains information about users who were successfully added to the group. |
| RemoveUserResponse | Contains information about users who were successfully removed from the group. |
| UserAddedResponse | Contains details about a user who was successfully added to the group. |
| UserRemovedResponse | Contains details about a user who was successfully removed from the group. |
| UserAddRemoveFailedResponse | Provides information about users who could not be added to or removed from the group. |
| User | Represents a user entity associated with a group. |