Skip to content

Test a directory connection

Request

Early Access

Tests the connection to the offline mode directory for the specified identity provider (IdP) by idpId.

This endpoint connects to the node that is running the authentication service to perform the test and then a successful test returns an HTTP 204 No Content response. Use this endpoint to verify if the offline mode directory is properly configured and can be connected successfully.

Path
idpIdstring, (uuid)required

Identifier of the IdP

Bodyapplication/jsonrequired
bindCredentialstringwrite-onlyrequired

The bind credential (password) for the directory server of the IdP

bindDnstringwrite-onlyrequired

The bind distinguished name (DN) for the directory server of the IdP

connectionUrlstringwrite-onlyrequired

The connection URL for the directory server of the IdP

curl -i -X POST \
  'https://oag.domain.tld/api/v2/idps/{idpId}/offline-mode/test-directory-connection' \
  -H 'Content-Type: application/json' \
  -d '{
    "connectionUrl": "ldap://ldap.domain.tld:389",
    "bindDn": "cn=admin,dc=domain,dc=tld",
    "bindCredential": "<bind-credential>"
  }'

Responses

Connection test successful

Response
No content