Benutzerdefinierte Domain entfernen

DELETE /v1/custom-domains/{custom_domain_id} · Berechtigung custom-domains:write

Entfernt eine benutzerdefinierte Domain: Sie wird released, die Anmeldung über sie endet, und der Name bleibt 30 Tage gesperrt (keine andere Umgebung kann ihn hinzufügen). Die primäre Domain und die Domain, die als Issuer der Umgebung verwendet wird, können nicht entfernt werden; machen Sie zuerst eine andere Domain zur primären Domain. Das Entfernen einer bereits freigegebenen Domain wiederholt nur die Freigabe in der Plattform-Registrierung.

Anfrage

Feld Typ Pflichtfeld Beschreibung
custom_domain_id string ja Kennung der benutzerdefinierten Domain (cdom_…).
If-Match header ja Erforderlich. Der ETag der Domain; 428, wenn er fehlt, 412, wenn er nicht übereinstimmt.

Kein Anfragetext.

Antwort

204 No Content.

Fehler

HTTP Code Wann
404 not_found Die benutzerdefinierte Domain existiert nicht oder gehört zu einer anderen Umgebung.
409 custom_domain_in_use Die Domain ist die primäre Domain oder der Issuer der Umgebung.
409 domain_in_use_by_rp_id Die Domain ist die Passkey-rpId einer Verbindung oder die bisherige rpId einer laufenden rpId-Migration; verschieben Sie zuerst die rpId mit Passkey-rpId ändern.
412 precondition_failed If-Match stimmt nicht mit der aktuellen Version der Domain überein.
428 precondition_required If-Match fehlt.
503 service_unavailable Die Domain-Registrierung der Plattform oder die Issuer-Informationen der Umgebung sind vorübergehend nicht verfügbar.
401 unauthenticated Die Anmeldedaten fehlen, sind ungültig oder widerrufen.
403 insufficient_permissions Die Anmeldedaten haben nicht die erforderliche Berechtigung.
429 rate_limited Das Ratenlimit wurde überschritten; wiederholen Sie die Anfrage nach der Zeitspanne Retry-After.

Beispiel

curl -X DELETE https://api.eu.keenauth.com/v1/custom-domains/cdom_01j9xk3m7q8r2s4t6v8w0y2z4a \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H 'If-Match: "3"'