Search Enterprise Users

Description

This operation searches users in the configured enterprise user store. You can narrow down the search using the filter parameter.

NoteNote:

This operation only works when an enterprise user store such as Windows domain or LDAP has been configured using the Update Identity Store operation. This operation does not search SAML identity providers.

Request Parameters

Parameter

Details

filter

An optional parameter to narrow the user search.

maxCount

The maximum number of records that the client is willing to accept.

f

The response format. The default response format is html.

Values: html | json

Example Usage

https://server.domain.com/gis/portaladmin/security/users/searchEnterpriseUsers
filter=john
maxCount=1000
f=json

JSON 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
}

10/6/2017