deleteUser method

Future<DynamiteResponse<UsersDeleteUserResponseApplicationJson, void>> deleteUser({
  1. required String userId,
  2. bool? oCSAPIRequest,
})

Delete 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 deleted successfully

See:

Implementation

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

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