Access Credentials

Description	Manipulate Access Credentials Data (fetch, add, update, or delete). Available protocols to update are: SSH, HTTP, SNMP, and SNMPv3. Users can update credentials data for two objects: Systems and Groups.
Request URL	/neo/app/settings/device_access
Main Operations	Add New Credentials Update Credentials Delete Credentials Get Credentials: All Protocols for a specified object Specified protocol for a specified object

Add New Credentials

Description	Adds new credentials data, either for systems or for custom groups in NEO
Request URL	POST /neo/app/settings/device_access
Response	HTTP Response location header will contain URI with Job ID created for adding new credentials: /neo/app/jobs/<job_ID>
Status Codes	Note: status code 409 CONFLICT, means that Access Credentials already exist for the specified object.

Request Data:

Copy
Copied!

            
            { 
 "object":"<system_ip>.system", 
 "protocol":"http", 
 "username":"custom1", 
 "password":"custom_pass" 
 }

Update Credentials

Description	Updates existing credentials data, either for systems or for groups (custom groups or global groups) in NEO
Request URL	PUT /neo/app/settings/device_access
Response	HTTP Response location header will contain URI with Job ID created for updating access credentials: /neo/app/jobs/<job_ID>

Request Data:

Copy
Copied!

            
            { 
 "object":"<system_ip>.system", 
 "protocol":"<protocol_name>", 
 "username":"custom1", 
 "password":"custom_pass" 
 }

Delete Credentials

Description	Deletes existing credentials data, either for systems or for groups (custom groups or global groups) in NEO
Request URL	DELETE /neo/app/settings/device_access/<object_name>/<protocol> Example: DELETE /neo/app/settings/device_access/10.0.0.1.system/ssh
Request Data	N/A
Response	HTTP Response location header will contain URI with Job ID created for removing access credentials: /neo/app/jobs/<job_ID>

Get Credentials (All Protocols for Specified Object)

Description	Retrieves credentials data for all protocols, either for a system or for a group (custom groups or global groups) in NEO
Request URL	GET /neo/app/settings/device_access/<object_name>
Request Data	N/A

Description

Retrieves credentials data for all protocols, either for a system or for a group (custom groups or global groups) in NEO

Request URL

GET /neo/app/settings/device_access/<object_name>

Request Data

N/A

Response:

Copy
Copied!

            
            {
	"snmp": {
		"readCommunity": "public", 
		"inherited": "group.global.mlnx_os"
	},
	"http": {
		"username": "example", "password": "12345",
		"inherited": "group.global.mlnx_os"
	},
	"ssh": {
		"username": "test",
		"password": "12345",
		"inherited": "group.global.mlnx_os"
	},
	"snmpv3": {
		"username": "admin", 
		"authAlgorithm": "md5", 
		"context": "",
		"inherited": "group.global.mlnx_os", 
		"privPassword": "",
		"authPassword": "", 
		"privAlgorithm": "des"
	}
}

Get Credentials (Specified Protocols for Specified Object)

Description	Retrieves credentials data for specified protocols either for a system or for a group (custom groups or global groups) in NEO
Request URL	GET /neo/app/settings/device_access/<object_name>/<list_of_protocols> list_of_protocols: supported protocol names separated by commas, supported protocols are: ssh, http, snmp and snmpv3. Example: GET /neo/app/settings/device_access/group.global.mlnx_os/ssh
Request Data	N/A
Status Codes	Note: status request 400 BAD REQUEST means that protocol specified is not supported