Branding-Entwurf veröffentlichen

POST /v1/branding:publish · Berechtigung branding:write

Erstellt einen Snapshot aller Entwürfe (Umgebung, Anwendungen, Organisationen, Texte) und macht ihn zur Live-Version der gehosteten Seiten. Vor dem Veröffentlichen wird das effektive Thema jedes Bereichs geprüft: Pflicht-Tokens, Wertebereiche und WCAG-Kontrast jedes Farbpaars. Jedes Problem lehnt die gesamte Veröffentlichung mit 422 branding_validation_failed ab; die Liste issues[] nennt jedes zu ändernde Token (beim Kontrast mit gemessenem ratio, threshold und der nächstgelegenen gültigen suggestion). Die letzten 50 Versionen werden aufbewahrt. Idempotency-Key ist optional.

Enthält der Entwurf benutzerdefiniertes CSS, wird es vor jeder Veröffentlichung auch auf den gehosteten Bildschirmen gerendert (eine Renderprüfung, die bis zu 25 Sekunden dauern kann; verwenden Sie einen Client-Timeout von mindestens 30 Sekunden). CSS, das ein geschütztes Element beschädigt oder eine Barrierefreiheitsverletzung hinzufügt, die die Seite ohne es nicht hat, lehnt die Veröffentlichung mit 422 branding_validation_failed und der Liste render_violations[] ab. Ändert sich der Entwurf während der Prüfung, wird nichts veröffentlicht und Sie erhalten 409 conflict; veröffentlichen Sie erneut.

Anfrage

Dieser Vorgang hat keine Pfad-, Query- oder Body-Felder. Die Umgebung ergibt sich aus der Anmeldeinformation.

Antwort

200 OK mit den Metadaten der neuen Version (der Snapshot selbst wird nicht zurückgegeben).

{
  "version": 4,
  "snapshot_sha256": "3f1c…",
  "source": "publish",
  "rolled_back_from": null,
  "actor_type": "api_key",
  "actor_id": "key_01jb…",
  "published_at": "2026-10-05T09:31:00Z"
}

{
  "type": "https://docs.keenauth.com/problems/branding_validation_failed",
  "status": 422,
  "code": "branding_validation_failed",
  "issues": [
    {"scope_type": "environment", "code": "brand_contrast_insufficient", "field": "light.color.primary_contrast",
     "variant": "light", "pair": "primary_contrast_on_primary", "ratio": 2.1, "threshold": 4.5, "suggestion": "#ffffff"}
  ]
}

Eine Ablehnung durch die Renderprüfung listet jeden Befund auf: screen (zum Beispiel password), locale (en, ar oder ja), width (Viewport-Breite in CSS-Pixeln, 320 oder 1280), rule (protected_no_area, protected_not_visible, protected_transparent, protected_covered, protected_contrast oder eine axe-core-Regel-ID wie color-contrast) und target (Name des geschützten Elements oder ein axe-core-CSS-Selektor). CSS-Werte werden nie zurückgegeben. Es werden höchstens 100 Befunde zurückgegeben; render_violations_truncated ist true, wenn es mehr gab.

{
  "type": "https://docs.keenauth.com/errors/branding_validation_failed",
  "status": 422,
  "code": "branding_validation_failed",
  "render_violations": [
    {"screen": "recovery", "locale": "ar", "width": 320, "rule": "protected_covered", "target": "recovery_codes_hint"}
  ],
  "render_violations_truncated": false
}

Fehler

HTTP Code Wann
403 plan_feature_unavailable Der Entwurf enthält benutzerdefiniertes CSS oder eine Seitenvorlage, die der Plan nicht umfasst (feature nennt sie).
422 branding_validation_failed Der Entwurf kann nicht veröffentlicht werden; siehe issues[]. Das benutzerdefinierte CSS des Entwurfs wird beim Veröffentlichen erneut bereinigt; schlägt das fehl, stehen die Verstöße in der Erweiterung violations[] (siehe PUT /v1/branding/css). Scheitert das benutzerdefinierte CSS an der Renderprüfung, stehen die Befunde in render_violations[] und render_violations_truncated.
409 conflict Der Entwurf hat sich geändert, während sein benutzerdefiniertes CSS geprüft wurde; nichts wurde veröffentlicht. Veröffentlichen Sie erneut.
401 unauthenticated Die Anmeldeinformation fehlt, ist ungültig oder widerrufen.
403 insufficient_permissions Der Anmeldeinformation fehlt die erforderliche Berechtigung.
429 rate_limited Das Ratenlimit wurde überschritten; nach der Retry-After-Zeit erneut versuchen.
503 service_unavailable Eine Abhängigkeit ist vorübergehend nicht verfügbar (einschließlich der Renderprüfung eines Entwurfs mit benutzerdefiniertem CSS); nach der Retry-After-Zeit erneut versuchen.

Beispiel

curl -X POST https://api.eu.keenauth.com/v1/branding:publish \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)"