local_users

local_users

Configuration for Add, Delete, Modify or List Local Users through these APIs resource.

Read/write properties

password <String>

Password of the target user. Minimum length = 1 Maximum length = 256

user_level <String>

User level of the target user. Possible values = [admin,guest]

username <String>

Username of the target user. Minimum length = 1 Maximum length = 64

Read only properties

Operations

add delete get (all) modify

[add]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config/local_users

Description: Use this operation to add a local user

HTTP Method: POST

Request Payload: JSON

{"local_users": { "password":<String_value> , "user_level":<String_value> , "username":<String_value> }}

Response Payload: JSON

{ "local_users":{ "password":<String_value>

, "user_level":<String_value> , "username":<String_value> }]}

[delete]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config/local_users/username=<String>

Description: Use this operation to delete a local user

HTTP Method: DELETE

Response Payload: JSON

{ "errorcode": 0, "message": "Done", "severity": <String;_value> }

[get (all)]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config/local_users

Description: Use this operation to get a list of all local users

HTTP Method: GET

Response Payload: JSON

{"local_users":[{ "password":<String_value>

, "user_level":<String_value> , "username":<String_value> }]}

[modify]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config/local_users

Description: Use this operation to update a local user's password

HTTP Method: PUT

Request Payload: JSON

{"local_users":{ "password":<String_value> , "username":<String_value> }}

Response Payload: JSON

{ "local_users":[{ "password":<String_value>

, "username":<String_value> }]}

Was this article helpful?