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

Deassign User Desktop Mapping

Description

Deassign user desktop mapping by given templateId and vmId

Request

Request

URL

URL


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

Query Parameters

Query Parameters

string
org_id Optional

org_id


Request Body

Request Body

UserDesktopMappingDeassignRequest of mimetype application/json Required

userDesktopMappingDeassignRequest

{
	"entitlementId": "ent-id-12345",
	"templateId": "string"
}
string
entitlementId Required

Entitlement user belongs to


string
templateId Required

Template Id


string
poolId Optional

Pool ID


string
userId Optional

User Id


string
vmId Optional

Dedicated VM for the user

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created returns VmUser of type */*
{
	"clientId": "string",
	"sessionStatus": "string",
	"sessionType": "APPLICATION",
	"templateType": "DEDICATED",
	"userId": "string",
	"username": "string",
	"vmId": "string"
}
string
clientId Optional

string
sessionStatus Optional

string
sessionType Optional

Possible values are: APPLICATIONDESKTOP


string
templateType Optional

Possible values are: DEDICATEDFLOATINGMULTI_SESSIONRDSHWVD


string
userId Optional

string
username Optional

string
vmId Optional

Foreign key: ID of InvVMs

Errors

Errors

401

Unauthorized


403

Forbidden


404

Not found

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"entitlementId":"ent-id-12345","poolId":"pool-id-12345","templateId":"string","userId":"string","vmId":"string"}' https://cloud.vmwarehorizon.com/portal/v1/userdesktopmapping/deassign
Vendor Extensions

Vendor Extensions

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


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

Was this page helpful?