Update Global Application Entitlement

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

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

Request

URI

PUT

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

COPY

Path Parameters

string

Required

Global Application Entitlement object to be updated

id example

5134796a-322g-5fe5-343f-4daa5d25ebfe

Request Body

Global Application Entitlement object to be updated.

GlobalApplicationEntitlementUpdateSpec of type(s) application/json

Required

{
    "backup_gae_id": "0104abcdc-102b-4ed3-953f-3dfe3d23e0fe",
    "category_folder_name": "dir1\\dir2\\dir3\\dir4",
    "cs_restriction_tags": [
        "Internal",
        "External"
    ],
    "default_display_protocol": "PCOIP",
    "description": "global application entitlement description",
    "display_name": "global-application-entitlement",
    "enable_client_restrictions": false,
    "enable_pre_launch": false,
    "enabled": true,
    "federated_access_group_id": "310927ee-1195-44c3-b877-5b194b4b4ea8",
    "multi_session_mode": "ENABLED_ENFORCED",
    "multiple_session_auto_clean": true,
    "name": "global-application-entitlement",
    "require_home_site": false,
    "scope": "ALL_SITES",
    "shortcut_locations_v2": [
        "DESKTOP"
    ],
    "use_home_site": false
}

string

backup_gae_id

Optional

Global Application Entitlement that can be used as backup for this Global Application Entitlement.

string

category_folder_name

Optional

Name of the category folder in the user's OS containing a shortcut to the entitlement. The property will not be set if the entitlement does not belong to a category.

array of string

cs_restriction_tags

Optional

List of connection server restriction tags to which the access to the global application entitlement is restricted. Empty or null list means that entitlement can be accessed from any connection server.

string

default_display_protocol

Required

The default display protocol for the global application entitlement. This can only be set to "PCOIP" or "BLAST". If this application's Farm's or desktop pool's allow_users_to_choose_protocol is set to false, then default_display_protocol must match that default_display_protocol of farm or desktop pool.

PCOIP: PCoIP protocol.
BLAST: BLAST protocol.

Possible values are : PCOIP, BLAST,

string

description

Optional

Description of global application entitlement.

string

display_name

Required

The display name is the name that users will see when they connect using Horizon View Client. If display_name is left blank, it defaults to name.

boolean

enable_client_restrictions

Required

Indicates whether client restrictions to be applied to global application entitlement, currently it is valid for published application pools.

boolean

enable_pre_launch

Required

If value is set to true, this global application entitlement can be pre-launched. This property can be set to true only if multi_session_mode is set to "DISABLED".

boolean

enabled

Required

Indicates whether the global application entitlement is enabled.

string

federated_access_group_id

Required

ID of the federated access group with which the global application entitlement is to be associated. They can also be used for delegated administration.

string

multi_session_mode

Required

Multi-session mode for this entitlement. A global application entitlement launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance.

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

Required

Indicates whether automatic session clean up is enabled.

string

name

Required

Unique name used to identify the global application entitlement.

boolean

require_home_site

Required

Indicates whether it should fail if a home site isn't defined for this global application entitlement. This property cannot be set to true if use_home_site is set to false.

string

scope

Required

Scope for this global application entitlement. Visibility and Placement policies are defined by this value.

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.
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.

Possible values are : WITHIN_POD, WITHIN_SITE, ALL_SITES,

array of string

shortcut_locations_v2

Optional

Locations of the category folder in the user's OS containing a shortcut to the desktop. This property is required if category_folder_name is set.

Possible values are : START_MENU, DESKTOP,

boolean

use_home_site

Required

Indicates whether a pod in the user's home site is used to start the search or the current site is used.

Authentication

This operation uses the following authentication methods.