Create Deprecated
DescriptionCreates a new entitlement record, belonging to the specified org. If org is not provided, it will use the org from the authentication context.
Request
URLURL
Request Body
{
"entitlementType": "DESKTOP",
"name": "entitlement-123",
"protocols": [
{
"defaultProtocol": false,
"name": "BLAST"
}
],
"templateType": "MULTI_SESSION",
"templates": [
{
"id": "template-1"
}
]
}
Entitlement type
Possible values are: APPLICATION , DESKTOP , DESKTOP_APPLICATION
Template type - templates added to the entitlement must match this value
Possible values are: DEDICATED , FLOATING , MULTI_SESSION , RDSH , WVD
Entitlement name
List of entitled user groups - requires group ID returned from IAM
Map to store UsersId or GroupId with their preferred homesite Id
Entitlement ID
Location that is mapped with Org Id
Enable SSO on this entitlement.
Org ID that owns this entitlement
Preferred Client Type
Possible values are: BROWSER , HORIZON_CLIENT
Entitlement description
Flag to specify home site restriction is enabled or not
Scope - use first preferred homesite or all preferred home sites
Possible values are: ALL_SITES , WITHIN_SITE
Time when the entitlement was created
Connection Affinity - rule to be used while brokering the entitlement
Possible values are: HOME_SITE , NEAREST_SITE
Time when the entitlement was updated
List of entitled users - requires user ID returned from IAM
Authentication
Response
Response BodyResponse Body
{
"applications": [
{
"displayName": "Google Chrome",
"icons": {
"key": {
"height": 0,
"iconHash": "string",
"icondata": "string",
"path": "string",
"width": 0
}
},
"id": "string",
"name": "Chrome",
"orgId": "0123456789",
"os": "Windows",
"path": "c:\\app\\chrome.exe",
"publisher": "VMware Inc",
"registeredExtensions": {
"extensions": [
{
"friendlyName": "string",
"value": "string"
}
],
"otherFileType": [
{
"friendlyName": "string",
"type": "string",
"value": "string"
}
]
},
"streamId": "string",
"templateIds": [
"string"
],
"version": "1.0.0",
"versionId": "string"
}
],
"connectionAffinity": "NEAREST_SITE",
"createdAt": "string",
"description": "entitlement description",
"enableSSO": false,
"entitlementType": "DESKTOP",
"groupIds": [
"group-id-1 | group-id-2"
],
"homesiteMappings": {
"key": "site-id-1 | site-id-2"
},
"id": "ent-id-12345",
"location": "US",
"name": "entitlement-123",
"orgId": "0123456789",
"powerPolicy": {
"enabled": false,
"min": 2,
"minUnit": "PERCENTAGE",
"modelVersion": 0,
"occupancyPresetMode": "BALANCED",
"powerOffProtectTimeMins": 30,
"powerSchedules": [
{
"allDay": false,
"endTime": "17:00",
"min": 5,
"modelVersion": 0,
"name": "VmwareWeekdaySchedule",
"occursOn": 31,
"startTime": "08:00",
"timeZone": "Asia/Tokyo"
}
]
},
"preferredClientType": "HORIZON_CLIENT",
"protocols": [
{
"defaultProtocol": false,
"name": "BLAST"
}
],
"reportedCapacity": {
"consumedVMs": 0,
"freeSessions": 0,
"maxVMs": 0,
"provisionedSessions": 0,
"provisionedVMs": 0,
"usedSessions": 0
},
"requireHomesite": true,
"scope": "ALL_SITES",
"templateType": "MULTI_SESSION",
"templates": [
{
"activeDirectoryId": "string",
"avAgentInstalled": false,
"clientAccessLicenseApplicable": false,
"dataCenterId": "datacenter-1",
"delete": false,
"disabled": false,
"disassociateAction": "FORCEFUL",
"edgeDeploymentId": "string",
"id": "template-1",
"imageReference": {
"modelVersion": 0,
"streamId": "string",
"versionId": "string"
},
"location": "string",
"name": "string",
"orgId": "string",
"powerPolicy": {
"enabled": false,
"min": 2,
"minUnit": "PERCENTAGE",
"modelVersion": 0,
"occupancyPresetMode": "BALANCED",
"powerOffProtectTimeMins": 30,
"powerSchedules": [
{
"allDay": false,
"endTime": "17:00",
"min": 5,
"modelVersion": 0,
"name": "VmwareWeekdaySchedule",
"occursOn": 31,
"startTime": "08:00",
"timeZone": "Asia/Tokyo"
}
]
},
"providerInstance": {
"id": "0123456789"
},
"templateType": "DEDICATED"
}
],
"updatedAt": "string",
"userIds": [
"user-id-1 | user-id-2"
]
}
Entitlement type
Possible values are: APPLICATION , DESKTOP , DESKTOP_APPLICATION
Template type - templates added to the entitlement must match this value
Possible values are: DEDICATED , FLOATING , MULTI_SESSION , RDSH , WVD
Entitlement name
List of entitled user groups - requires group ID returned from IAM
Map to store UsersId or GroupId with their preferred homesite Id
Entitlement ID
Location that is mapped with Org Id
Enable SSO on this entitlement.
Org ID that owns this entitlement
Preferred Client Type
Possible values are: BROWSER , HORIZON_CLIENT
Entitlement description
Flag to specify home site restriction is enabled or not
Scope - use first preferred homesite or all preferred home sites
Possible values are: ALL_SITES , WITHIN_SITE
Time when the entitlement was created
Connection Affinity - rule to be used while brokering the entitlement
Possible values are: HOME_SITE , NEAREST_SITE
Time when the entitlement was updated
List of entitled users - requires user ID returned from IAM
Errors
Not Found
Code Samples
Code Samples
cURL Command
Vendor Extensions
x-codegen-request-body-name: entitlement