VMware Developer Documentation
API Reference PowerCLI Reference
[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
Horizon Cloud Service - next-gen Portal Entitlements

Patch Entitlement Deprecated

Description

Update an existing entitlement record by adding and/or removing users and/or user groups

Request

Request

URL

URL

patch
https://cloud.vmwarehorizon.com/portal/v1/entitlements/{id}
Copy
Path Parameters

Path Parameters

string
id Required

id

Query Parameters

Query Parameters

boolean
delete Optional

delete
string
disassociateAction Optional

disassociateAction
string
org_id Optional

org_id

Request Body

Request Body

PatchEntitlementReq of mimetype application/json Required

patchEntitlementReq

{
	"enableSSO": false,
	"groupIdsToAdd": [
		"group-id-3 | group-id-4"
	],
	"groupIdsToRemove": [
		"group-id-1 | group-id-2"
	],
	"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"
			}
		]
	},
	"templatesToAdd": [
		[
			{
				"dataCenterId": "datacenter-1",
				"edgeDeploymentId": "string",
				"id": "template-3",
				"location": "string",
				"name": "string",
				"orgId": "string",
				"powerPolicy": {
					"base": "TOTAL",
					"enabled": false,
					"min": 2,
					"minUnit": "PERCENTAGE",
					"occupancyPresetMode": "BALANCED",
					"powerOffProtectTimeMins": 30,
					"powerSchedules": [
						{
							"allDay": false,
							"endTime": "17:00",
							"min": 5,
							"name": "VmwareWeekdaySchedule",
							"occursOn": 31,
							"startTime": "08:00",
							"timeZone": "Asia/Tokyo"
						}
					]
				},
				"templateType": "DEDICATED"
			}
		]
	],
	"templatesToRemove": [
		"template-1 | template-2"
	],
	"userIdsToAdd": [
		"user-id-3 | user-id-4"
	],
	"userIdsToRemove": [
		"user-id-1 | user-id-2"
	]
}
boolean
enableSSO Optional

Enable SSO on this entitlement.
array of string
groupIdsToAdd Optional

List of user groups to be added to the entitlement
array of string
groupIdsToRemove Optional

List of groups to be removed from the entitlement
PowerPolicy
powerPolicy Optional

Power policy Spec
array of Template
templatesToAdd Optional

List of templates to be added to the entitlement
array of string
templatesToRemove Optional

List of templates to be removed from the entitlement
array of string
userIdsToAdd Optional

List of users to be added to the entitlement
array of string
userIdsToRemove Optional

List of users to be removed from the entitlement
Authentication

Authentication

This operation uses the following authentication methods.

Bearer

Response

Response

Response Body

Response Body

204 No Content returns Entitlement of type */*

Entitlement patched

{
	"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"
	]
}
string
entitlementType Required

Entitlement type

Possible values are: APPLICATION , DESKTOP , DESKTOP_APPLICATION

array of Template
templates Required

List of templates
string
templateType Required

Template type - templates added to the entitlement must match this value

Possible values are: DEDICATED , FLOATING , MULTI_SESSION , RDSH , WVD

array of Protocol
protocols Required

List of supported desktop protocols
string as ^[a-zA-Z][a-zA-Z0-9\- ]+$
name Required

Entitlement name
array of ApplicationItem
applications Optional

List of applications
array of string
groupIds Optional

List of entitled user groups - requires group ID returned from IAM
map of string
homesiteMappings Optional

Map to store UsersId or GroupId with their preferred homesite Id
string
id Optional

Entitlement ID
string
location Optional

Location that is mapped with Org Id
boolean
enableSSO Optional

Enable SSO on this entitlement.
string
orgId Optional

Org ID that owns this entitlement
PowerPolicy
powerPolicy Optional

Power policy Spec
string
preferredClientType Optional

Preferred Client Type

Possible values are: BROWSER , HORIZON_CLIENT

string
description Optional

Entitlement description
ReportedCapacity
reportedCapacity Optional
boolean
requireHomesite Optional

Flag to specify home site restriction is enabled or not
string
scope Optional

Scope - use first preferred homesite or all preferred home sites

Possible values are: ALL_SITES , WITHIN_SITE

string as date-time
createdAt Optional

Time when the entitlement was created
string
connectionAffinity Optional

Connection Affinity - rule to be used while brokering the entitlement

Possible values are: HOME_SITE , NEAREST_SITE

string as date-time
updatedAt Optional

Time when the entitlement was updated
array of string
userIds Optional

List of entitled users - requires user ID returned from IAM
Errors

Errors

ErrorResponse
400

Bad Request
ErrorResponse
401

Unauthorized
ErrorResponse
403

Forbidden
ErrorResponse
404

Not found
ErrorResponse
412

Precondition Failed
Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"enableSSO":false,"groupIdsToAdd":["group-id-3 | group-id-4"],"groupIdsToRemove":["group-id-1 | group-id-2"],"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"}]},"templatesToAdd":[[{"dataCenterId":"datacenter-1","edgeDeploymentId":"string","id":"template-3","location":"string","name":"string","orgId":"string","powerPolicy":{"base":"TOTAL","enabled":false,"min":2,"minUnit":"PERCENTAGE","occupancyPresetMode":"BALANCED","powerOffProtectTimeMins":30,"powerSchedules":[{"allDay":false,"endTime":"17:00","min":5,"name":"VmwareWeekdaySchedule","occursOn":31,"startTime":"08:00","timeZone":"Asia/Tokyo"}]},"templateType":"DEDICATED"}]],"templatesToRemove":["template-1 | template-2"],"userIdsToAdd":["user-id-3 | user-id-4"],"userIdsToRemove":["user-id-1 | user-id-2"]}' https://cloud.vmwarehorizon.com/portal/v1/entitlements/{id}
 Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: patchEntitlementReq


Generated on: 12 May 22 14:40 UTC
[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
On This Page
Portal Operations
post
Create
delete
Delete Entitlement
get
Get Entitlement
get
Get Entitlements
get
List VMS With User
patch
Patch Entitlement
put
Update Entitlement
Feedback

Was this page helpful?

© 2022 VMware Inc. Terms of Use Privacy Your California Privacy Rights Accessibility Trademarks Glossary Help Contact Us