Create Global Application Entitlement V4

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

Created

Operation doesn't return any data structure

400

Bad Request

Operation doesn't return any data structure

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

404

Not Found

Operation doesn't return any data structure

409

Conflict | CPA not initialized for the pod

Operation doesn't return any data structure

Inventory Operations
POST
Add Custom Icon
POST
Add Local Application Pools To GAE
POST
Add Local Desktop Pools To GDE
POST
Add Machines
POST
Add Machines By Name
POST
Add Rds Servers
POST
Application Icon Bulk Associate
POST
Application Icon Bulk Remove Association
POST
Archive Machines
POST
Assign Machine Aliases
POST
Assign Users
POST
Attach Persistent Disk
POST
Cancel Agent Upgrades
POST
Cancel Desktop Pool Task
POST
Cancel Rds Server Agent Upgrades
POST
Cancel Scheduled Maintenance
POST
Cancel Scheduled Push Image
POST
Check Application Pool Name Availability
POST
Check Desktop Pool Name Availability
POST
Check Farm Name Availability
POST
Check Machine Prefix Availability
POST
Check RDS Server Prefix Availability
POST
Create Application Icon
POST
Create Application Pool
POST
Create Application Pool V2
POST
Create Application Pool V3
POST
Create Application Pool V5
POST
Create Application Pool V6
POST
Create Desktop Pool
POST
Create Desktop Pool V2
POST
Create Desktop Pool V7
POST
Create Desktop Pool V8
POST
Create Farm
POST
Create Farm V2
POST
Create Farm V3
POST
Create Farm V6
POST
Create Farm V7
POST
Create Global Application Entitlement
POST
Create Global Application Entitlement V3
POST
Create Global Application Entitlement V4
POST
Create Global Desktop Entitlement
POST
Create Global Desktop Entitlement V2
POST
Create Global Desktop Entitlement V3
POST
Create Global Desktop Entitlement V4
POST
Create Persistent Disk
POST
Create Policy Overrides For Users
DELETE
Delete Application Icon
DELETE
Delete Application Pool
DELETE
Delete Application Pools
DELETE
Delete Application Pools V5
DELETE
Delete Application Pools V6
DELETE
Delete Desktop Pool
DELETE
Delete Desktop Pool V7
DELETE
Delete Desktop Pool V8
DELETE
Delete Farm
DELETE
Delete Farm V6
DELETE
Delete Farm V7
DELETE
Delete Global Application Entitlement
DELETE
Delete Global Application Entitlement V3
DELETE
Delete Global Application Entitlement V4
DELETE
Delete Global Desktop Entitlement
DELETE
Delete Global Desktop Entitlement V3
DELETE
Delete Global Desktop Entitlement V4
DELETE
Delete Machine
DELETE
Delete Machines
DELETE
Delete Persistent Disk
DELETE
Delete Physical Machine
DELETE
Delete Policy Overrides For Users
DELETE
Delete RDS Server
DELETE
Delete RDS Server V2
POST
Desktop Pool Apply Image
POST
Desktop Pool Promote Pending Image
POST
Detach Persistent Disk
POST
Disable Application Pools
POST
Disable Desktop Pools
POST
Disable Provisioning For Desktop Pools
POST
Disconnect Global Sessions
POST
Disconnect Sessions
POST
Enable Application Pools
POST
Enable Desktop Pools
POST
Enable Provisioning For Desktop Pools
POST
Enter Maintenance
POST
Exit Maintenance
POST
Farm Apply Image
POST
Farm Promote Pending Image
GET
Get Agent Installer Package
GET
Get Agent Upgrade Task
GET
Get Agent Upgrade Task V2
GET
Get Application Icon
GET
Get Application Pool
GET
Get Application Pool V2
GET
Get Application Pool V3
GET
Get Application Pool V4
GET
Get Application Pool V5
GET
Get Application Pool V6
GET
Get Desktop Pool
GET
Get Desktop Pool Task
GET
Get Desktop Pool V2
GET
Get Desktop Pool V3
GET
Get Desktop Pool V4
GET
Get Desktop Pool V5
GET
Get Desktop Pool V6
GET
Get Desktop Pool V7
GET
Get Desktop Pool V8
GET
Get Farm
GET
Get Farm V2
GET
Get Farm V3
GET
Get Farm V4
GET
Get Farm V5
GET
Get Farm V6
GET
Get Farm V7
GET
Get Global Application Entitlement
GET
Get Global Application Entitlement V2
GET
Get Global Application Entitlement V3
GET
Get Global Application Entitlement V4
GET
Get Global Desktop Entitlement
GET
Get Global Desktop Entitlement V2
GET
Get Global Desktop Entitlement V3
GET
Get Global Desktop Entitlement V4
GET
Get Machine
GET
Get Machine V2
GET
Get Machine V3
GET
Get Machine V4
GET
Get Machine V5
GET
Get Persistent Disk
GET
Get Physical Machine
GET
Get Physical Machine V2
GET
Get RDS Server
GET
Get Rds Server Agent Upgrade Task
GET
Get RDS Server V2
GET
Get Session Info
GET
List Agent Installer Packages
GET
List Agent Upgrade Tasks
GET
List Agent Upgrade Tasks V2
GET
List Application Icons
GET
List Application Pools
GET
List Application Pools V2
GET
List Application Pools V3
GET
List Application Pools V4
GET
List Application Pools V5
GET
List Application Pools V6
GET
List App Volumes Applications On Farm
GET
List Attachable Machines
GET
List Category Folders
GET
List Compatible Backup GA Es
GET
List Compatible Backup GD Es
GET
List Compatible Local Application Pools
GET
List Compatible Local Desktop Pools
GET
List Custom Application Icons
GET
List Desktop Pools
GET
List Desktop Pools V2
GET
List Desktop Pools V3
GET
List Desktop Pools V4
GET
List Desktop Pools V5
GET
List Desktop Pools V6
GET
List Desktop Pools V7
GET
List Desktop Pools V8
GET
List Desktop Pool Tasks
GET
List Farms
GET
List Farms V2
GET
List Farms V3
GET
List Farms V4
GET
List Farms V5
GET
List Farms V6
GET
List Farms V7
GET
List Global Application Entitlements
GET
List Global Application Entitlements V2
GET
List Global Application Entitlements V3
GET
List Global Application Entitlements V4
GET
List Global Desktop Entitlements
GET
List Global Desktop Entitlements V2
GET
List Global Desktop Entitlements V3
GET
List Global Desktop Entitlements V4
GET
List Installed Applications On Desktop Pool
GET
List Installed Applications On Farm
GET
List Local Application Pools
GET
List Local Desktop Pools
GET
List Machines
GET
List Machines V2
GET
List Machines V3
GET
List Machines V4
GET
List Machines V5
GET
List Persistent Disks
GET
List Physical Machines
GET
List Physical Machines V2
GET
List Policies On Desktop Pool
GET
List Rds Server Agent Upgrade Tasks
GET
List RDS Servers
GET
List RDS Servers V2
GET
List Session Info
GET
List Session Info V2
GET
List Unentitled Machines
GET
List User Policies Overrides
POST
Log Off Global Sessions
POST
Log Off Sessions
POST
Pause Desktop Pool Task
GET
Query Global Sessions
POST
Rebuild Machines
POST
Recover Machines
POST
Recover RDS Servers
POST
Recreate From Persistent Disk
POST
Register Agent Installer Package
POST
Register Physical Machine
POST
Register RDS Server
POST
Remove Custom Icon
DELETE
Remove Local Application Pools From GAE
DELETE
Remove Local Desktop Pools From GDE
POST
Remove Machines
POST
Remove Rds Servers
POST
Reset Global Sessions
POST
Reset Machines
POST
Reset Sessions
POST
Restart Global Sessions
POST
Restart Machines
POST
Restart Sessions
POST
Resume Desktop Pool Task
POST
Schedule Agent For Upgrade
POST
Schedule Agent For Upgrade Rds Server
POST
Schedule Agent For Upgrade V2
POST
Schedule Maintenance
POST
Schedule Maintenance V2
POST
Schedule Push Image
POST
Schedule Push Image V2
POST
Send Message To Global Sessions
POST
Send Message To Sessions
POST
Unassign Machine Aliases
POST
Unassign Users
POST
Unregister Agent Installer Package
PUT
Update Application Pool
PUT
Update Application Pool V2
PUT
Update Application Pool V3
PUT
Update Application Pool V5
PUT
Update Application Pool V6
PUT
Update Desktop Pool
PUT
Update Desktop Poolv7
PUT
Update Desktop Poolv8
PUT
Update Farm
PUT
Update Farm V2
PUT
Update Farm V3
PUT
Update Farm V6
PUT
Update Farm V7
PUT
Update Global Application Entitlement
PUT
Update Global Application Entitlement V3
PUT
Update Global Application Entitlement V4
PUT
Update Global Desktop Entitlement
PUT
Update Global Desktop Entitlement V3
PUT
Update Global Desktop Entitlement V4
PUT
Update Persistent Disk
PUT
Update Policy Overrides For Users
PUT
Update RDS Server
PUT
Update RDS Server V2
PUT
Updates Policies On Desktop Pool
POST
Validate Installed Applications On Desktop Pool
POST
Validate Installed Applications On Farm
POST
Validate Specified Names