Method: mobiledevices.action
Takes an action that affects a mobile device. For example, remotely wiping a device.
HTTP request
POST https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}/action
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
customerId |
string
The unique ID for the customer's Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource.
|
resourceId |
string
The unique ID the API service uses to identify the mobile device.
|
Request body
The request body contains an instance of MobileDeviceAction.
Response body
If successful, the response is a generic HTTP response whose format is defined by the method.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/admin.directory.device.mobile
https://www.googleapis.com/auth/admin.directory.device.mobile.action
For more information, see the Authorization guide.
MobileDeviceAction
| JSON representation |
{
"action": string
} |
| Fields |
action |
string
The action to be performed on the device. Acceptable values are:
admin_remote_wipeadmin_account_wipeapproveblockcancel_remote_wipe_then_activatecancel_remote_wipe_then_block
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-22 UTC.
[null,null,["Last updated 2024-08-22 UTC."],[[["This API endpoint allows administrators to perform actions on mobile devices, such as remotely wiping or blocking them."],["The request requires specifying the customer ID and the device's unique resource ID."],["The action to be taken is defined in the request body using the `MobileDeviceAction` object and its `action` field."],["Authorization requires specific OAuth scopes related to device management."],["Successful requests receive a generic HTTP response without a specific body content."]]],["This outlines how to perform an action on a mobile device via an HTTP POST request to `https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}/action`. The request requires a `customerId` and `resourceId` in the URL. The request body, an instance of `MobileDeviceAction`, specifies the `action`, such as `admin_remote_wipe`, `approve`, or `block`. Authorization requires specific OAuth scopes. A successful response is a generic HTTP response.\n"]]
