- URL:
- https://<root>/security/users/searchEnterpriseUsers
- Methods:
POST- Version Introduced:
- 10.3
Access requirements
Required privileges
The Portal Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Portal Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.
Description
The search operation searches users in the configured enterprise user store. You can narrow down the search using the filter parameter.
Request parameters
| Parameter | Details |
|---|---|
| An optional parameter to narrow the user search. Example |
| The maximum number of records that the client is willing to accept. Example |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the search operation:
POST /<context>/portaladmin/security/users/searchEnterpriseUsers HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
filter=john&maxCount=1000&f=jsonJSON Response syntax
{
"users": [
{
"username": "<username>",
"description": "<description>",
"fullname": "<fullname>",
"email": "<email>"
},
...
]
"hasMore": <true|false>
}JSON Response example
{
"users": [
{
"username": "domain\\jdoe0001",
"description": "CN=jdoe,OU=Users,OU=Support Group,OU=Departments,DC=domain,DC=com",
"fullname": "John Doe",
"email": "jdoe@domain.com"
},
{
"username": "DOMAIN\\aturing",
"description": "Software Product Development",
"fullname": "Alan Turing",
"email": "aturing@email.com"
}
],
"hasMore": false
}