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

Unassign

Description

Update an entitlement record by removing users and/or user groups corresponding to given desktops or apps

Request

Request

URL

URL


post
https://cloud.vmwarehorizon.com/portal/v2/entitlements/{id}/unassign
Copy

Path Parameters

Path Parameters

string
id Required

id


Query Parameters

Query Parameters

string
org_id Optional

org_id


Request Body

Request Body

EntitlementUnassignReq of mimetype application/json Required

unassignReq

{
	"groupIds": [
		"group-id-1 | group-id-2"
	],
	"resourceDetails": [
		[
			{
				"poolId": "pg-id-2",
				"resourceId": "app-id-1"
			},
			{
				"poolId": "pg-id-2"
			}
		]
	],
	"userIds": [
		"user-id-3 | user-id-4"
	]
}
array of string
groupIds Optional

List of groups to be unassigned


array of ResourceDetail
resourceDetails Optional

List of apps/desktop to be unassigned.


array of string
userIds Optional

List of users to be unassigned

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created returns array of EntitlementV2 of type */*

User/Groups unassigned from the entitlement.

{
	"createdAt": "string",
	"description": "Entitlement description",
	"groupIds": [
		"group-id-1 | group-id-2"
	],
	"id": "ent-id-12345",
	"location": "US",
	"name": "dev's entitlement",
	"orgId": "0123456789",
	"poolIds": [
		"string"
	],
	"resourceDetails": [
		{
			"poolId": "string",
			"resourceId": "string"
		}
	],
	"updatedAt": "string",
	"userIds": [
		"user-id-1 | user-id-2"
	]
}
array of string
poolIds Required

List of PoolIds


array of ResourceDetail
resourceDetails Required

List of filter applications for this entitlements


string as date-time
createdAt Optional

Time when the entitlement was created


string
id Optional

Entitlement ID


string
location Optional

Location that is mapped with Org Id


string
name Optional

Entitlement name


string
orgId Optional

Org ID that owns this entitlement


string
description Optional

Entitlement description


array of string
groupIds Optional

List of entitled user groups - requires group ID returned from IAM


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

400

Bad Request


401

Unauthorized


403

Forbidden


404

Not found


412

Precondition Failed

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"groupIds":["group-id-1 | group-id-2"],"resourceDetails":[[{"poolId":"pg-id-2","resourceId":"app-id-1"},{"poolId":"pg-id-2"}]],"userIds":["user-id-3 | user-id-4"]}' https://cloud.vmwarehorizon.com/portal/v2/entitlements/{id}/unassign
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?