[{"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

URL

post

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

Copy

Request Body

UserDesktopMappingAssignRequest of mimetype application/json Required

udmAssignRequest

Show optional properties

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

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

string

userName Required

User Name

string

hdcId Required

HDC Id

string

orgId Required

Org ID that owns the entitlement user belongs to

string

poolId Required

Pool user belongs to

string

templateId Required

Template Id

string

userId Required

User Id

string

userPrincipalName Required

User principal name from identity provider

string

vmId Required

Dedicated VM for the user

string

entitlementId Optional

Authentication

This operation uses the following authentication methods.

Bearer

Response

Response Body

201 Created

Returns UserDesktopMapping of type */*

{
	"createdAt": "string",
	"disabled": false,
	"entitlementId": "string",
	"hdcId": "string",
	"id": "string",
	"location": "string",
	"orgId": "string",
	"poolId": "string",
	"templateId": "string",
	"updatedAt": "string",
	"userId": "string",
	"userName": "string",
	"userPrincipalName": "string",
	"vmId": "string"
}

string as date-time

createdAt Optional

boolean

disabled Optional

string

entitlementId Optional

string

hdcId Optional

string

id Optional

string

location Optional

string

orgId Optional

string

poolId Optional

string

templateId Optional

string as date-time

updatedAt Optional

string

userId Optional

string

userName Optional

string

userPrincipalName Optional

string

vmId Optional

Errors

ErrorResponse

400

Bad Request

ErrorResponse

401

Unauthorized

ErrorResponse

403

Forbidden

ErrorResponse

412

Precondition Failed

Code Samples

cURL Command

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

Vendor Extensions

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

x-codegen-request-body-name: udmAssignRequest

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

horizon-cloud-nextgen

Portal Operations

post

Create

post

Deassign User Desktop Mapping

get

Get User Desktop Mapping

Create

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?