plan change-user
post
/V0/nosql/admin/plan#change-user
ストアで指定された名前でユーザーを変更します。
retainCurrentPassword
引数オプションを指定すると、構成された保存時間の間、またはclearRetainedPassword
を使用して消去するまで、setPassword
操作において現行パスワードが有効代替パスワードとなります。保持されているパスワードがすでにユーザーに対して設定されている場合は、それを再度設定するとエラーが発生しレポートされます。リクエスト
この操作のリクエスト・パラメータはありません。
サポートされているメディア・タイプ
- application/json
管理CLIコマンド:
plan change-user -name [-disable | -enable] [-set-password [-password ] [-retain-current-password]] [-clear-retained-password]
plan change-user -name
ルート・スキーマ: schema
型:
ソースの表示
object
- arguments(optional): array arguments
- command: string
指定できる値:
[ "change-user" ]
例:
{
"command":"change-user",
"arguments":[
{
"name":"Name of the user"
},
{
"disable":"true|false Whether to disable the user"
},
{
"enable":"true|false Whether to enable the user"
},
{
"setPassword":"true|false Whether to set password for the user"
},
{
"password":"User's new password"
},
{
"retainCurrentPassword":"true|false Whether to retain current user password after change"
},
{
"clearRetainedPassword":"true|false Whether to clean the previous reained password"
}
]
}
レスポンス
サポートされているメディア・タイプ
- application/json
200 Response
Operation ended successfully
ルート・スキーマ: commonResponse
型:
ソースの表示
object
例:
{
"operation":"Command related operation",
"returnCode":"Error code to indicate the command result, 5000 infers plan success, 5100 infers illegal command, 5200 - 5500 infers connection/resource/internal problem of executing plan.",
"description":"Textual output of the command",
"returnValue":"Valuable information returned by the command execution in JSON object format"
}
ネストされたスキーマ: returnValue
型:
object