本記事では、obshellを使用してテナント内のユーザーを削除する方法について説明します。
説明
このAPIはobshell V4.2.6以降でサポートされています。
呼び出しの概要
インターフェース制約
obshell ServerはこのAPIに対してセキュリティ検証を実施します。詳細についてはAPIハイブリッド暗号化を参照してください。
リクエストパス
DELETE /api/v1/tenant/{tenant_name}/user/{user_name}
リクエストパラメータ
| パラメータ | タイプ | 必須 | サンプル値 | 説明 |
|---|---|---|---|---|
| root_password | string | いいえ | ***** | テナントのrootユーザーのパスワードです。システムテナントのユーザーを削除する場合は、このパラメータを指定する必要はありません。 |
実行結果
| パラメータ | タイプ | 説明 |
|---|---|---|
| successful | bool | リクエストが成功したかどうかを示します。 |
| timestamp | time.Time | サーバーがリクエストを完了したタイムスタンプです。 |
| duration | int | サーバーがリクエストを処理した時間（ミリ秒）です。 |
| status | int | HTTP Status規格に準拠するエンコードです。 |
| traceId | string | リクエストのトレースIDです。 |
| error | ApiError | リクエストによって生成されたエラーで、以下の情報が含まれます：
|
例
リクエスト例
DELETE 10.10.10.1:2886/api/v1/tenant/sys/user/proxyro
実行結果例
{
"successful": true,
"timestamp": "2025-03-26T10:46:40.052855656+08:00",
"duration": 54,
"status": 200,
"traceId": "53b9e01e070daf7c"
}
関連ドキュメント
コマンドラインからAPIを呼び出す以外に、SDKメソッドを使用してAPIを呼び出すこともできます。obshell-sdk-pythonを使用したAPIメソッドの呼び出しについては、ユーザーの削除を参照してください。