管理クライアントの一覧取得

GET /v1/management-clients · 権限 management-clients:read

環境の管理クライアントのレコードを、カーソルによるページ単位で返します。並び順は既定で application_id の降順です。レコードは management 種別のアプリケーションに属し、管理 API に対する権限の上限と IP 許可リストを保持します。クライアントの署名キーはこのリソースには含まれません。/v1/applications/{application_id}/credentials で管理してください。このエンドポイントを呼び出せるのは API キーだけで、環境はキーから決まります。

リクエスト

パラメータ 型 必須 説明
limit integer いいえ 1〜100、既定値 20。
after string いいえ list_metadata.after から得たカーソル。before とは同時に指定できません。
before string いいえ list_metadata.before から得たカーソル。
order string いいえ asc または desc(既定値)。カーソルは同じ order でのみ有効です。

レスポンス

200 OK

{
  "data": [
    {
      "application_id": "app_01h455vb4pex5vsknk084sn02q",
      "permissions": ["users:read", "users:write"],
      "allowed_cidrs": ["203.0.113.0/24"]
    }
  ],
  "list_metadata": { "before": null, "after": null }
}

カーソルが null の場合、その方向にこれ以上のレコードはありません。総件数は返されません。アプリケーションを削除すると、そのレコードも削除されます。アプリケーションが存在しなくなったレコードは一覧に表示されず、ページがそのレコードに達したときに削除されます。そのため after が設定されていても、ページ内のレコードが limit より少ないことがあります。カーソルをたどり続けてください。

エラー

HTTP code 発生条件
400 invalid_cursor カーソルの形式が不正、改ざんされている、または別の環境や別の order 向けに発行されたものです。
403 insufficient_permissions 資格情報に management-clients:read がない、または API キーではありません。
422 validation_failed クエリパラメータが不正です。

例

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

CLI: keenauth management-clients list --limit 20