[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
Unassign
DescriptionUpdate an entitlement record by removing users and/or user groups corresponding to given desktops or apps
Request
URLURL
https://cloud.vmwarehorizon.com/portal/v2/entitlements/{id}/unassign
Path Parameters
Path Parameters
string
id
Required
id
Query Parameters
Query Parameters
string
org_id
Optional
org_id
Request Body
Request Body
{
"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
string
userIds
Optional
List of users to be unassigned
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
array of
EntitlementV2
of type */*
User/Groups unassigned from the entitlement.
{
"description": "Entitlement description",
"groupIds": [
"group-id-1",
"group-id-2"
],
"id": "ent-id-12345",
"location": "US",
"name": "dev's entitlement",
"orgId": "0123456789",
"userIds": [
"user-id-1",
"user-id-2"
]
}
array of
string
poolIds
Required
List of PoolIds
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
ErrorResponse
400
Bad Request
ErrorResponse
401
Unauthorized
ErrorResponse
403
Forbidden
ErrorResponse
404
Not found
ErrorResponse
412
Precondition Failed
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
This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: unassignReq
[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
On This Page
Portal Operations
post
delete
get
get
patch
post
post
