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

Unassign Bulk

Description

Create a task to unassign users/groups from desktops/apps from multiple entitlements

Request

Request

URL

URL


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

Query Parameters

Query Parameters

string
org_id Optional

org_id


Request Body

Request Body

EntitlementUnassignReq of mimetype application/json Required

unassignBulkReq

{
    "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

201 Created Response Body>

Response Body

201 Created

Returns EntilementBulkUnassignStatusRes of type */*
{
	"jobId": "string",
	"status": "string"
}
string
jobId Optional

string
status Optional

202 Accepted Response Body>

Response Body

202 Accepted

Returns EntilementBulkUnassignStatusRes of type */*

Successfully created the unassign bulk task.

{
	"jobId": "string",
	"status": "string"
}
string
jobId Optional

string
status Optional
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/unassign
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?