getUsers method

Future<DynamiteResponse<UsersGetUsersResponseApplicationJson, void>> getUsers({
  1. String? search,
  2. int? limit,
  3. int? offset,
  4. bool? oCSAPIRequest,
})

Get a list of users.

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:

  • search Text to search for. Defaults to "".
  • limit Limit the amount of groups returned.
  • offset Offset for searching for groups. Defaults to 0.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Users returned

See:

Implementation

Future<_i1.DynamiteResponse<UsersGetUsersResponseApplicationJson, void>> getUsers({
  String? search,
  int? limit,
  int? offset,
  bool? oCSAPIRequest,
}) async {
  final _request = $getUsers_Request(
    search: search,
    limit: limit,
    offset: offset,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $getUsers_Serializer();
  return _i1.ResponseConverter<UsersGetUsersResponseApplicationJson, void>(_serializer).convert(_response);
}