deleteEnterpriseConnection() - Enterprise connections | Clerk Docs
deleteEnterpriseConnection()
Deletes the given enterprise connection.
Returns the deleted EnterpriseConnection object.
function deleteEnterpriseConnection(enterpriseConnectionId: string): Promise<EnterpriseConnection>
Parameters
- Name:
enterpriseConnectionId
Type:string
Description: The ID of the enterprise connection to delete.
Usage
Note
Using clerkClient varies based on the SDK you're using. Refer to the overview for usage details, including guidance on how to access the userId and other properties.
const response = await clerkClient.enterpriseConnections.deleteEnterpriseConnection('ec_123')
Backend API (BAPI) endpoint
This method in the SDK is a wrapper around the BAPI endpoint DELETE/enterprise_connections/{enterprise_connection_id}. See the BAPI reference for more information.