Create Global Application Entitlement V4

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

POST

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

COPY

Request Body

GlobalApplicationEntitlementCreateSpecV3 of type(s) application/json

Required

{
    "allow_users_to_choose_machines": false,
    "allow_users_to_choose_protocol": true,
    "app_launch_limit_enabled": false,
    "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",
    "session_distribution_policy": "NONE",
    "shortcut_locations_v2": [
        "DESKTOP"
    ],
    "use_home_site": false
}

boolean

allow_users_to_choose_machines

Optional

Indicates whether the users can specify the machine for session launch.Default value is false.

boolean

allow_users_to_choose_protocol

Optional

Indicates whether the users can choose the protocol used. Default value is true.

boolean

app_launch_limit_enabled

Optional

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

string As ^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\].*|PRN[\\].*|AUX[\\].*|NUL[\\].*|COM[1-9][\\].*|LPT[1-9][\\].*)$)(?!(?:.*[\\]CON|.*[\\]PRN|.*[\\]AUX|.*[\\]NUL|.*[\\]COM[1-9]|.*[\\]LPT[1-9])$)(?!(?:.*[\\]CON[\\].*|.*[\\]PRN[\\].*|.*[\\]AUX[\\].*|.*[\\]NUL[\\].*|.*[\\]COM[1-9][\\].*|.*[\\]LPT[1-9][\\].*)$))([^\"#$%&'()*+,.\\\/:;<=>?@^`{|}~]{1,64}\\){0,3}([^\"#$%&'()*+,.\\\/:;<=>?@^`{|}~]{1,64})$|^/$

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

Optional

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. Default value is "PCOIP".

BLAST: BLAST protocol.
PCOIP: PCoIP protocol.

Possible values are : BLAST, PCOIP,

string

description

Optional

Description of global application entitlement.

string

display_name

Optional

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

Optional

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

boolean

enable_pre_launch

Optional

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". Default value is false.

boolean

enabled

Optional

Indicates whether the global application entitlement is enabled. Default value is true.

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

Optional

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. Default value is "DISABLED"

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 whether automatic session clean up is enabled. Default value is false.

string

name

Required

Unique name used to identify the global application entitlement.

boolean

require_home_site

Optional

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. Default value is false.

string

scope

Optional

Scope for this global application entitlement. Visibility and Placement policies are defined by this value. Default value of "ALL_SITES".

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 desktop. This property is required if category_folder_name is set.

Possible values are : START_MENU, DESKTOP,

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. Default value is false.

Authentication

This operation uses the following authentication methods.