NVIDIA NEO REST API Guide v2.7.20
NVIDIA NEO REST API Guide v2.7.20

Users

Description

Manipulates users data in NEO

Request URL

/neo/app/users

Main Operations

  • Add User

  • Update User

  • Get All Users

  • Get User

  • Delete User

Description

Adds users to NEO

Request URL

POST /neo/app/users

Request Data

{ 

"username":"test_user",

"password":"123456",

"role":"user"

}

Response

N/A

Warning

There are two different types of users that can be added: admin user and normal user.

Description

Updates password for an existing user in NEO requires an old_password attribute

Request URL

PUT /neo/app/users/<user_name>

Response

""

Request Data

{ 

"password":"new password",

"old_password":"old password"

}

Warning

The attributes that can be updated are: password and role.

Description

Retrieves all user data in NEO

Request URL

GET /neo/app/users

Request Data

N/A

Response:

Copy
Copied!
            

[ { "username": "admin", "role": "administrator" }, { "username": "test_user1", "role": "user" }, … ]

Description

Retrieves data for a specific user in NEO

Request URL

GET /neo/app/users/<user_name>

Request Data

N/A

Response:

Copy
Copied!
            

[ { "username": "<user_name>", "role": "<user_role>" } ]

Warning

Data retrieved will not contain the password.

Description

Removes a user from NEO

Request URL

DELETE /neo/app/users/<user_name>

Request Data

N/A

Response

N/A

Status Codes

Note:

For status code 204 NO CONTENT, the operation was deleted successfully

For status code 403 FORBIDDEN, meant that the specified user is "admin"

Response:

Warning

Default user "admin" cannot be removed.

© Copyright 2023, NVIDIA. Last updated on Nov 16, 2023.