List AD User Or Group Summary

List AD User Or Group Summary

This API supports Pagination and Filters.
For full information on using Filters, refer to 'Horizon Server REST Pagination and Filter Guide' of 'VMware Horizon Server API' in code.vmware.com

Request
URI
GET
https://{api_host}/rest/external/v1/ad-users-or-groups
COPY
Query Parameters
boolean
group_only
Optional

Presence of this query param indicates to filter only groups or only users. If passed as "true", then only groups are returned. If passed as "false", then only users are returned. If not passed passed at all, then both types are returned.

integer
page
Optional

page, if passed should be > 0.

page example
1
integer
size
Optional

size, if passed should be > 0.

size example
10
string
filter
Optional

filter expression built using fields with 'supported filters' as described in output model schema of this API.

filter example
[object Object]

Authentication
This operation uses the following authentication methods.
Responses
200

OK

[
    {
        "container": "example.com/Users",
        "description": "Test User account",
        "display_name": "example.com\\\\testuser",
        "distinguished_name": "CN=Test User,CN=Users,DC=example,DC=com",
        "domain": "example.com",
        "email": "testuser@example.com",
        "first_name": "Test",
        "group": false,
        "guid": "5F5A45D9-15C0-4654-8FCF-D589C0EF3ECA",
        "id": "S-1-5-21-1111111111-2222222222-3333333333-500",
        "kiosk_user": false,
        "last_name": "User",
        "login_name": "testuser",
        "long_display_name": "testuser@example.com (Test User)",
        "name": "Test User",
        "phone": "1-877-486-9273",
        "user_display_name": "Test User",
        "user_principal_name": "testuser@example.com"
    }
]

400

Bad Request

Operation doesn't return any data structure

401

User is not authenticated

Operation doesn't return any data structure