ユーザーの有効な権限を取得する
GET /v1/users/{user_id}/effective-permissions · 権限 users:read
サポートとデバッグのために、ユーザーが実際に持っている権限を返します。ユーザーの直接の環境ロールの権限と、org_id を指定した場合はその組織におけるユーザーの有効なメンバーシップのロールの権限が含まれます。各権限には、それを付与しているロールが一覧表示されます。削除された API の権限は含まれません。一覧はページ分割されず、API、次に権限値の順に並びます。
リクエスト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
user_id |
path | はい | ユーザー ID(usr_…)。 |
org_id |
query | いいえ | 組織 ID(org_…)。その組織における、ユーザーの有効なメンバーシップのロールも含めます。 |
api_id |
query | いいえ | API ID(api_…)。その API の権限だけを返します。未知の API の場合は空の一覧になります。 |
リクエストボディはありません。
レスポンス
200 OK で、権限を返します。
{
"permissions": [
{
"permission_id": "perm_01j9xs0a2b4c6d8e0f2g4h6j8k",
"api_id": "api_01j9xq1b3c5d7e9f1g3h5j7k9m",
"value": "read:invoices",
"role_ids": [
"rol_01j9xr7s1t2w6x8y0z2a4b6c8e"
]
}
]
}
エラー
| HTTP | code | 発生条件 |
|---|---|---|
| 404 | not_found |
ユーザー、または org_id で指定された組織が、この環境に存在しません。 |
| 422 | validation_failed |
org_id または api_id の形式が不正、または重複している。 |
| 401 | unauthenticated |
認証情報がない、無効、または失効している。 |
| 403 | insufficient_permissions |
認証情報に必要な権限がありません。 |
| 429 | rate_limited |
レート制限を超えました。Retry-After の期間を待ってから再試行してください。 |
| 503 | service_unavailable |
依存先が一時的に利用できません。Retry-After の期間を待ってから再試行してください。 |
例
curl -i -X GET "https://api.eu.keenauth.com/v1/users/usr_01j9xh2k6p7q1r3s5t7v9w1x3y/effective-permissions?org_id=org_01j9xk3m7q8r2s4t6v8w0y2z4a" \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY"