Post Search Entitlements

Retrieve entitlements for the authenticated user or for a given user ID

Request

URI

POST

https://{api_host}//SAAS/jersey/manager/api/entitlements/search

COPY

Query Parameters

integer

startIndex

Optional

Offset of the first catalog item to return in the list of found cagtalog items. This is used for pagination

startIndex example

integer

pageSize

Optional

The number of found catalog items to return starting from the given startIndex. This is used for pagination

pageSize example

boolean

showVisibleAppsOnly

Optional

Whether to return only catalog items that are visible on the user portal, or return both visible and hidden catalog items

showVisibleAppsOnly example

true

string

userId

Optional

The user ID

userId example

b26c4e15-c664-49c3-88d5-cd15c9939ce6

Header Parameters

string

Required

Always use application/vnd.vmware.horizon.manager.entitlements.v2.entitlement.list+json which returns VMware Identity Manager user IDs. application/vnd.vmware.horizon.manager.entitlements.entitlement.list+json used to return external user IDs and is now deprecated.

Accept example

application/vnd.vmware.horizon.manager.entitlements.v2.entitlement.list+json

Request Body

the search criteria for filtering the returned catalog item list

SearchCriteria of type(s) application/vnd.vmware.horizon.manager.entitlements.search+json

Required

{
    "activationStates": [
        "string"
    ],
    "catalogIds": [
        "string"
    ],
    "sortOrder": "NAME",
    "catalogTypes": [
        "string"
    ],
    "categories": [
        "string"
    ],
    "nameFilter": "mywebapp"
}

array of string

activationStates

Optional

Find the entitled catalog items that are in ANY of the specified activation states

Possible values are : NOT_ACTIVATED, ACTIVATION_REQUESTED, ACTIVATION_IN_PROGRESS, ACTIVATION_FAILED, ACTIVATED, DEACTIVATION_REQUESTED, DEACTIVATION_IN_PROGRESS, DEACTIVATION_FAILED, DEACTIVATED,

array of string

catalogIds

Optional

Only return entitlements for ANY of these catalog item IDs

object

_links

Optional

_links

string

sortOrder

Optional

Order the results by either Alphabetical order of catalog item name or by catalog item creation time (newest item first). Default sort is by creation time

Possible values are : NAME, AGE,

array of string

catalogTypes

Optional

Find the entitled catalog items that belong to ANY of the specified types

Possible values are : SAAS, VIEW, VIEWAPP, THINAPP, APPV, XENAPP, XENAPPDELIVERYGROUP, WEBAPPLINK, DESKTONEDESKTOP, DESKTONEAPPLICATION, NATIVEAPP, ANYAPP,

array of string

categories

Optional

Find the entitled catalog items that belong to ALL of the specified categories

string

nameFilter

Optional

Find only entitled catalog items that have this string in their name

Authentication

This operation uses the following authentication methods.

oauth2

Responses

200

successful operation

Returns Entitlements of type(s) application/vnd.vmware.horizon.manager.entitlements.entitlement.list+json

{
    "items": [
        {
            "approvalMessage": "Approved.",
            "name": "Example Web Application",
            "catalogType": "SAAS",
            "catalogItemId": "042eb1e6-61b0-451b-b35e-e9811e2459a2",
            "perDeviceActivationRequired": false,
            "userId": "083ed8e6-6a39-461a-b0de-e9800e245900",
            "activationPolicy": "AUTOMATIC",
            "catalogItemType": "Saml20",
            "visible": true,
            "internal": false,
            "activationState": "ACTIVATED",
            "approvalRequired": true,
            "description": "This is a Service Provider Sample Application."
        }
    ]
}

array of Entitlement

items

Optional

The list of items in the current page

object

_links

Optional

_links

400

Invalid or no search criteria defined in request body or number of provided category labels exceeds the maximum allowed value.

Operation doesn't return any data structure

403