アプリケーションを一覧表示する
GET /v1/applications · 権限 applications:read
環境のアプリケーションを、最新のものから順に一覧表示します(order=ascで順序が逆になります)。ページネーションはカーソルベースです。list_metadata.afterをafterとして次のページに、list_metadata.beforeをbeforeとして前のページに渡します。カーソルは発行されたフィルターと順序に限定されます。他のフィルターで使用すると400 invalid_cursorが返されます。総数は返されません。
リクエスト
| パラメーター | 型 | 説明 |
|---|---|---|
limit |
integer | 1~100、デフォルト20。 |
after / before |
string | 不透明なカーソル。両方ではありません。 |
order |
string | desc(デフォルト)またはasc。 |
app_type |
string | フィルター:web、spa、native、m2m、device、management。 |
status |
string | フィルター:activeまたはsuspended。 |
レスポンス
200 OK。
{
"data": [ { "id": "app_6f8d0cjgbmf0gtn2rg6pscp3cg", "key": "portal", "…": "…" } ],
"list_metadata": { "before": null, "after": "<cursor>" }
}
エラー
| HTTP | code |
状況 |
|---|---|---|
| 401 | unauthenticated |
キーが見つからない、無効、またはアクティベーション解除されている。 |
| 403 | insufficient_permissions |
キーが必要な権限を持っていない。 |
| 400 | invalid_cursor |
カーソルが不正な形式か、他のフィルターまたは順序で発行されたか、別の環境に属している。 |
| 422 | validation_failed |
クエリパラメーター(limit、order、app_type、status)が無効です。 |
例
curl "https://api.eu.keenauth.com/v1/applications?limit=20&app_type=web" \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY"