Skip to content

local_users

Overview

Add, Delete, Modify or List Local Users through these APIs

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/config/
Schemes : HTTP

Tags

  • local_users : Operations related to local_users

Paths

POST operation for local_users

POST /local_users

Description

Use this operation to add a local user

Responses

HTTP Code Description Schema
200 Resource successfully added local_users_post_success_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • local_users

Get operation for local_users

GET /local_users

Description

Use this operation to get a list of all local users

Responses

HTTP Code Description Schema
200 API Successfully executed local_users_response_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • local_users

PUT operation for local_users

PUT /local_users

Description

Use this operation to update a local user's password

Parameters

Type Name Schema
Body body
optional
local_users_request_schema

Responses

HTTP Code Description Schema
200 Resource modified added local_users_put_success_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Consumes

  • application/json

Produces

  • application/json

Tags

  • local_users

DELETE operation for local_users

DELETE /local_users/{deletePathParam}

Description

Use this operation to delete a local user

Parameters

Type Name Description Schema
Path deletePathParam
required
Object Primary Key for DELETE operation object

Responses

HTTP Code Description Schema
200 Resource delete added local_users_delete_success_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • local_users

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

local_users

Name Schema
password
optional
password
user_level
optional
user_level
username
optional
username

local_users_delete_success_schema

Name Schema
local_users
optional
local_users

local_users

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

local_users_post_success_schema

Name Schema
local_users
optional
local_users

local_users

Name Description Schema
message
optional
Example : "resource added succesfully" string

local_users_put_success_schema

Name Schema
local_users
optional
local_users

local_users

Name Description Schema
message
optional
Example : "resource modified succesfully" string

local_users_request_schema

Name Schema
local_users
optional
local_users

local_users_response_schema

Type : < local_users_response_schema > array

local_users_response_schema

Name Schema
password
optional
password
user_level
optional
user_level
username
optional
username

password

Password of the target user

Type : string

user_level

User level of the target user

Type : enum (admin, guest)

username

Username of the target user

Type : string