[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
Deassign User Desktop Mapping
DescriptionDeassign user desktop mapping by given templateId and vmId
Request
URLURL
https://cloud.vmwarehorizon.com/portal/v1/userdesktopmapping/deassign
Query Parameters
Query Parameters
string
org_id
Optional
org_id
Request Body
Request Body
UserDesktopMappingDeassignRequest
of mimetype application/json
Required
userDesktopMappingDeassignRequest
{}
string
templateId
Required
Template Id
string
entitlementId
Optional
string
poolId
Optional
Pool ID
string
userId
Optional
User Id
string
vmId
Optional
Dedicated VM for the user
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
VmUser
of type */*
{
"clientId": "string",
"sessionStatus": "string",
"sessionType": "APPLICATION",
"templateType": "APP_CAPTURE_STUDIO",
"userId": "string",
"username": "string",
"vmId": "string"
}
string
clientId
Optional
string
sessionStatus
Optional
string
sessionType
Optional
Possible values are: APPLICATION , DESKTOP
string
templateType
Optional
Possible values are: APP_CAPTURE_STUDIO , DEDICATED , FLOATING , MULTI_SESSION , RDSH , WVD
string
userId
Optional
string
username
Optional
string
vmId
Optional
Foreign key: ID of InvVMs
Errors
ErrorResponse
401
Unauthorized
ErrorResponse
403
Forbidden
ErrorResponse
404
Not found
Code Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"poolId":"pool-id-12345"}' https://cloud.vmwarehorizon.com/portal/v1/userdesktopmapping/deassign
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
