Delete an enterprise connection | Clerk API (unofficial showcase)

1 parameter

enterprise_connection_idstringrequired

The ID of the enterprise connection to delete

4 status codes

200Deleted Object

objectstringrequired

idstringoptional

slugstringoptional

deletedbooleanrequired

external_idstringoptional

402Payment required

errorsarray<object>required

metaobjectoptional

clerk_trace_idstringoptional

403Authorization invalid

errorsarray<object>required

metaobjectoptional

clerk_trace_idstringoptional

404Resource not found

errorsarray<object>required

metaobjectoptional

clerk_trace_idstringoptional

Error handling

A 402 is returned: Payment required. A 403 is returned: Authorization invalid. A 404 is returned: Resource not found.

import { Client } from "@octridev/clerk";

const client = new Client({
  baseUrl: "https://api.clerk.com/v1",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.enterpriseConnections.delete({ enterpriseConnectionId: "c0a80123-4567-89ab-cdef-0123456789ab" });

{
  "object": "example_value",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "slug": "my-example-resource",
  "deleted": true,
  "external_id": "550e8400-e29b-41d4-a716-446655440000"
}

Request

Response

Errors