Jump to

• Request
• Response

plan change-user

post

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

Change a user with the specified name in the store. The retainCurrentPassword argument option causes the current password to be remembered during the setPassword operation as a valid alternate password for configured retention time or until cleared using clearRetainedPassword. If a retained password has already been set for the user, setting retained password again will cause an error to be reported.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Admin CLI Command:
plan change-user -name [-disable | -enable] [-set-password [-password ] [-retain-current-password]] [-clear-retained-password]

Root Schema : schema

Type: object

Show Source

• arguments: array arguments
• command(required): string
  Allowed Values: [ "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"
            }
        ]
    }
}

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

Nested Schema : arguments

Type: array

Show Source

• Array of: object items

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

Nested Schema : items

Type: object

Show Source

• argumentName: string
• argumentValue: argumentValue

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

Nested Schema : argumentValue

Match One Schema

Show Source

• string
• boolean

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Operation ended successfully

Body ()

Root Schema : commonResponse

Type: object

Show Source

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

{
    "properties":{
        "operation":{
            "type":"string"
        },
        "returnCode":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "returnValue":{
            "type":"object"
        }
    },
    "example":{
        "operation":"operation executed",
        "returnCode":"5000 when success, 5100 infers illegal command, 5200 - 5500 infers connection/resource/internal problem at execution",
        "description":"error description when returnCode != 5000",
        "returnValue":"JSON object with the output returned by the command when returnCode: 5000(success). Otherwise, null"
    },
    "required":[
        "operation",
        "returnCode",
        "description",
        "returnValue"
    ]
}

Example:

{
    "operation":"operation executed",
    "returnCode":"5000 when success, 5100 infers illegal command, 5200 - 5500 infers connection/resource/internal problem at execution",
    "description":"error description when returnCode != 5000",
    "returnValue":"JSON object with the output returned by the command when returnCode: 5000(success). Otherwise, null"
}

Nested Schema : returnValue

Type: object

Back to Top