Test Ldap Connection | Telco Cloud Service Assurance

Test Ldap Connection

This API can be used to test the connectivity as well as autheticity of the LDAP server.

Request

URI

POST

https://{api_host}/tcsa.host.com/tcsa/api/auth-management/v1/testLDAPConnection

COPY

Request Body

TestLDAPConRequest of type(s) application/json

Optional

Show optional properties

{
    "action": "string",
    "connectionUrl": "string",
    "authType": "string",
    "useTruststoreSpi": "string",
    "bindCredential": "string"
}

{
    "action": "string",
    "connectionUrl": "string",
    "authType": "string",
    "useTruststoreSpi": "string",
    "connectionTimeout": "number",
    "bindCredential": "string"
}

string

action

Required

testConnection performs simple connectivity test with the LDAP server, where testAuthentication is used for performing authetication test.

Possible values are : testConnection, testAuthentication,

string

connectionUrl

Required

LDAP server connection url.

string

authType

Required

Type of Authetication method used during ldap bind operation.

Possible values are : none, simple,

string

useTruststoreSpi

Required

Specified wheather LDAP connection will use the truststore SPI with the truststore configured in standalone.xml/domain.xml. Always means it will always use it, never means it will not use it, and only for LDAP means, it will use it, if connection url uses ldap.

Possible values are : ldapsOnly, always, never,

number

connectionTimeout

Optional

LDAP connection timeout in milli seconds.

string

bindCredential

Required

Password of LDAP admin.

Authentication

This operation uses the following authentication methods.

bearerAuth