Skip to main content
Version: Current

Introduction

It describes the available APIs and data models for adding and removing users from groups.

API

Below is a list of APIs available in the group category.

APIDescription
GetUsersAsyncGets the list of users associated with the specified group using the group ID.
GetUsersByNameAsyncGets the list of users associated with the specified group using the group name.
AddUsersIntoGroupAsyncAdds one or more users to the specified group.
RemoveUserFromGroupAsyncRemoves one or more users from the specified group.

Models

Below is a list of data models used by the group APIs.

ModelDescription
AddUserResponseContains information about users who were successfully added to the group.
RemoveUserResponseContains information about users who were successfully removed from the group.
UserAddedResponseContains details about a user who was successfully added to the group.
UserRemovedResponseContains details about a user who was successfully removed from the group.
UserAddRemoveFailedResponseProvides information about users who could not be added to or removed from the group.
UserRepresents a user entity associated with a group.