List Global Application Entitlements

Note: CPA must be initialized for the pod for invoking this API.
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

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	Caller should have permission to this privilege to read the global application entitlement.

Request

URI

GET

https://{api_host}//localhost/rest/inventory/v1/global-application-entitlements

COPY

Query Parameters

string

filter

Optional

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

filter example

{"type":"And", "filters":[{"type":"Equals", "name":"<>", "value":"<>"}] }

integer

page

Optional

page, if passed should be > 0.

page example

integer

size

Optional

size, if passed should be > 0

size example

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

[
    {
        "allow_users_to_choose_protocol": true,
        "backup_gae_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
        "category_folder_name": "dir1\\dir2\\dir3\\dir4",
        "cs_restriction_tags": [
            "Internal",
            "External"
        ],
        "default_display_protocol": "string",
        "description": "global application entitlement description",
        "display_name": "global-application-entitlement",
        "enable_client_restrictions": false,
        "enable_pre_launch": true,
        "enabled": true,
        "id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
        "multi_session_mode": "ENABLED_ENFORCED",
        "multiple_session_auto_clean": false,
        "name": "global-application-entitlement",
        "primary_gae_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
        "require_home_site": false,
        "scope": "ALL_SITES",
        "shortcut_locations": [
            "desktop"
        ],
        "supported_display_protocols": [
            "PCOIP",
            "BLAST"
        ],
        "use_home_site": false
    }
]

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

Description

Request