List Home Sites

List Home Sites

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 All the listed privileges are required -

Privileges	Description
FEDERATED_LDAP_VIEW	Returns only those home sites for which caller has permission to this privilege on associated federated access group of GAE/GDE.

Request

URI

GET

https://{api_host}/rest/federation/v1/home-sites

COPY

Query Parameters

integer

page

Optional

page, if passed should be > 0.

page example

integer

size

Optional

size, if passed should be > 0.

size example

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.

Bearer

Responses

200

OK

[
    {
        "ad_user_or_group_id": "S-1-5-32-551",
        "global_application_entitlement_id": "e285ebe1-194b-4563-80e0-0ad21134c503",
        "global_desktop_entitlement_id": "7493bfc7-834a-4d9b-ac7d-b5f60893a3a6",
        "id": "28deeb70-97d5-409e-abb4-497196f1ee18",
        "site_id": "32a5ea06-cd09-4609-b3e5-df8379e99c13"
    }
]

401

User is not authenticated

Operation doesn't return any data structure

403

Access to the resource is forbidden

Operation doesn't return any data structure

409

Conflict | CPA not initialized for the pod

Operation doesn't return any data structure

On This Page

Request

Query Parameters

200 Response Body

Errors

Federation Operations

Create Home Sites

Delete Home Sites

Get Pod Assignment

Get Pod Endpoint

Get Pod Federation

List Home Sites

List Pod Assignments

List Pod Endpoint

Resolve Home Sites

Rotate Key Pair

Uninitialize CPA

Update Pod Federation