Get Get Entitlement Definition

Get Get Entitlement Definition

Retrieve entitlement definition information for a given catalog item and user/group pair, if exists.

Request
URI
GET
https://{api_host}//SAAS/jersey/manager/api/entitlements/definitions/catalogitems/{catalogItemId}/{subjectType}/{subjectId}
COPY
Path Parameters
string
catalogItemId
Required

The ID of the catalog item to which the subject is entitled.

catalogItemId example 
85c040cf-b389-41a0-9efe-c7ca64f993c7
string
subjectType
Required

The type of entity that you want to entitle the catalog item to.

subjectType example 
users
Possible values are : users, groups,
string
subjectId
Required

The ID of the user or group to which the catalog item is entitled. This is usually the VMware Identity Manager UUID and not an external ID.

subjectId example 
8dbdc5a6-1fb4-4a17-a25c-6a3744fb40db
Authentication
This operation uses the following authentication methods.
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,

403

The user does not have the required permissions to retrieve the entitlement information.

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
Admin Operations
DELETE
Delete Delete Entitlement Definition
GET
Get Get Entitlement Definition
PUT
Put Update Entitlement Definition