Put Update Entitlement Definition

Updates an entitlement definition. Only the catalog 'activationPolicy' value can be updated in this way ('AUTOMATIC' or 'USER_ACTIVATED').
An entitlement definition is the attachment of a user or group to a catalog item.
Catalog ID is a unique internal identifier and can be retrieved using the catalogitems/search API.
The user/group ID can be searched using the SCIM API: /scim/Users?filter=... or /scim/Groups?filter=
Put operation requires resending all attributes (not just the ones that need change).

Request

URI

PUT

https://{api_host}//SAAS/jersey/manager/api/entitlements/definitions/catalogitems/{catalogItemId}/{subjectType}/{subjectId}

COPY

Path Parameters

string

catalogItemId

Required

The entitled catalog ID

catalogItemId example

d24afa39-05a1-433f-8aa9-ad41c9a3d394

string

subjectType

Required

Specify which type of subject type.

subjectType example

users

Possible values are : users, groups,

string

subjectId

Required

The ID of the user or group to entitle

subjectId example

d24afa39-05a1-433f-8aa9-ad41c9a3e395

Request Body

the entitlement definition updated information as a JSON string

EntitlementDefinitionTO of type(s) application/vnd.vmware.horizon.manager.entitlements.definition+json

Required

{
    "catalogItemId": "042eb1e6-61b0-451b-b35e-e9811e2459a2",
    "subjectType": "GROUPS",
    "subjectId": "083ed8e6-6a39-461a-b0de-e9800e245900",
    "activationPolicy": "AUTOMATIC"
}

string As uuid As uuid

catalogItemId

Optional

The catalog item ID

string

subjectType

Optional

The entitlement subject type (USERS or GROUPS)

Possible values are : USERS, GROUPS,

string

subjectId

Optional

The Subject ID

string

activationPolicy

Optional

The deployment type of the application on the user portal.

Possible values are : AUTOMATIC, USER_ACTIVATED,

Authentication

This operation uses the following authentication methods.

oauth2

Responses

200

successful operation

Returns EntitlementDefinition of type(s) application/vnd.vmware.horizon.manager.entitlements.definition+json

{
    "catalogItemId": "042eb1e6-61b0-451b-b35e-e9811e2459a2",
    "subjectType": "GROUPS",
    "subjectId": "083ed8e6-6a39-461a-b0de-e9800e245900",
    "activationPolicy": "AUTOMATIC"
}

string As uuid As uuid

catalogItemId

Optional

The catalog item ID

string

subjectType

Optional

The entitlement subject type.

Possible values are : USERS, GROUPS,

object

_links

Optional

_links

string

subjectId

Optional

The Subject ID

string

activationPolicy

Optional

The deployment type of the application on the user portal.

Possible values are : USER_ACTIVATED, AUTOMATIC,

400

The supplied JSON is incorrect

Operation doesn't return any data structure

403

The user does not have the required permissions to update the entitlement.

Operation doesn't return any data structure

404

The requested entitlement definition doesn't exist. The response includes detailed reason codes: catalogitem.not.found, user.not.found, NOT_FOUND (subject type not found), entitlement.definition.not.found.

Operation doesn't return any data structure

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Admin Operations

DELETE