getGroupUsers method

Future<DynamiteResponse<GroupsGetGroupUsersResponseApplicationJson, void>> getGroupUsers({
  1. required String groupId,
  2. bool? oCSAPIRequest,
})

Get a list of users in the specified group.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • groupId ID of the group.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: User IDs returned
  • 404: Group not found
  • 403: Missing permissions to get users in the group

See:

Implementation

Future<DynamiteResponse<GroupsGetGroupUsersResponseApplicationJson, void>> getGroupUsers({
  required String groupId,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = getGroupUsersRaw(
    groupId: groupId,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}