組織を更新

PATCH /v1/organizations/{org_id} · 権限 organizations:write

JSON マージパッチ（RFC 7396、Content-Type: application/merge-patch+json）を使用して組織を更新します。送信されなかったフィールドは変更されません。変更が発生しないパッチではバージョンは変わりません。name と slug はクリアできません。

リクエスト

フィールド 型 必須 説明
org_id path はい 組織 ID（org_…）。
If-Match header はい 必須です。前回読み取った ETag（"<version>"）。
name string いいえ 表示名。1〜256 文字で、制御文字は使用できません。
slug string いいえ 新しいスラッグ（同じ形式）。30 日に 1 回変更できます。旧スラッグは 90 日間予約されます。
external_id string | null いいえ お客様独自の識別子。255 文字以内で、環境内で一意である必要があります。null を指定するとクリアされます。
metadata object | null いいえ 現在のオブジェクトにマージされます（RFC 7396）。値が null のメンバーは削除されます。フィールド全体に null を指定すると {} にリセットされます。
brand_color string | null いいえ ブランドカラー #RRGGBB。大文字で保存されます。null を指定するとクリアされます。
max_memberships integer | null いいえ メンバーシップの上限。1 以上。null は無制限を意味します。
default_zoneinfo string | null いいえ 既定の IANA タイムゾーン（例：Europe/Istanbul）。ブラウザや IdP が指定しない場合に、組織のコンテキストでサインアップ、招待、JIT SSO、SCIM に使用されます。null を指定するとクリアされ、環境の既定値が適用されます。

リクエストボディ：

{
  "name": "Acme Corporation",
  "metadata": {
    "tier": null,
    "region": "eu"
  }
}

レスポンス

更新後の組織と新しい ETag を含む 200 OK が返されます。

{
  "id": "org_01j9xk3m7q8r2s4t6v8w0y2z4a",
  "name": "Acme Corporation",
  "slug": "acme",
  "external_id": "crm-4821",
  "status": "active",
  "metadata": {
    "region": "eu"
  },
  "brand_color": "#1F6FEB",
  "max_memberships": null,
  "default_zoneinfo": null,
  "created_via": "admin_api",
  "disabled_at": null,
  "deletion_requested_at": null,
  "deletion_due_at": null,
  "created_at": "2026-10-12T09:30:00.123456Z",
  "updated_at": "2026-10-12T10:05:00.654321Z",
  "version": 2
}

エラー

HTTP code 発生条件
400 unknown_field ボディにスキーマにないフィールド、または読み取り専用のフィールド（id、status など）が含まれています。
401 unauthenticated 認証情報が指定されていないか、不正であるか、取り消されています。
403 insufficient_permissions 認証情報に必要な権限がありません。
404 not_found この環境に、この ID の組織は存在しません。
409 slug_taken このスラッグは別の組織が使用しています。
409 slug_reserved このスラッグは予約語であるか、別の組織が以前使用していたスラッグです（90 日間予約されます）。
409 slug_change_rate_limited スラッグは 30 日以内に変更されています。
409 external_id_taken この external_id は別の組織が使用しています。
409 organization_pending_deletion この組織はセルフサービス削除の待機中です。先に削除を取り消してください。
412 precondition_failed If-Match が現在のバージョンと一致しません。組織を再度読み取ってください。
422 validation_failed フィールドが不正です（name、slug、external_id、metadata、brand_color、max_memberships、default_zoneinfo）。
428 precondition_required If-Match が指定されていません。
429 rate_limited レート制限を超えました。Retry-After の期間が経過してから再試行してください。
503 service_unavailable 依存先が一時的に利用できません。Retry-After の期間が経過してから再試行してください。

例

curl -X PATCH "https://api.eu.keenauth.com/v1/organizations/org_01j9xk3m7q8r2s4t6v8w0y2z4a" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Content-Type: application/merge-patch+json" \
  -H 'If-Match: "1"' \
  -d '{"name":"Acme Corporation"}'