削除¶
POST /api/v1/role/{role_uuid}/delete
概要¶
現在のワークスペースのカスタムロールと権限関係を削除し、関連するメニュー参照をクリーンアップします。
呼び出し前の準備と使用手順¶
ロール一覧からワークスペースのカスタムロールを選択し、削除する前に、そのロールを使用しているメンバー/API Key、SAML またはログインマッピング、および SSO 設定を移行してください。システム予約ロールおよび管理コンソールアプリケーションの組み込みロールは、この API では削除できません。リクエストボディはありません。成功時は content={} を返し、true ではありません。ワークスペースのカスタムロールが見つからない場合も同じ空オブジェクトが返される可能性があるため、一覧を再取得して確認する必要があります。ロールを削除してもアカウントは削除されません。上記の直接的なメンバー/API Key、SAML/ログインマッピング、SSO 参照が検出された場合は、先に解除してから再試行してください。アカウントグループなどの継承ロールマッピングは別途確認が必要であり、本 API はすべての継承関係の検証や自動解除を保証するものではありません。
パスパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| role_uuid | string | Y | ワークスペースのカスタムロール UUID。名前や管理コンソールの組み込みロールテンプレート UUID で代替しないでください。 例: role_example取得・入力方法: ロール一覧の content.data[].uuid から対象のワークスペースのカスタムロールを取得し、ロール詳細で確認できます。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得・入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
パラメータ補足説明¶
この API の削除結果は処理フローが終了したことのみを示し、項目ごとの参照リストは提供せず、他の主体に必要な業務ロールを置き換えることもありません。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/role/role_example/delete' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | 削除処理は空オブジェクト {} を返します。この結果は削除可能なロールが見つからない場合も含み、declaration は付加されません。 |
{
"code": 200,
"content": {},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンス説明 | 対処方法 |
|---|---|---|---|---|
| 400 | ft.InvalidAction | システム予約ロールまたは管理コンソールアプリケーションの組み込みロールを削除した場合 | 無効な操作 | 保護されたロールは保持し、対象ワークスペースのカスタムロールのみを操作してください。 |
| 400 | ft.InvalidActionRoleExistsRefAccount | ロールがまだメンバーアカウントまたは API Key から直接参照されている場合 | 現在のロール とメンバーアカウント/API KEY に関連が存在します。クリアしてから削除してください | まずこれらの主体のロールバインディングを移行してから削除してください。 |
| 400 | ft.InvalidActionRoleExistsRefSAMLMapping | ロールがまだ SAML またはカスタムログインマッピングから参照されている場合 | 現在のロールと SAML Mapping に関連が存在します。クリアしてから削除してください | 先に対応するマッピングルールを調整してください。 |
| 400 | ft.InvalidActionRoleExistsRefSSOSetting | ロールがまだ SSO 設定から参照されている場合 | 現在のロールと SSO 設定に関連が存在します。SSO 設定を更新してからロールを削除してください | 先に SSO 設定内のデフォルトロールを変更してください。 |
| 500 | ft.InternalServerError | 削除、メニュー参照のクリーンアップ、またはその他の内部処理に失敗した場合 | 内部エラー | まずロールがまだ存在するか、および参照状態を確認してから再試行を判断してください。継続的に失敗する場合は traceId を提供してください。 |
| 401 | ft.WKSPNotExistOrReleased | メニュー参照のクリーンアップ時に、ワークスペースが削除または解放済みであることが判明した場合 | ワークスペースが存在しない/または解放済み | API Key に対応するワークスペースがまだ有効か確認し、利用可能なワークスペースを再選択してください。 |