RecomlyRecomlyRecomlyDocs
Single Sign-On

Delete SSO provider

Permanently delete an SSO provider and all its domain mappings.

DELETE /app/sso/providers/{providerId}

Permanently deletes an SSO provider, removes all its domain mappings, and deregisters the Cognito identity provider. Requires the admin role and the SSO plan feature.

This action cannot be undone. Users who previously authenticated via this provider will no longer be able to sign in with SSO. Cognito cleanup is best-effort — if it fails, the provider record is still removed from the platform.


Path parameters

ParameterDescription
providerIdThe UUID of the SSO provider.

Request

See API Basics for required headers.

This endpoint takes no request body.


Sample request

curl -X DELETE https://api.recomly.com/app/sso/providers/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer rk_live_abc123:def456"

Sample response

Status: 200 OK

{
  "message": "SSO provider deleted successfully",
  "providerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "domainsDeleted": 2
}

Response fields

FieldTypeDescription
messagestringConfirmation message.
providerIdstringThe ID of the deleted provider.
domainsDeletednumberNumber of domain mappings that were removed.

Error responses

See API Basics for standard status codes and error response format.

StatusMeaning
403SSO feature not enabled on the plan.
404SSO provider not found or does not belong to the caller's organization.

On this page

We use cookies

We use essential cookies to keep the site working, and optional analytics cookies to understand how it's used. Read our Privacy Policy.