Important: We are no longer accepting new registrations for the Play EMM API.
Learn more.
Users: update
Stay organized with collections
Save and categorize content based on your preferences.
Updates the details of an EMM-managed user.
Can be used with EMM-managed users only (not Google managed users).
Pass the new details in the
Users
resource in the request body. Only the displayName field
can be changed. Other fields must either be unset or have the
currently active value.
Request
HTTP request
PUT https://www.googleapis.com/androidenterprise/v1/enterprises/enterpriseId/users/userId
Parameters
| Parameter name |
Value |
Description |
| Path parameters |
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 a Users resource with the following properties:
| Property name |
Value |
Description |
Notes |
| Optional Properties |
displayName |
string |
The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts. |
writable
|
Response
If successful, this method returns a Users resource in the response body.
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\u003eUpdates the \u003ccode\u003edisplayName\u003c/code\u003e of an EMM-managed user, requiring authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/androidenterprise\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eThe request must be a \u003ccode\u003ePUT\u003c/code\u003e request sent to \u003ccode\u003ehttps://www.googleapis.com/androidenterprise/v1/enterprises/enterpriseId/users/userId\u003c/code\u003e, replacing \u003ccode\u003eenterpriseId\u003c/code\u003e and \u003ccode\u003euserId\u003c/code\u003e with their respective values.\u003c/p\u003e\n"],["\u003cp\u003eOnly the \u003ccode\u003edisplayName\u003c/code\u003e field can be updated; all other fields must remain unchanged or unset.\u003c/p\u003e\n"],["\u003cp\u003eThis operation is exclusively for EMM-managed users and is not applicable to Google-managed users.\u003c/p\u003e\n"]]],[],null,["# Users: update\n\n| **Note:** Requires [authorization](#auth).\n\nUpdates the details of an EMM-managed user.\n\n\u003cbr /\u003e\n\n\nCan be used with EMM-managed users only (not Google managed users).\nPass the new details in the\n[Users](/android/work/play/emm-api/v1/users)\nresource in the request body. Only the `displayName` field\ncan be changed. Other fields must either be unset or have the\ncurrently active value.\n\nRequest\n-------\n\n### HTTP request\n\n```\nPUT https://www.googleapis.com/androidenterprise/v1/enterprises/enterpriseId/users/userId\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|----------------|----------|---------------------------|\n| **Path parameters** |||\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 a [Users resource](/android/work/play/emm-api/v1/users#resource) with the following properties:\n\n| Property name | Value | Description | Notes |\n|---------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|\n| **Optional Properties** ||||\n| `displayName` | `string` | The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as \"Example, Inc.\") or your name (as EMM). Not used for Google-managed user accounts. | writable |\n\nResponse\n--------\n\nIf successful, this method returns a [Users resource](/android/work/play/emm-api/v1/users#resource) in the response body."]]