getGroupUsers method
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 totrue
.
Status codes:
- 200: User IDs returned
- 404: Group not found
- 403: Missing permissions to get users in the group
See:
- $getGroupUsers_Request for the request send by this method.
- $getGroupUsers_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<GroupsGetGroupUsersResponseApplicationJson, void>> getGroupUsers({
required String groupId,
bool? oCSAPIRequest,
}) async {
final _request = $getGroupUsers_Request(
groupId: groupId,
oCSAPIRequest: oCSAPIRequest,
);
final _streamedResponse = await _rootClient.httpClient.send(_request);
final _response = await _i3.Response.fromStream(_streamedResponse);
final _serializer = $getGroupUsers_Serializer();
return _i1.ResponseConverter<GroupsGetGroupUsersResponseApplicationJson, void>(_serializer).convert(_response);
}