DELETE /connections/{connectionId} – Deletes a connection by its ID.

  • For Cognito, the connectionId is the userPoolId.

Headers:

  • Authorization: Bearer <access_token> (required)
  • Content-Type: application/json or application/x-www-form-urlencoded (required)

Body:

  • provider: The authentication provider to use (optional, defaults to "auth0-connection" if omitted). See ConnectionProvider for valid options.

Path Parameters:

  • connectionId: The connection ID of which connection to delete (required)

Query Parameters:

  • None

  • 204 No Content – Indicates successful deletion with no content returned.

Status Code Meaning When it Happens
400 Bad Request Missing or invalid fields in request body
401 Unauthorized Missing or invalid authentication token
404 Not Found Specified connection does not exist
500 Internal Server Error Unexpected error
{
"error": "Detailed error message here"
}

DELETE /connections/exampleConnectionId
{} // provider defaults to "auth0-connection" if omitted
DELETE /connections/exampleUserPoolId
{
"provider": "cognito-connection",
}
{}

  • Parameters

    • event: APIGatewayProxyEvent

      The API Gateway event containing the request.

    • context: Context
    • callback: Callback<APIGatewayProxyResult>

    Returns void | Promise<APIGatewayProxyResult>

    A Promise resolving to an API Gateway-compatible response.