マス・デプロビジョニング保留の一覧表示

GET /v1/directories/{directory_id}/deprovision-holds · 権限 directories:read

ディレクトリのマス・デプロビジョニング保留を、未決定と決定済みの両方について新しいものから順に一覧表示します。保留されたデプロビジョニングの件数、ステータス、決定内容を返します。保留対象のユーザーは返しません。未決定の保留は POST /v1/directories/{directory_id}/deprovision-holds/{hold_id}:approve または :reject で承認または却下されます。72 時間経過すると、タイムアウトにより承認されます。前方へのページングのみ可能です。カーソルはディレクトリに紐づきます。

リクエスト

フィールド	型	必須	説明
`directory_id`	path	はい	SCIM ディレクトリ ID（`dir_…`）。
`limit`	query	いいえ	1〜100。デフォルトは 20。
`after`	query	いいえ	`list_metadata.after` から取得したカーソル。

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

レスポンス

200 OK を、保留のページとともに返します。

{
  "data": [
    {
      "id": "0190a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
      "status": "approved",
      "opened_at": "2026-10-20T09:00:00Z",
      "pending_count": 42,
      "decided_by": "api_key:key_01j9xr6s8t0v2w4x6y8z0a2b4d",
      "decided_at": "2026-10-20T10:00:00Z"
    }
  ],
  "list_metadata": {
    "before": null,
    "after": null
  }
}

status は open、approved、rejected のいずれかです。decided_by は api_key:<key ID>、admin_portal_link:apl_…、timeout のいずれかで、保留が未決定の間は decided_at と null です。

エラー

HTTP	code	発生条件
400	`invalid_cursor`	カーソルが無効、または別のディレクトリに属している。
404	`not_found`	この環境にディレクトリが存在しない。
422	`validation_failed`	`limit` が範囲外、または `before` か `order` が指定された（`unsupported`）。
401	`unauthenticated`	認証情報がない、無効、または取り消されている。
403	`insufficient_permissions`	認証情報に必要な権限がない。
429	`rate_limited`	レート制限を超えた。`Retry-After` の期間の後に再試行してください。
503	`service_unavailable`	ディレクトリ同期が一時的に利用できないか、このデプロイでは設定されていない。`Retry-After` の期間の後に再試行してください。

例

curl -i "https://api.eu.keenauth.com/v1/directories/dir_01j9xm2n4p6q8r0s2t4v6w8y0z/deprovision-holds?limit=20" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

個人データ

このエンドポイントは個人データを扱います: ディレクトリ（SCIM）ユーザー。KeenAuth API における個人データでは、保存される内容、保存期間、削除方法を説明しています。いかなるフィールドにも、特別な種類の個人データ（健康、生体情報、宗教、政治的意見、性的指向）を送信しないでください。