Get Global Application Entitlement V3

Note: CPA must be initialized for the pod for invoking this API.
All the listed privileges are required -

Privileges	Description
FEDERATED_LDAP_VIEW	Caller should have permission to this privilege, on the associated federated access group to read the global application entitlement.

Request

URI

GET

https://{api_host}/rest/inventory/v3/global-application-entitlements/{id}

COPY

Path Parameters

string

Required

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns GlobalApplicationEntitlementInfoV3 of type(s) */*

{
    "allow_users_to_choose_protocol": true,
    "app_launch_limit_enabled": false,
    "application_data": {
        "executable_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk",
        "publisher": "Mozilla Corporation",
        "version": "72.0.2"
    },
    "application_icon_ids": [
        "98923489-102b-4ed3-953f-3dfe3d23e0fe",
        "asa39i-102b-4ed3-953f-3d23esan0fe"
    ],
    "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,
    "federated_access_group_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
    "group_count": 5,
    "id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
    "local_application_pools_count": 2,
    "member_pods": [
        "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
        "9238c-102b-4ed3-953f-3d23esan0fe"
    ],
    "multi_session_mode": "ENABLED_ENFORCED",
    "multiple_session_auto_clean": false,
    "name": "global-application-entitlement",
    "primary_gae_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
    "remote_application_pools_count": 10,
    "require_home_site": false,
    "scope": "ALL_SITES",
    "session_distribution_policy": "NONE",
    "shortcut_locations_v2": [
        "DESKTOP"
    ],
    "supported_display_protocols": [
        "PCOIP",
        "BLAST"
    ],
    "use_home_site": false,
    "user_count": 5,
    "user_or_group_site_override_count": 2
}

boolean

allow_users_to_choose_protocol

Optional

Indicates whether the users can choose the protocol used. If set to true, the application pools that are associated with this Global Application Entitlement must also allow users to choose display protocol with allowUsersToChooseProtocol. Supported Filters: 'Equals'. This property can be used for sorting.

boolean

app_launch_limit_enabled

Optional

Indicates whether application launch limit is enabled for the global application entitlement. Default value is false.

ApplicationData

application_data

Optional

application_data

array of string

application_icon_ids

Optional

Icons associated with the Global Application Entitlement

string

backup_gae_id

Optional

Indicates the Global Application Entitlement that can be used as backup for this Global Application Entitlement. Supported Filters: 'Equals'.

string

category_folder_name

Optional

Name of the category folder in the user's OS containing a shortcut to the entitlement. Unset if the entitlement does not belong to a category. This property can be used for sorting.

array of string

cs_restriction_tags

Optional

Connection server restrictions. This is a list of tags that access to the entitlement is restricted to. No list means that the entitlement can be accessed from any connection server.

string

default_display_protocol

Optional

The default display protocol for the Global Application Entitlement. Must be a protocol in the supportedDisplayProtocols list. Clients connecting through this Global Application Entitlement that do not specify a protocol will use this value, not the value specified directly on the application pool to which they connect (if different). Supported Filters: 'Equals'. This property can be used for sorting.

BLAST: BLAST protocol.
PCOIP: PCoIP protocol.

Possible values are : BLAST, PCOIP,

string

description

Optional

Description of Global Application Entitlement. This property has a maximum length of 1024 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.

string

display_name

Optional

Name that users will see when they connect using Horizon Client. If the display name is left blank, while creating or updating the Global Application Entitlement display name value will be same as name. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.

boolean

enable_client_restrictions

Optional

Indicates whether client restrictions to be applied to Global Application Entitlement. Currently it is valid for RDSH pools. Supported Filters: 'Equals'. This property can be used for sorting.

boolean

enable_pre_launch

Optional

Indicates whether Global Application Entitlement can be pre-launched Supported Filters: 'Equals'. This property can be used for sorting.

boolean

enabled

Optional

Indicates if this Global Application Entitlement is enabled. Supported Filters: 'Equals'. This property can be used for sorting.

string

federated_access_group_id

Optional

This represents id of the federated access group associated with the global application entitlement.

integer As int32 As int32

group_count

Optional

Count of groups that are associated with this Global Application Entitlement.

string

Optional

Unique ID representing this Global Application Entitlement. Supported Filters: 'Equals'.

integer As int32 As int32

local_application_pools_count

Optional

Count of application pools local to this pod that are associated with this Global Application Entitlement.

array of string

member_pods

Optional

Pods that have application pools associated with this Global Application Entitlement.

string

multi_session_mode

Optional

Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled. Supported Filters: 'Equals'. This property can be used for sorting.

DISABLED: Multi-session is not supported for this application.
ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.
ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.
ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.

Possible values are : DISABLED, ENABLED_DEFAULT_OFF, ENABLED_DEFAULT_ON, ENABLED_ENFORCED,

boolean

multiple_session_auto_clean

Optional

Indicates if automatic session clean up is enabled. This cannot be enabled when this Global Application Entitlement is associated with a Application pool that has dedicated user assignment. Supported Filters: 'Equals'. This property can be used for sorting.

string

name

Optional

Unique name used to identify the Global Application Entitlement. This property has a maximum length of 64 characters. Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.

string

primary_gae_id

Optional

Indicates the Global Application Entitlement for which this Global Application Entitlement acts as backup.

integer As int32 As int32

remote_application_pools_count

Optional

Count of application pools on remote pods that are associated with this Global Application Entitlement.

boolean

require_home_site

Optional

Indicates whether we fail if a home site isn't defined for this Global Application Entitlement. Supported Filters: 'Equals'. This property can be used for sorting.

string

scope

Optional

Scope for this global application entitlement. Visibility and Placement policies are defined by this value. Supported Filters: 'Equals'. This property can be used for sorting.

ALL_SITES: All Sites Policy: Any pod can be used for this action. If this policy is for visibility, search for existing session will span all pods in LMV set. If this policy is for placement, session can be placed on any pod in LMV set.
WITHIN_POD: Within POD Policy: Local pod will be used for this policy. If this policy is for visibility, search for existing session will happen only in local pod. If this policy is for placement, session will always be placed on local pod.
WITHIN_SITE: Within Site Policy: Site will be used for this policy. If this policy is for visibility, search for existing session will happen only from site. If this policy is for placement, session will be placed on site.

Possible values are : ALL_SITES, WITHIN_POD, WITHIN_SITE,

string

session_distribution_policy

Optional

Session distribution policy to be used for this global application entitlement

LOAD: Load index based load distribution.
NONE: Default load distribution to find the nearest resource based on home-site and connecting pod/site. If not found, find from any random pod.
SESSION: Session count based load distribution.

Possible values are : LOAD, NONE, SESSION,

array of string

shortcut_locations_v2

Optional

Locations of the category folder in the user's OS containing a shortcut to the application.

Possible values are : START_MENU, DESKTOP,

array of string

supported_display_protocols

Optional

The set of supported display protocols for the Global Application Entitlement. All the application pools associated with this Global Application Entitlement must support these protocols supportedDisplayProtocols . Clients connecting through this Global Application Entitlement that are allowed to select their protocol will see these display protocol options.

Possible values are : BLAST, PCOIP,

boolean

use_home_site

Optional

Indicates whether a pod in the user's home site is used to start the search or the current site is used. Supported Filters: 'Equals'. This property can be used for sorting.

integer As int32 As int32

user_count

Optional

Count of users that are associated with this Global Application Entitlement.

integer As int32 As int32

user_or_group_site_override_count

Optional

Count of all User Home Site overrides associated with this Global Application Entitlement (for either users or groups).

401

User is not authenticated

Operation doesn't return any data structure

403