DELETE/v2/sso-connections/{uuid}

Delete an SSO connection

Permanently deletes an OpenID Connect connection and stops its monthly charge. SAML and Other providers connections are deleted in the dashboard.

⚠️Warning

A connection that a status page still uses cannot be deleted. Remove SSO from those pages first: update each page with authentication.sso_connection_uuid set to null.

Request

Path Parameters

uuidstringrequired

The connection UUID

Example:"sso_kQwPzRtLmYbN4v"

Response

Returns confirmation of deletion.

Errors

Error responses

400in use

One or more status pages use the connection. The message gives their number

400managed in the dashboard

The connection is not an OpenID Connect connection

403read-only key

The API key has read-only permissions

404SSO connection not found

No connection with this UUID in the API key's project

RequestcURL

curl -X DELETE https://api.hyperping.io/v2/sso-connections/sso_kQwPzRtLmYbN4v \
  -H "Authorization: Bearer ${API_TOKEN}"

200 OKJSON

{
  "message": "SSO connection deleted"
}

400 Bad RequestJSON

{
  "error": "Cannot delete: 2 status page(s) are using this SSO connection. Remove SSO from those status pages first."
}

← Update an SSO connection SSO Connections API →