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

Perform User Action

Description

Perform an user action

Request

Request

URL

URL


post
https://cloud.vmwarehorizon.com/portal/v2/users/action
Copy

Request Body

Request Body

UserActionReq of mimetype application/json Required

userActionReq

{
    "actionType": "LOGOFF",
    "id": "ent-id-12345"
}
string
actionType Optional

Action type: LOGOFF, RESTART etc

Possible values are: LOGOFFRESTART


string
id Optional

resource ID on which action to be performed.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

202 Accepted

Successfully accepted user action

Errors

Errors

ErrorResponse
401

Unauthorized


ErrorResponse
403

Forbidden


ErrorResponse
404

Not Found


ErrorResponse
500

Unexpected internal server error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"actionType":"LOGOFF","id":"ent-id-12345"}' https://cloud.vmwarehorizon.com/portal/v2/users/action
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?