Test Ldap Connection

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/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.
Responses
204

Successful

Operation doesn't return any data structure

404

Cannot find requested resource

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"action:"string","connectionUrl:"string","authType:"string","useTruststoreSpi:"string","bindCredential:"string"}' https://{api_host}/tcsa/api/auth-management/v1/testLDAPConnection
On This Page
User Federation Operations
POST
Configure User Federation
Deprecated
GET
Get All User Federation
Deprecated
GET
Get User Federation
Deprecated
DELETE
Delete User Federation
Deprecated
PUT
Update User Federation
Deprecated
PATCH
Patch User Federation
Deprecated
POST
Test Ldap Connection
GET
Get All User Federation Configuration
POST
Create User Federation Configuration
GET
Get User Federation Configuration
DELETE
Delete User Federation Configuration
PUT
Update User Federation Configuration
POST
Sync User Federation
POST
Remove Imported Users
POST
Unlink Users