ジャンプ先

• リクエスト
• レスポンス

plan change-user

post

/V0/nosql/admin/plan#change-user

ストアで指定された名前でユーザーを変更します。retainCurrentPassword引数オプションを指定すると、構成された保存時間の間、またはclearRetainedPasswordを使用して消去するまで、setPassword操作において現行パスワードが有効代替パスワードとなります。保持されているパスワードがすでにユーザーに対して設定されている場合は、それを再度設定するとエラーが発生しレポートされます。

リクエスト

この操作のリクエスト・パラメータはありません。

サポートされているメディア・タイプ

• application/json

リクエスト本文 - application/json ()

管理CLIコマンド:
plan change-user -name [-disable | -enable] [-set-password [-password ] [-retain-current-password]] [-clear-retained-password]

ルート・スキーマ: schema

型: object

ソースの表示

• arguments: array array arguments
• command(required): string
  指定できる値: [ "change-user" ]

{
    "required":[
        "command"
    ],
    "properties":{
        "command":{
            "type":"string",
            "enum":[
                "change-user"
            ]
        },
        "arguments":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "argumentName":{
                        "type":"string"
                    },
                    "argumentValue":{
                        "oneOf":[
                            {
                                "type":"string"
                            },
                            {
                                "type":"boolean"
                            }
                        ]
                    }
                }
            }
        }
    },
    "example":{
        "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"
            }
        ]
    }
}

例:

{
    "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"
        }
    ]
}

ネストされたスキーマ: argument

型: array

ソースの表示

• 配列: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "argumentName":{
                "type":"string"
            },
            "argumentValue":{
                "oneOf":[
                    {
                        "type":"string"
                    },
                    {
                        "type":"boolean"
                    }
                ]
            }
        }
    }
}

ネストされたスキーマ: items

型: object

ソースの表示

• argumentName: string
• argumentValue: argumentValue

{
    "type":"object",
    "properties":{
        "argumentName":{
            "type":"string"
        },
        "argumentValue":{
            "oneOf":[
                {
                    "type":"string"
                },
                {
                    "type":"boolean"
                }
            ]
        }
    }
}

ネストされたスキーマ : argumentValue

1つのスキーマに一致

ソースの表示

• string
• boolean

{
    "oneOf":[
        {
            "type":"string"
        },
        {
            "type":"boolean"
        }
    ]
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200 Response

Operation ended successfully

本文()

ルート・スキーマ: commonResponse

型: object

ソースの表示

• description(required): string
• operation(required): string
• returnCode(required): string
• returnValue(required): object object returnValue

{
    "properties":{
        "operation":{
            "type":"string"
        },
        "returnCode":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "returnValue":{
            "type":"object"
        }
    },
    "example":{
        "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"
    },
    "required":[
        "operation",
        "returnCode",
        "description",
        "returnValue"
    ]
}

例:

{
    "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

先頭に戻る