[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen

Create

Description

Creates user desktop mapping for user belonging to a specified Pool that belongs to the specified org. If org is not provided, it will use the org from the authentication context.

Request

Request

URL

URL


post
https://cloud.vmwarehorizon.com/portal/v1/userdesktopmapping
Copy

Request Body

Request Body

UserDesktopMapping of mimetype application/json Required

userDesktopMapping

{
    "entitlementId": "ent-id-12345",
    "orgId": "0123456789",
    "poolId": "pool-id-12345",
    "userPrincipalName": "john.smith@horizonv2.onmicrosof.com"
}
string
templateId Required

Template Id


string
userPrincipalName Required

User principal name from identity provider


string
entitlementId Required

Entitlement user belongs to


string
hdcId Required

HDC Id


string
userName Required

User Name


string
userId Required

User Id


string
orgId Required

Org ID that owns the entitlement user belongs to


string
poolId Required

Pool user belongs to


string
vmId Required

Dedicated VM for the user


string as date-time
updatedAt Optional

Time the mapping was modified


string
location Optional

Location that is mapped with Org Id


string
id Optional

User desktop mapping ID


boolean
disabled Optional

string as date-time
createdAt Optional

Time the mapping was created

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created

Returns UserDesktopMapping of type */*
{
    "entitlementId": "ent-id-12345",
    "location": "US",
    "orgId": "0123456789",
    "poolId": "pool-id-12345",
    "userPrincipalName": "john.smith@horizonv2.onmicrosof.com"
}
string
templateId Required

Template Id


string
userPrincipalName Required

User principal name from identity provider


string
entitlementId Required

Entitlement user belongs to


string
hdcId Required

HDC Id


string
userName Required

User Name


string
userId Required

User Id


string
orgId Required

Org ID that owns the entitlement user belongs to


string
poolId Required

Pool user belongs to


string
vmId Required

Dedicated VM for the user


string as date-time
updatedAt Optional

Time the mapping was modified


string
location Optional

Location that is mapped with Org Id


string
id Optional

User desktop mapping ID


boolean
disabled Optional

string as date-time
createdAt Optional

Time the mapping was created

Errors

Errors

400

Bad Request


401

Unauthorized


403

Forbidden


404

Not Found


412

Precondition Failed

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"entitlementId":"ent-id-12345","location":"US","orgId":"0123456789","poolId":"pool-id-12345","userPrincipalName":"john.smith@horizonv2.onmicrosof.com"}' https://cloud.vmwarehorizon.com/portal/v1/userdesktopmapping
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: userDesktopMapping


[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
Feedback

Was this page helpful?