カスタム CSS を設定
PUT /v1/branding/css · 権限 branding:write
環境の下書きのカスタム CSS を書き込みます (Startup 以上のプラン、機能 branding_custom_css)。CSS は許可リスト方式のサニタイザーを通ります。使用できるのは ui_catalog のクラス (idp-*) と許可されたプロパティおよび値のみで、保護レイヤー (法的テキスト、同意、アクセシビリティ要素) を隠したり覆ったりすることはできません。オール・オア・ナッシング: 違反が 1 つでもあれば何も書き込まれません。下書きには送信したテキストではなくサニタイザーの正規化出力が保存され、レスポンスの css はその出力です。空文字列で消去し、プランの制限を受けません。
リクエスト
| フィールド | タイプ | 必須 | 説明 |
|---|---|---|---|
If-Match |
ヘッダー | はい | 最後に読み取った下書きの ETag (未書き込みなら "0")。ない場合は 428、古い場合は 412。 |
css |
文字列 | はい | 最大 51200 バイト、有効な UTF-8。"" で消去。 |
レスポンス
200 OK と環境の下書きおよび ETag。theme には設定済みのトークンのみが含まれ、未設定のトークンはプラットフォーム既定値を継承します。
{
"theme": {"mode": "light", "light": {"color": {"primary": "#0a3d91"}}, "logo_height": 40},
"css": ".idp-c .idp-title{color:#0a3d91}\n",
"page_template": null,
"updated_at": "2026-10-05T09:30:00.123456Z"
}
エラー
| HTTP | コード | 概要 |
|---|---|---|
| 400 | unknown_field |
本文に不明なフィールドがあるか、JSON オブジェクトではありません。 |
| 403 | plan_feature_unavailable |
プランにこの機能が含まれていません (plan_feature_unavailable、拡張 feature と required_plan)。開発環境は制限されません。 |
| 412 | precondition_failed |
If-Match が下書きの現在のバージョンと一致しません。 |
| 422 | validation_failed |
css がない、null (required)、長すぎる (too_long)、または有効な UTF-8 ではありません (invalid_utf8)。 |
| 422 | branding_validation_failed |
CSS がサニタイザーを通過しませんでした。violations 拡張にすべての違反が列挙されます: line、column (1 始まり)、rule (例: class_not_in_catalog、protected_property、property_not_allowed、syntax_error)、および該当する場合は name (プロパティ、クラス、または関数の名前)。CSS の値は返されません。違反が 100 件を超えるとサニタイザーは停止し、最後の項目のルールは too_many_issues です。正規化された出力は入力より長くなります (すべてのルールにスコープ接頭辞が付与されるため)。51200 バイトを超える場合、唯一の違反はルール too_large (1 行目、1 列目) です。 |
| 428 | precondition_required |
If-Match ヘッダーがありません。 |
| 401 | unauthenticated |
認証情報がない、無効、または失効しています。 |
| 403 | insufficient_permissions |
認証情報に必要な権限がありません。 |
| 429 | rate_limited |
レート制限を超えました。Retry-After の期間後に再試行してください。 |
| 503 | service_unavailable |
依存サービスが一時的に利用できません。Retry-After の期間後に再試行してください。 |
サニタイザーによる拒否の例:
.idp-button{position:fixed}
.my-banner{color:red}
{
"type": "https://docs.keenauth.com/errors/branding_validation_failed",
"title": "Branding validation failed",
"status": 422,
"code": "branding_validation_failed",
"violations": [
{"line": 1, "column": 13, "rule": "property_not_allowed", "name": "position"},
{"line": 2, "column": 1, "rule": "class_not_in_catalog", "name": "my-banner"}
],
"request_id": "req_01J9Z3N5W8Q2F6V4K7T1M0XB3C"
}
例
curl -X PUT https://api.eu.keenauth.com/v1/branding/css \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
-H "Content-Type: application/json" \
-H 'If-Match: "3"' \
-d '{"css":".idp-title { color: #0a3d91 }"}'