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

Get User Desktop Mapping

Description

EntitlementId is a must. UserId and TemplateId are optional.

Request

Request

URL

URL


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

Query Parameters

Query Parameters

string
entitlementId Required

entitlementId


string
org_id Optional

org_id


string
templateId Optional

templateId


string
userId Optional

userId


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns array of 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

401

Unauthorized


403

Forbidden


404

Not found

Code Samples

Code Samples

cURL Command

curl https://cloud.vmwarehorizon.com/portal/v1/userdesktopmapping?entitlementId=string


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

Was this page helpful?