getDisabledUsersDetails method

Future<DynamiteResponse<UsersGetDisabledUsersDetailsResponseApplicationJson, void>> getDisabledUsersDetails({
  1. int? limit,
  2. int? offset,
  3. bool? oCSAPIRequest,
})

Get the list of disabled users and their details.

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:

  • limit Limit the amount of users returned.
  • offset Offset. Defaults to 0.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Disabled users details returned

See:

Implementation

Future<_i1.DynamiteResponse<UsersGetDisabledUsersDetailsResponseApplicationJson, void>> getDisabledUsersDetails({
  int? limit,
  int? offset,
  bool? oCSAPIRequest,
}) async {
  final _request = $getDisabledUsersDetails_Request(
    limit: limit,
    offset: offset,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $getDisabledUsersDetails_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<UsersGetDisabledUsersDetailsResponseApplicationJson, void>(_serializer)
          .convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}