[{"label":"Latest (V1)","version":"latest"}]

horizon-cloud-nextgen

Patch Entitlement

Description

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

Request

URL

patch

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

Copy

Path Parameters

string

id Required

Query Parameters

string

org_id Optional

org_id

Request Body

PatchEntitlementV2Req of mimetype application/json Required

patchEntitlementReq

{
    "groupIdsToAdd": [
        "group-id-3",
        "group-id-4"
    ],
    "groupIdsToRemove": [
        "group-id-1",
        "group-id-2"
    ],
    "poolIdsToAdd": [
        "group-id-1",
        "group-id-2"
    ],
    "poolIdsToRemove": [
        "group-id-1",
        "group-id-2"
    ],
    "resourceDetailsToAdd": [
        "group-id-1",
        "group-id-2"
    ],
    "resourceDetailsToRemove": [
        "group-id-1",
        "group-id-2"
    ],
    "userIdsToAdd": [
        "user-id-3",
        "user-id-4"
    ],
    "userIdsToRemove": [
        "user-id-1",
        "user-id-2"
    ]
}

array of string

groupIdsToAdd Optional

List of user groups to be added to entitlement

array of string

groupIdsToRemove Optional

List of groups to be removed from the entitlement

array of string

poolIdsToAdd Optional

List of poolIds to be added to the entitlement

array of string

poolIdsToRemove Optional

List of poolIds to be removed from the entitlement

array of ResourceDetail

resourceDetailsToAdd Optional

List of apps to be added to the entitlement

array of ResourceDetail

resourceDetailsToRemove Optional

List of apps 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

This operation uses the following authentication methods.

Bearer

Response

Response Body

200 OK

Returns EntitlementV2 of type */*

Entitlement patched

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

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

ErrorResponse

400

Bad Request

ErrorResponse

401

Unauthorized

ErrorResponse

403

Forbidden

ErrorResponse

404

Not found

ErrorResponse

412

Precondition Failed

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"groupIdsToAdd":["group-id-3","group-id-4"],"groupIdsToRemove":["group-id-1","group-id-2"],"poolIdsToAdd":["group-id-1","group-id-2"],"poolIdsToRemove":["group-id-1","group-id-2"],"resourceDetailsToAdd":["group-id-1","group-id-2"],"resourceDetailsToRemove":["group-id-1","group-id-2"],"userIdsToAdd":["user-id-3","user-id-4"],"userIdsToRemove":["user-id-1","user-id-2"]}' https://cloud.vmwarehorizon.com/portal/v2/entitlements/{id}

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-codegen-request-body-name: patchEntitlementReq

[{"label":"Latest (V1)","version":"latest"}]

horizon-cloud-nextgen

Portal Operations

post

Create

delete

Delete Entitlement

get

Get Entitled Users

get

Get Entitlement

get

Get Entitlements

patch

Patch Entitlement

get

Status Unassign Bulk

post

Unassign

post

Unassign Bulk

put

Update Entitlement

Patch Entitlement

Request

URL

Path Parameters

Query Parameters

Request Body

Authentication

Bearer

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

Vendor Extensions

On This Page

Portal Operations

Was this page helpful?