環境ロールを一覧表示

GET /v1/roles · 権限 roles:read

環境のロールカタログを古い順に一覧表示します。前方へのページングのみサポートされます。before や asc 以外の order を指定すると 422 を返します。カーソルはこの一覧に紐づきます。組織ロールはこの一覧には含まれません。このリリースでは、ロールの権限セットは返されません。

リクエスト

フィールド 型 必須 説明
limit query いいえ 1〜100、既定値 20。
after query いいえ list_metadata.after のカーソル。

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

レスポンス

ロールのページとともに 200 OK。

{
  "data": [
    {
      "id": "rol_01j9xr7s1t2w6x8y0z2a4b6c8e",
      "organization_id": null,
      "key": "support",
      "name": "Support",
      "description": "",
      "is_privileged": false,
      "assignable_in_self_service": true,
      "permission_ids": [],
      "created_at": "2026-10-12T09:31:00.123456Z",
      "updated_at": "2026-10-12T09:31:00.123456Z",
      "version": 1
    }
  ],
  "list_metadata": {
    "before": null,
    "after": null
  }
}

エラー

HTTP code 発生条件
400 invalid_cursor カーソルが無効、または別の一覧に属しています。
422 validation_failed limit が範囲外、または before や asc 以外の order が指定されました。
401 unauthenticated 資格情報がない、無効、または失効しています。
403 insufficient_permissions 資格情報に必要な権限がありません。
429 rate_limited レート制限を超えました。Retry-After の期間を待ってから再試行してください。
503 service_unavailable 依存先が一時的に利用できません。Retry-After の期間を待ってから再試行してください。

例

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