権限を一覧表示する

GET /v1/permissions · 権限 apis:read

1つのAPIの権限（OAuthスコープ）を、同意画面に表示されるテキストとともに、新しい順にカーソルのページ単位で返します。環境は資格情報からのみ決まります。

リクエスト

パラメータ	型	必須	説明
`api_id`	文字列	はい	API（`api_…`）。ない、繰り返されている、または形式が不正な場合は、ポインター `/api_id` とともに `422` が返されます。
`limit`	整数	いいえ	1〜100。既定値は20。
`after`	文字列	いいえ	`list_metadata.after` のカーソル。`before` とは同時に指定できません。
`before`	文字列	いいえ	`list_metadata.before` のカーソル。
`order`	文字列	いいえ	`asc` または `desc`（既定値）。カーソルは同じ `api_id` と `order` の場合のみ有効です。

レスポンス

200 OK

{
  "data": [ {
  "id": "perm_01h455vb4pex5vsknk084sn02s",
  "api_id": "api_01h455vb4pex5vsknk084sn02q",
  "value": "read:orders",
  "display_name": "Read orders",
  "description": "See your past orders and their status",
  "consent_text_i18n": {
    "en": "Read your orders",
    "tr": "Siparişlerinizi okuyun"
  },
  "sensitivity": "normal"
} ],
  "list_metadata": { "before": null, "after": "eyJ2IjoxLi4ufQ" }
}

同意テキストのない権限は、display_name と description が null、consent_text_i18n が {} になります。null のカーソルは、その方向にこれ以上レコードがないことを意味します。総件数は返されません。

エラー

HTTP	code	情況
400	`invalid_cursor`	カーソルの形式が不正、改ざんされている、または別の環境、`api_id`、`order` 向けに発行されたものです。
403	`insufficient_permissions`	資格情報に `apis:read` がありません。
404	`not_found`	この環境にそのようなAPIはありません。
422	`validation_failed`	`api_id` がない、繰り返されている、または形式が不正、もしくは他のクエリパラメータが無効です。

例

curl "https://api.eu.keenauth.com/v1/permissions?api_id=api_01h455vb4pex5vsknk084sn02q&limit=20" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"