Method: mobiledevices.action
Stay organized with collections
Save and categorize content based on your preferences.
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 2025-03-25 UTC.
[null,null,["Last updated 2025-03-25 UTC."],[],[],null,["# Method: mobiledevices.action\n\nTakes an action that affects a mobile device. For example, remotely wiping a device.\n\n### HTTP request\n\n`POST https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}/action`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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](https://developers.google.com/workspace/admin/directory/v1/reference/users). |\n| `resourceId` | `string` The unique ID the API service uses to identify the mobile device. |\n\n### Request body\n\nThe request body contains an instance of [MobileDeviceAction](/workspace/admin/directory/reference/rest/v1/mobiledevices/action#MobileDeviceAction).\n\n### Response body\n\nIf successful, the response is a generic HTTP response whose format is defined by the method.\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/admin.directory.device.mobile`\n- `\n https://www.googleapis.com/auth/admin.directory.device.mobile.action`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nMobileDeviceAction\n------------------\n\n| JSON representation |\n|------------------------------|\n| ``` { \"action\": string } ``` |\n\n| Fields ||\n|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `action` | `string` \u003cbr /\u003e The action to be performed on the device. Acceptable values are: - `admin_remote_wipe` - `admin_account_wipe` - `approve` - `block` - `cancel_remote_wipe_then_activate` - `cancel_remote_wipe_then_block` |"]]
