REST API for Oracle SD-WAN Edge Release 9.1.1

Change a user password

post

http://<SDWAN_TENANT_IP>/v1/admin/manage_appliance/users_Auth/changeLocalUserPwd

Request

There are no request parameters for this operation.

Supported Media Types

application/json

A JSON object containing the user name and password info. oldpwd is required only when username of the logged in user and username for which password is being changed are same.

Root Schema : schema

Type: object

Show Source

confirmpwd: string

Example: admin456
newpwd: string

Example: admin456
oldpwd: string

Example: admin123
timestamp: string

Example: MTYyNTUxNTc3Mg==
username: string

Example: adminuser

{
    "type":"object",
    "properties":{
        "username":{
            "type":"string",
            "example":"adminuser"
        },
        "oldpwd":{
            "type":"string",
            "example":"admin123"
        },
        "newpwd":{
            "type":"string",
            "example":"admin456"
        },
        "confirmpwd":{
            "type":"string",
            "example":"admin456"
        },
        "timestamp":{
            "type":"string",
            "example":"MTYyNTUxNTc3Mg=="
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Result OK

Root Schema : schema

Type: object

401 Response

Not Logged into the SDWAN-Edge device

Root Schema : 401NotLoggedin

Type: object

Show Source

message: string

Example: Not logged in.
status: string

Example: fail

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "message":{
            "type":"string",
            "example":"Not logged in."
        }
    }
}

403 Response

Insufficient Userlevel

Root Schema : 403InsufficientUserLevel

Type: object

Show Source

message: string

Example: User Level for user <user_name> is not sufficient for this <URL value> operation.
required_user_level: string

Example: ADMIN
status: string

Example: fail
user_level: string

Example: GUEST
user_name: string

Example: username

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "user_name":{
            "type":"string",
            "example":"username"
        },
        "user_level":{
            "type":"string",
            "example":"GUEST"
        },
        "required_user_level":{
            "type":"string",
            "example":"ADMIN"
        },
        "message":{
            "type":"string",
            "example":"User Level for user <user_name> is not sufficient for this <URL value> operation."
        }
    }
}

405 Response

Invalid request method

Root Schema : 405ExpectedPost

Type: object

Show Source

message: string

Example: Operation must use a POST
status: string

Example: fail

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "example":"fail"
        },
        "message":{
            "type":"string",
            "example":"Operation must use a POST"
        }
    }
}

Examples

Example of Accessing the API with cURL

The following example shows how to change a local user password by submitting a POST request on the REST resource using cURL. If the request requires a timestamp, use the timestamp from the response of the /login API. For more information about cURL, see Use cURL.

curl -X POST \
    -b cookies.txt \
    -d@request.json \
    --header "Content-Type: application/json" \
    "https://$IPADDR/v1/admin/manage_appliance/users_Auth/changeLocalUserPwd"

The following shows an example of the contents of the request.json file sent as the request body.

{
  "username":"adminuser",
  "oldpwd":"admin123",
  "newpwd":"admin456",
  "confirmpwd":"admin456",
  "timestamp":<timestamp>
}

Example of the Response Body

The following example shows the contents of the response body in JSON format.

{
  "data": {
    "message": "Password Change Success - Your password has been changed.",
    "stay_logged_in": 0
  },
  "status": "success"
}