Eine Domain für eine Organisation beanspruchen

POST /v1/organization-domains · Berechtigung organization-domains:write

Fügt einer Organisation eine Domain hinzu. domain kann in Unicode oder als A-Label angegeben werden und wird als kleingeschriebenes A-Label gespeichert. Mit dns_txt (Standard) beginnt die Domain im Status pending; veröffentlichen Sie den zurückgegebenen TXT-Eintrag, dann wird die Domain durch :verify oder die geplante Prüfung verifiziert; eine Domain, die nicht innerhalb von 72 Stunden verifiziert wird, wird expired. manual erfasst Ihre eigene Erklärung zur Inhaberschaft: Die Domain wird sofort verified, und die Erklärung wird in das Verwaltungs-Audit-Log geschrieben. Jede Organisation kann höchstens 100 Domains halten.

Anfrage

Feld Typ Pflicht Beschreibung
Idempotency-Key Header nein Optionaler Schlüssel (16–64 Zeichen), der eine wiederholte Anfrage sicher macht.
organization_id string ja Die Organisation, die die Domain beansprucht (org_…).
domain string ja Domainname, höchstens 253 Zeichen. Öffentliche Suffixe und kostenlose E-Mail-Anbieter können nicht beansprucht werden.
verification_method string nein dns_txt (Standard) oder manual.

Anfragetext:

{
  "organization_id": "org_01j9xk3m7q8r2s4t6v8w0y2z4a",
  "domain": "acme.com"
}

Antwort

201 Created mit der Domain und einem ETag-Header.

{
  "id": "odm_01j9xk3m7q8r2s4t6v8w0y2z4c",
  "organization_id": "org_01j9xk3m7q8r2s4t6v8w0y2z4a",
  "domain": "acme.com",
  "status": "pending",
  "verification_method": "dns_txt",
  "txt_record_name": "_akp-verify.acme.com",
  "txt_record_value": "idp-verify=EXAMPLEtokenEXAMPLEtokenEXAMPLEtokenEXAMPLEtok",
  "verification_started_at": "2026-10-12T09:30:00.123456Z",
  "verified_at": null,
  "last_checked_at": null,
  "unverified_at": null,
  "next_check_at": "2026-10-12T09:31:00.123456Z",
  "last_failure_code": null,
  "capture_mode": "off",
  "sso_routing_enabled": false,
  "created_at": "2026-10-12T09:30:00.123456Z",
  "updated_at": "2026-10-12T09:30:00.123456Z",
  "version": 1
}

Fehler

HTTP code Wann
400 unknown_field Der Text enthält ein Feld, das nicht im Schema steht oder schreibgeschützt ist.
404 not_found In dieser Umgebung existiert keine Organisation mit dieser ID.
409 conflict Diese Organisation hat diese Domain bereits.
409 domain_already_verified Eine andere Organisation hat diese Domain bereits verifiziert.
409 domain_limit_reached Die Organisation hat bereits 100 Domains.
409 organization_disabled Die Organisation ist deaktiviert.
409 organization_pending_deletion Die Organisation wartet auf die Löschung im Self-Service; brechen Sie zuerst die Löschung ab.
422 domain_not_claimable Die Domain ist ein öffentliches Suffix oder ein kostenloser E-Mail-Anbieter.
422 validation_failed Ein Feld ist ungültig (organization_id, domain, verification_method).
401 unauthenticated Der Berechtigungsnachweis fehlt, ist ungültig oder widerrufen.
403 insufficient_permissions Dem Berechtigungsnachweis fehlt die erforderliche Berechtigung.
429 rate_limited Das Ratenlimit wurde überschritten; wiederholen Sie nach dem Zeitraum aus Retry-After.
503 service_unavailable Eine Abhängigkeit ist vorübergehend nicht verfügbar; wiederholen Sie nach dem Zeitraum aus Retry-After.

Beispiel

curl -X POST https://api.eu.keenauth.com/v1/organization-domains \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"organization_id":"org_01j9xk3m7q8r2s4t6v8w0y2z4a","domain":"acme.com"}'