Entitlement

Entitlement
Entitlement

The entitlement object.

JSON Example 
{
    "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."
}
string
approvalMessage
Optional

The message that the external approval system sent in response to the approval request.

string
name
Optional

The catalog item name

string
catalogType
Optional

The catalog item type category (used for searching catalog items)

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

List of devices on which the catalog item was activated

string As uuid As uuid
catalogItemId
Optional

The catalog item ID

boolean
perDeviceActivationRequired
Optional

Whether to activate the application on each device individually. If set to "true", the activation will only apply to the current device.

string
userId
Optional

The user ID

string
activationPolicy
Optional

The type of activation the catalog item will require before showing on the user portal

Possible values are : USER_ACTIVATED, AUTOMATIC,
string
catalogItemType
Optional

The specific catalog item type (used for application launch by VMware Identity Manager)

Possible values are : Saml11, Saml20, ReferredMobile, HostedMobile, VvpImage, DataModule, ViewPool, ViewApp, ThinApp, AppV, AppBlast, XenApp, XenAppDeliveryGroup, WSFed12, ExchangeConfig, VPNConfig, WifiConfig, WebAppLink, DesktoneDesktop, DesktoneApplication, NativeApp, AnyApp,
boolean
visible
Optional

Whether to display the catalog item on the user portal. If set to "false", the catalog item will not show on any user portal even when in activated state.

boolean
internal
Optional

In the context of Workspace One application on a mobile device. internal = "false" indicates to the WS1 Application that the catalog item can be launched from outside the company VPN

object
_links
Optional

_links

string
activationState
Optional

The catalog item activation state on the user portal. "ACTIVATED" means that the catalog item can be displayed on the user portal. In "NOT_ACTIVATED" state, the catalog item will be hidden even if the user is entitled.

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

Whether additional external approval is required in order to activate the catalog item.

string
description
Optional

The catalog item description

Property Of