メンバーシップを一時停止する

POST /v1/organizations/{org_id}/memberships/{membership_id}:suspend · 権限 organizations:write

アクティブなメンバーシップ（理由 admin_suspended）を一時停止します。一時停止されたメンバーは、組織のコンテキストでサインインできず、組織のセッションも終了します。組織の最後のアクティブな管理者は一時停止できません。すでに一時停止されているメンバーシップに対しては何も書き込まれません。この書き込みは change=suspended とともに organization_membership.updated として監査されます。

リクエスト

フィールド 型 必須 説明
org_id path はい 組織 ID（org_…）。
membership_id path はい メンバーシップ ID（mem_…）。
If-Match header いいえ 現在の ETag。指定する場合は一致している必要があり（412）、その version に書き込みを固定します。

リクエストボディはありません。

レスポンス

200 OK で、更新されたメンバーシップと ETag を返します。

{
  "id": "mem_01j9xn5p9s0t4v6w8x0y2z4a6c",
  "organization_id": "org_01j9xk3m7q8r2s4t6v8w0y2z4a",
  "user_id": "usr_01j9xh2k6p7q1r3s5t7v9w1x3y",
  "status": "suspended",
  "source": "admin_api",
  "reason": "admin_suspended",
  "roles": [
    {
      "role_id": "rol_01j9xr7s1t2w6x8y0z2a4b6c8e",
      "source": "admin_api",
      "assigned_at": "2026-10-12T09:31:00.123456Z"
    }
  ],
  "expires_at": null,
  "created_at": "2026-10-12T09:31:00.123456Z",
  "activated_at": "2026-10-12T09:31:00.123456Z",
  "suspended_at": "2026-10-12T10:00:00Z",
  "removed_at": null,
  "updated_at": "2026-10-12T10:00:00Z",
  "version": 2
}

エラー

HTTP code 条件
404 not_found この組織にメンバーシップが存在しません。
409 last_org_admin このメンバーシップは組織の最後のアクティブな管理者です。
412 precondition_failed If-Match が現在の version と一致しません。
422 validation_failed メンバーシップが招待中または削除済みです（/status invalid_state）。
401 unauthenticated 認証情報が未指定、無効、または取り消されています。
403 insufficient_permissions 認証情報に必要な権限がありません。
429 rate_limited レート制限を超えました。Retry-After の期間を待ってから再試行してください。
503 service_unavailable 依存サービスが一時的に利用できません。Retry-After の期間を待ってから再試行してください。

例

curl -i -X POST "https://api.eu.keenauth.com/v1/organizations/org_01j9xk3m7q8r2s4t6v8w0y2z4a/memberships/mem_01j9xn5p9s0t4v6w8x0y2z4a6c:suspend" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H 'If-Match: "2"'

個人データ

このエンドポイントは個人データを扱います：組織のメンバーシップと招待。KeenAuth API における個人データでは、保存される内容、保存期間、削除方法を説明しています。いずれのフィールドにも特別な種類の個人データ（健康、生体情報、宗教、政治的意見、性的指向）を送信しないでください。