[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen

Get Entitlements Deprecated

Description

Get all entitlements, with an optional org ID filter. Non-super users can only query for their own org IDs. This will return all records for which the caller has ‘read’ permission

Request

Request

URL

URL


get
https://cloud.vmwarehorizon.com/portal/v1/entitlements
Copy

Query Parameters

Query Parameters

string
org_id Optional

org_id


ref
page Optional

Page number to retrieve.


string
search Optional

Search Criteria. Please see model definition for list of searchable fields.

search example
map[code:"orgId $eq org-id-1"
]

ref
size Optional

Size of each page.


array of string
sort Optional

Ascending/Descending. Format is property,{asc|desc} and default is ascending.

Parameter Serialization Style: form Explode:true

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns PageEntitlement of type */*
{
	"content": [
		{
			"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-2 | site-id-1"
			},
			"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"
			]
		}
	],
	"empty": false,
	"first": false,
	"last": false,
	"number": 0,
	"numberOfElements": 0,
	"pageable": {
		"offset": 0,
		"pageNumber": 0,
		"pageSize": 0,
		"paged": false,
		"sort": {
			"empty": false,
			"sorted": false,
			"unsorted": false
		},
		"unpaged": false
	},
	"size": 0,
	"sort": {
		"empty": false,
		"sorted": false,
		"unsorted": false
	},
	"totalElements": 0,
	"totalPages": 0
}
array of Entitlement
content Optional

boolean
empty Optional

boolean
first Optional

boolean
last Optional

integer as int32
number Optional

integer as int32
numberOfElements Optional

pageable Optional

integer as int32
size Optional

sort Optional

integer as int64
totalElements Optional

integer as int32
totalPages Optional
Errors

Errors

401

Unauthorized


403

Forbidden


404

Not Found

Code Samples

Code Samples

cURL Command

curl https://cloud.vmwarehorizon.com/portal/v1/entitlements


[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
Feedback

Was this page helpful?