Get Home Site | VMware Horizon Server API

Get Home Site

Required Privileges : (This server version allows only Administrators on Root access group to login. These privileges are NOT relevant currently but will be applicable in later server versions.)

All the listed privileges are required -

Privileges	Description
FEDERATED_LDAP_VIEW	Global LDAP read privilege is required for Home Site Read.

Request

URI

GET

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

COPY

Path Parameters

string

Required

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns HomeSiteInfo of type(s) */*

{
    "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"
}

string

ad_user_or_group_id

Optional

SID of the user or group for whom this is the home site.
Supported Filters: 'Equals'.

string

global_application_entitlement_id

Optional

ID of the Global Application Entitlement for which this site is the overriding home site.
Supported Filters: 'Equals'.

string

global_desktop_entitlement_id

Optional

ID of the Global Desktop Entitlement for which this site is the overriding home site.
Supported Filters: 'Equals'.