System Administration >
Settings
>
User Management
>
LDAP Identity Sources
Search the LDAP identity source
Search the LDAP identity source for users and groups that match the given filter_value. In most cases, the LDAP source performs a case-insensitive search.
Request:
Method:
POST
URI Path(s):
/api/v1/aaa/ldap-identity-sources/<ldap-identity-source-id>/search
Request Headers:
n/a
Query Parameters:
LdapIdentitySourceSearchRequestParameters
+
LdapIdentitySourceSearchRequestParameters
(
schema
)
Name
Description
Type
Notes
filter_value
Search filter value
A string to use when searching for groups in the LDAP identity source. If not provided, all groups are returned.
string
Request Body:
n/a
Example Request:
POST /policy/api/v1/aaa/ldap-identity-sources/airius.com/search?filter_value=john
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
LdapIdentitySourceSearchResultList
+
LdapIdentitySourceSearchResultList
(
schema
)
Name
Description
Type
Notes
_links
References related to this resource
The server will populate this field when returing the resource. Ignored on PUT and POST.
array of
ResourceLink
Readonly
_schema
Schema for this resource
string
Readonly
_self
Link to this resource
SelfResourceLink
Readonly
results
array of
LdapIdentitySourceSearchResultItem
Example Response:
{ "results": [ { "dn": "CN=Johnson Building Administrators,DC=airius,DC=com", "type": "GROUP", "common_name": "Johnson Building Administrators", "principal_name": "Johnson Building Administrators@airius.com" }, { "dn": "CN=John Jensen,CN=Users,DC=airius,DC=com", "type": "USER", "common_name": "John Jensen", "principal_name": "jjensen@airius.com" }, { "dn":"CN=Ellen Johnson,CN=Users,DC=airius,DC=com" "type": "USER" "common_name": "Ellen Johnson", "principal_name": "ellenj@airius.com" } ] }
Required Permissions:
crud
Feature:
users_configuration
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
500 Internal Server Error
503 Service Unavailable