disableUser method

Future<DynamiteResponse<UsersDisableUserResponseApplicationJson, void>> disableUser({ required String userId, bool? oCSAPIRequest, })

Disable a user.

This endpoint requires password confirmation.

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:

• userId ID of the user.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: User disabled successfully

See:

• $disableUser_Request for the request send by this method.
• $disableUser_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<UsersDisableUserResponseApplicationJson, void>> disableUser({
  required String userId,
  bool? oCSAPIRequest,
}) async {
  final _request = $disableUser_Request(
    userId: userId,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

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