Search for Active Directory users

{ searchAdUsers }

Find users on the Active Directory.

Method

/API2/access/searchAdUsers
  • API Section: /API2/access
  • API Version: 2.0
  • From Release: 2018.5
  • Can be used by Enterprise Admin users only
  • REST API only via POST actions.
  • Input Parameters

    Name

    ldapUsersSearch

    Object Type

    Description

    The LDAP search object used to find users in the LDAP directory.

    Output Response

    Successful Result Code

    200

    Response List Type

    Description of Response Type

    LDAP response object with details of each user found in the search.. Note that the response is returned as a list of items of this object type.

    Notes

    Use this function with Active Directory Authentication provider. Build the search object to define the search parameters.

    Examples