組織ロールを削除する
DELETE /v1/organizations/{org_id}/roles/{role_id} · 権限 roles:write
ロールを削除します。force=true を指定すると、割り当てられているロールも削除され、そのメンバーシップの割り当ても同じ操作で削除されます。指定しない場合、割り当てられているロールは 409 role_in_use を返します。組織の管理者ロールまたは既定のメンバーロールとして使われているロールは、削除されることはありません。If-Match は任意です。削除は role.deleted として監査されます。
リクエスト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
org_id |
path | はい | 組織 ID(org_…)。 |
role_id |
path | はい | ロール ID(rol_…)。 |
force |
query | いいえ | true の場合、ロールの割り当ても削除します。false(既定)の場合、割り当てられているロールは削除しません。 |
If-Match |
header | いいえ | 現在の ETag。一致しない場合は 412。 |
リクエストボディはありません。
レスポンス
204 No Content。
エラー
| HTTP | code | 発生条件 |
|---|---|---|
| 404 | not_found |
このスコープにロールが存在しません。 |
| 409 | role_in_use |
ロールが割り当てられており、force が true ではない、または組織の管理者ロールもしくは既定のメンバーロールです。 |
| 412 | precondition_failed |
If-Match が現在のバージョンと一致しません。 |
| 422 | validation_failed |
force が true または false ではない、もしくは繰り返し指定されています。 |
| 401 | unauthenticated |
認証情報が見つからない、無効、または取り消されています。 |
| 403 | insufficient_permissions |
認証情報に必要な権限がありません。 |
| 429 | rate_limited |
レート制限を超えました。Retry-After の期間を待ってから再試行してください。 |
| 503 | service_unavailable |
依存先が一時的に利用できません。Retry-After の期間を待ってから再試行してください。 |
例
curl -i -X DELETE "https://api.eu.keenauth.com/v1/organizations/org_01j9xk3m7q8r2s4t6v8w0y2z4a/roles/rol_01j9xr7s1t2w6x8y0z2a4b6c8e?force=true" \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY"