Skip to main content
Element Software

TestLdapAuthentication

Contributors netapp-pcarriga
PDFs

You can use the TestLdapAuthentication method to validate the currently enabled LDAP authentication settings. If the configuration is correct, the API call returns the group membership of the tested user.

Parameters

This method has the following input parameters:

Name Description Type Default value Required

username

The username to be tested.

string

None

Yes

password

The password for the username to be tested.

string

None

Yes

ldapConfiguration

An ldapConfiguration object to be tested. If you provide this parameter, the system tests the provided configuration even if LDAP authentication is currently disabled.

ldapConfiguration

None

No

Return values

This method has the following return values:

Name Description Type

groups

List of LDAP groups that include the tested user as a member.

array

userDN

The tested user's full LDAP distinguished name.

string

Request example

Requests for this method are similar to the following example:

{
"method": "TestLdapAuthentication",
"params": {"username":"admin1",
           "password":"admin1PASS"
      },
  "id": 1
}

Response example

This method returns a response similar to the following example:

{
 "id": 1,
 "result": {
    "groups": [
        "CN=StorageMgmt,OU=PTUsers,DC=prodtest,DC=solidfire,DC=net"
      ],
        "userDN": "CN=Admin1 Jones,OU=PTUsers,DC=prodtest,DC=solidfire,DC=net"
  }
}

New since version

9.6