Test Connection

Test Connection

Test the connection details specified for the instance.

Request
URI
POST
https://{api_host}/https://{{host}}:{{port}}/api/v5/rbac/settings/{instanceName}/test
COPY
Path Parameters
string
instanceName
Required

Instance name.

Request Body
TestDirectoryAccessSpec of type(s) application/json
Optional 
{
    "username": "string",
    "password": "string"
}
directorySpec
Optional

directorySpec

string
username
Required

The username to test authentication with in ldap server.

string As (^[^'"]{2,32}$)|(^ref:password:[a-zA-Z0-9]{20}$)
password
Required

The password to test authentication with in ldap server.

Responses
200

LDAP users.

Operation doesn't return any data structure

401

Unauthorized access

Operation doesn't return any data structure

404

Such resource was not found.

Operation doesn't return any data structure

504

Connection timed out.

Operation doesn't return any data structure

On This Page
Rbac Operations
POST
Add Ad Settings
POST
Add Ldap Settings
POST
Add New Group
POST
Add New User
POST
Create Role
DELETE
Delete Group For Instance
DELETE
Delete Ldap Settings
DELETE
Delete Role
DELETE
Delete User
GET
Get All Groups
GET
Get All Ldap Settings
GET
Get All Users
GET
Get All Users Per Instance
GET
Get Group
GET
Get Ldap Setting
GET
Get Ldap Settings
GET
Get Role
GET
Get Roles
GET
Get User
PUT
Modify Group Role
PUT
Modify User Role
POST
Query User
POST
Test Connection
PUT
Update Ldap Settings
PUT
Update Role