ディレクトリを取得

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

SCIM ディレクトリを 1 件、未解決の一括デプロビジョニング保留とともに返します(保留がない場合は null)。1 回の同期で一度に多くのユーザーがデプロビジョニング解除されてしまう場合に保留が作成されます。deprovision-holds エンドポイントで承認または却下してください。トークンのメタデータは GET /v1/directories/{directory_id}/tokens で一覧できます。

リクエスト

フィールド 型 必須 説明
directory_id パス はい SCIM ディレクトリ ID(dir_…)。

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

レスポンス

ディレクトリと ETag を含む 200 OK(PATCH /v1/directories/{directory_id} に使う If-Match の値)。

{
  "id": "dir_01j9xm2n4p6q8r0s2t4v6w8y0z",
  "organization_id": "org_01j9xk3m7q8r2s4t6v8w0y2z4a",
  "type": "scim",
  "name": "Okta",
  "state": "inactive",
  "base_url": "https://acme.eu.keenauth.app/scim/v2/dir_01j9xm2n4p6q8r0s2t4v6w8y0z",
  "created_at": "2026-10-19T09:31:00.123456Z",
  "last_request_at": null,
  "provisioning_mode": "user_store",
  "attribute_allowlist": [],
  "unverified_domain_action": "invite",
  "delete_action": "remove_membership",
  "on_delete_memberships": "keep",
  "mass_deprovision_guard": {"enabled": true, "percent": 10, "absolute_min": 25},
  "send_welcome_email": false,
  "open_deprovision_hold": {
    "id": "0192a3c0-1d2e-7f3a-8b4c-5d6e7f8a9b0c",
    "opened_at": "2026-10-19T10:02:00Z",
    "pending_count": 42
  }
}

エラー

HTTP code 発生条件
404 not_found この環境にディレクトリが存在しません。
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" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"