Important: We are no longer accepting new registrations for the Play EMM API.
Learn more.
Devices: setState
Stay organized with collections
Save and categorize content based on your preferences.
Sets whether a device's access to Google services is enabled or disabled.
The device state takes effect only if enforcing EMM policies on Android
devices is enabled in the Google Admin Console.
Otherwise, the device state is ignored and all devices are allowed access
to Google services.
This is only supported for Google-managed users.
Request
HTTP request
PUT https://www.googleapis.com/androidenterprise/v1/enterprises/enterpriseId/users/userId/devices/deviceId/state
Parameters
| Parameter name |
Value |
Description |
| Path parameters |
deviceId |
string |
The ID of the device.
|
enterpriseId |
string |
The ID of the enterprise.
|
userId |
string |
The ID of the user.
|
Authorization
This request requires authorization with the following scope:
| Scope |
|---|
https://www.googleapis.com/auth/androidenterprise |
For more information, see the authentication and authorization page.
Request body
In the request body, supply data with the following structure:
{
"kind": "androidenterprise#deviceState",
"accountState": string
}
| Property name |
Value |
Description |
Notes |
accountState |
string |
The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.
Acceptable values are:
|
|
kind |
string |
|
|
Response
If successful, this method returns a response body with the following structure:
{
"kind": "androidenterprise#deviceState",
"accountState": string
}
| Property name |
Value |
Description |
Notes |
accountState |
string |
The state of the Google account on the device. "enabled" indicates that the Google account on the device can be used to access Google services (including Google Play), while "disabled" means that it cannot. A new device is initially in the "disabled" state.
Acceptable values are:
|
|
kind |
string |
|
|
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-10-31 UTC.
[null,null,["Last updated 2024-10-31 UTC."],[[["\u003cp\u003eEnables or disables a device's access to Google services for Google-managed users.\u003c/p\u003e\n"],["\u003cp\u003eDevice state enforcement requires enabling EMM policies in the Google Admin Console.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/androidenterprise\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eUses a PUT request to update the device state to either "enabled" or "disabled".\u003c/p\u003e\n"]]],[],null,["# Devices: setState\n\n| **Note:** Requires [authorization](#auth).\n\nSets whether a device's access to Google services is enabled or disabled.\nThe device state takes effect only if enforcing EMM policies on Android\ndevices is enabled in the Google Admin Console.\nOtherwise, the device state is ignored and all devices are allowed access\nto Google services.\nThis is only supported for Google-managed users.\n\nRequest\n-------\n\n### HTTP request\n\n```\nPUT https://www.googleapis.com/androidenterprise/v1/enterprises/enterpriseId/users/userId/devices/deviceId/state\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|----------------|----------|---------------------------|\n| **Path parameters** |||\n| `deviceId` | `string` | The ID of the device. |\n| `enterpriseId` | `string` | The ID of the enterprise. |\n| `userId` | `string` | The ID of the user. |\n\n### Authorization\n\nThis request requires authorization with the following scope:\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/androidenterprise` |\n\nFor more information, see the [authentication and authorization](/android/work/play/emm-api/v1/how-tos/authorizing) page.\n\n### Request body\n\nIn the request body, supply data with the following structure:\n\n```text\n{\n \"kind\": \"androidenterprise#deviceState\",\n \"accountState\": string\n}\n```\n\n| Property name | Value | Description | Notes |\n|----------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `accountState` | `string` | The state of the Google account on the device. \"enabled\" indicates that the Google account on the device can be used to access Google services (including Google Play), while \"disabled\" means that it cannot. A new device is initially in the \"disabled\" state. \u003cbr /\u003e Acceptable values are: - \"`disabled`\" - \"`enabled`\" | |\n| `kind` | `string` | | |\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure:\n\n```text\n{\n \"kind\": \"androidenterprise#deviceState\",\n \"accountState\": string\n}\n```\n\n| Property name | Value | Description | Notes |\n|----------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `accountState` | `string` | The state of the Google account on the device. \"enabled\" indicates that the Google account on the device can be used to access Google services (including Google Play), while \"disabled\" means that it cannot. A new device is initially in the \"disabled\" state. \u003cbr /\u003e Acceptable values are: - \"`disabled`\" - \"`enabled`\" | |\n| `kind` | `string` | | |"]]