You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
Version 1
Current »
Authentication Testing
testSSH |
|---|
| URL | /api/v1/api.php?target=auth&action=testSSH |
| Description | Returns success or failure of a connection to an external server via SSH. |
| Returns | Examples: | SUCCESSFUL | {"success":1,"message":"Success!"} | | ERROR | {'success':0, 'message':'error message'} |
|
| Required Parameters | | | | |
|---|
| SSHServer | STRING | totally.awesome.com | IP or FQDN of server. | | SSHPort | NUMBER | 22 | Port ssh is running on. |
|
| Optional Parameters | | | | |
|---|
| username | STRING | jsmith | Username on target server. | | password | STRING | password123 | Password for user. | | directory | STRING | /tmp | Directory to attempt to access after successful login. | | | | | |
|
| Example URL | /api/v1/api.php?target=auth&action=testSSH&username=jsmith&password=password123&directory=%2Fvar%2Fnamed%2F6connect%2Fqa4&SSHPort=22&SSHServer=myssh.awesome.com |
testLDAP |
|---|
| URL | /api/v1/api.php?target=auth&action=testLDAP |
| Description | Test basic connectivity to an LDAP server. Does not test actual authenticaion against server. |
| Returns | Examples:
SUCCESSFUL: {'success':1, 'id':'12345'}
ERROR: {'success':0, 'message':'unable to add block'}> |
| Required Parameters | | | | |
|---|
| ldapServer | STRING | ldap.awesome.com | IP or FQDN of the LDAP server. | | ldapPort | NUMBER | 389 | User-defined block code as defined in Admin-IPAM settings: Generic Code Per Block Name | | ldapMode | STRING | SSL | Options are: SSL, TLS, or None. |
|
| Optional Parameters | None |
| Example URL | /api/v1/api.php?target=auth&action=testLDAP&ldapPort=389&ldapServer=ldap.awesome.com&ldapMode=None |
testSecure64 |
|---|
| URL | /api/v1/api.php?target=auth&action=testSecure64 |
| Description | Returns success or failure of a connection to an Secure64 DNS appliance. |
| Returns | Examples: | SUCCESSFUL | {"success":1,"message":"Success!"} | | ERROR | {'success':0, 'message':'error message'} |
|
| Required Parameters | | | | |
|---|
| SSHServer | STRING | totally.awesome.com | IP or FQDN of server. | | SSHPort | NUMBER | 22 | Port ssh is running on. |
|
| Optional Parameters | | | | |
|---|
| username | STRING | jsmith | Username on target server. | | password | STRING | password123 | Password for user. | | directory | STRING | /tmp | Directory to attempt to access after successful login. | | | | | |
|
| Example URL | /api/v1/api.php?target=auth&action=testSecure64&username=jsmith&password=password123&directory=%2Fvar%2Fnamed%2F6connect%2Fqa4&SSHPort=22 |
