delete method

Future<DynamiteResponse<ConfigapiDeleteResponseApplicationJson, void>> delete({ required String configID, bool? oCSAPIRequest, })

Delete a LDAP configuration.

This endpoint requires admin access.

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:

• configID ID of the config.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Config deleted successfully
• 404: Config not found

See:

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

Implementation

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

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