cloudPC: organizationAction

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Trigger a Cloud PC organization action.

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	CloudPC.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Not supported.	Not supported.

HTTP request

To trigger a Cloud PC organization action using delegated permission:

POST /deviceManagement/virtualEndpoint/organizationAction

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

In the request body, supply a JSON representation of the parameters.

The following table shows the parameter that you can use with this action.

Parameter	Type	Description
actionType	cloudPcOrganizationActionType	The action type. Possible values are activate, deactivate, and unknownFutureValue. Required.

Response

If successful, this method returns a 200 OK response code and a cloudPcOrganizationActionDetail object in the response body.

Example

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/organizationAction
Content-Type: application/json

{
  "actionType": "activate"
}

Response

The following example shows the response.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.cloudPcOrganizationActionDetail",
  "actionType": "activate",
  "status": "inProgress",
  "errorDescription": null
}