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

horizon-cloud-nextgen

Create Deprecated

Description

Creates a new entitlement record, belonging to the specified org. If org is not provided, it will use the org from the authentication context.

Request

URL

post

https://cloud.vmwarehorizon.com/portal/v1/entitlements

Copy

Request Body

Entitlement of mimetype application/json Required

entitlement

Show optional properties

{
    "entitlementType": "DESKTOP",
    "name": "entitlement-123",
    "templateType": "MULTI_SESSION"
}

{
    "connectionAffinity": "NEAREST_SITE",
    "description": "entitlement description",
    "entitlementType": "DESKTOP",
    "groupIds": [
        "group-id-1",
        "group-id-2"
    ],
    "homesiteMappings": {
        "group-id-1": "site-id-2",
        "user-id-1": "site-id-1"
    },
    "id": "ent-id-12345",
    "location": "US",
    "name": "entitlement-123",
    "orgId": "0123456789",
    "preferredClientType": "HORIZON_CLIENT",
    "requireHomesite": true,
    "scope": "ALL_SITES",
    "templateType": "MULTI_SESSION",
    "userIds": [
        "user-id-1",
        "user-id-2"
    ]
}

string

entitlementType Required

Entitlement type

Possible values are: APPLICATION , DESKTOP , DESKTOP_APPLICATION

array of Template

templates Required

List of templates

string

templateType Required

Template type - templates added to the entitlement must match this value

Possible values are: DEDICATED , FLOATING , MULTI_SESSION , RDSH , WVD

array of Protocol

protocols Required

List of supported desktop protocols

string as ^[a-zA-Z][a-zA-Z0-9\- ]+$

name Required

Entitlement name

array of ApplicationItem

applications Optional

List of applications

array of string

groupIds Optional

List of entitled user groups - requires group ID returned from IAM

map of string

homesiteMappings Optional

Map to store UsersId or GroupId with their preferred homesite Id

string

id Optional

Entitlement ID

string

location Optional

Location that is mapped with Org Id

boolean

enableSSO Optional

Enable SSO on this entitlement.

string

orgId Optional

Org ID that owns this entitlement

PowerPolicy

powerPolicy Optional

Power policy Spec

string

preferredClientType Optional

Preferred Client Type

Possible values are: BROWSER , HORIZON_CLIENT

string

description Optional

Entitlement description

ReportedCapacity

reportedCapacity Optional

boolean

requireHomesite Optional

Flag to specify home site restriction is enabled or not

string

scope Optional

Scope - use first preferred homesite or all preferred home sites

Possible values are: ALL_SITES , WITHIN_SITE

string as date-time

createdAt Optional

Time when the entitlement was created

string

connectionAffinity Optional

Connection Affinity - rule to be used while brokering the entitlement

Possible values are: HOME_SITE , NEAREST_SITE

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

Authentication

This operation uses the following authentication methods.

Bearer

Response

Response Body

201 Created

Returns Entitlement of type */*

{
    "connectionAffinity": "NEAREST_SITE",
    "description": "entitlement description",
    "entitlementType": "DESKTOP",
    "groupIds": [
        "group-id-1",
        "group-id-2"
    ],
    "homesiteMappings": {
        "group-id-1": "site-id-2",
        "user-id-1": "site-id-1"
    },
    "id": "ent-id-12345",
    "location": "US",
    "name": "entitlement-123",
    "orgId": "0123456789",
    "preferredClientType": "HORIZON_CLIENT",
    "requireHomesite": true,
    "scope": "ALL_SITES",
    "templateType": "MULTI_SESSION",
    "userIds": [
        "user-id-1",
        "user-id-2"
    ]
}

string

entitlementType Required

Entitlement type

Possible values are: APPLICATION , DESKTOP , DESKTOP_APPLICATION

array of Template

templates Required

List of templates

string

templateType Required

Template type - templates added to the entitlement must match this value

Possible values are: DEDICATED , FLOATING , MULTI_SESSION , RDSH , WVD

array of Protocol

protocols Required

List of supported desktop protocols

string as ^[a-zA-Z][a-zA-Z0-9\- ]+$

name Required

Entitlement name

array of ApplicationItem

applications Optional

List of applications

array of string

groupIds Optional

List of entitled user groups - requires group ID returned from IAM

map of string

homesiteMappings Optional

Map to store UsersId or GroupId with their preferred homesite Id

string

id Optional

Entitlement ID

string

location Optional

Location that is mapped with Org Id

boolean

enableSSO Optional

Enable SSO on this entitlement.

string

orgId Optional

Org ID that owns this entitlement

PowerPolicy

powerPolicy Optional

Power policy Spec

string

preferredClientType Optional

Preferred Client Type

Possible values are: BROWSER , HORIZON_CLIENT

string

description Optional

Entitlement description

ReportedCapacity

reportedCapacity Optional

boolean

requireHomesite Optional

Flag to specify home site restriction is enabled or not

string

scope Optional

Scope - use first preferred homesite or all preferred home sites

Possible values are: ALL_SITES , WITHIN_SITE

string as date-time

createdAt Optional

Time when the entitlement was created

string

connectionAffinity Optional

Connection Affinity - rule to be used while brokering the entitlement

Possible values are: HOME_SITE , NEAREST_SITE

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

404

Not Found

ErrorResponse

412

Precondition Failed

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"connectionAffinity":"NEAREST_SITE","description":"entitlement description","entitlementType":"DESKTOP","groupIds":["group-id-1","group-id-2"],"homesiteMappings":{"group-id-1":"site-id-2","user-id-1":"site-id-1"},"id":"ent-id-12345","location":"US","name":"entitlement-123","orgId":"0123456789","preferredClientType":"HORIZON_CLIENT","requireHomesite":true,"scope":"ALL_SITES","templateType":"MULTI_SESSION","userIds":["user-id-1","user-id-2"]}' https://cloud.vmwarehorizon.com/portal/v1/entitlements

Vendor Extensions

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

x-codegen-request-body-name: entitlement

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

horizon-cloud-nextgen

Portal Operations

post

Create

delete

Delete Entitlement

get

Get Entitlement

get

Get Entitlements

get

List VMS With User

patch

Patch Entitlement

put

Update Entitlement

Create Deprecated

Request

URL

Request Body

Authentication

Bearer

Response

Response Body

201 Created

Errors

Code Samples

cURL Command

Vendor Extensions

On This Page

Portal Operations

Was this page helpful?