Important: We are no longer accepting new registrations for the Play EMM API.
Learn more.
Users: list
Stay organized with collections
Save and categorize content based on your preferences.
Looks up a user by primary email address.
This is only supported for Google-managed users. Lookup of the id is not
needed for EMM-managed users because the id is already returned in the
result of the Users.insert call.
Request
HTTP request
GET https://www.googleapis.com/androidenterprise/v1/enterprises/enterpriseId/users
Parameters
| Parameter name |
Value |
Description |
| Path parameters |
enterpriseId |
string |
The ID of the enterprise.
|
| Required query parameters |
email |
string |
The exact primary email address of the user to look up.
|
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
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{
"kind": "androidenterprise#usersListResponse",
"user": [
users Resource
]
}
| Property name |
Value |
Description |
Notes |
user[] |
list |
A user of an enterprise. |
|
kind |
string |
Identifies what kind of resource this is. Value: the fixed string "androidenterprise#usersListResponse". |
|
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\u003eLooks up a Google-managed user within a specific enterprise using their primary email address.\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\u003eSends an HTTP GET request to the specified URL with enterprise ID and email as parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of users matching the provided email, if found within the enterprise.\u003c/p\u003e\n"],["\u003cp\u003eThis method is not applicable for EMM-managed users as their IDs are obtained during the user creation process.\u003c/p\u003e\n"]]],[],null,["# Users: list\n\n| **Note:** Requires [authorization](#auth).\n\nLooks up a user by primary email address.\nThis is only supported for Google-managed users. Lookup of the id is not\nneeded for EMM-managed users because the id is already returned in the\nresult of the Users.insert call.\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/androidenterprise/v1/enterprises/enterpriseId/users\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|----------------|----------|---------------------------------------------------------|\n| **Path parameters** |||\n| `enterpriseId` | `string` | The ID of the enterprise. |\n| **Required query parameters** |||\n| `email` | `string` | The exact primary email address of the user to look up. |\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\nDo not supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure:\n\n```objective-c\n{\n \"kind\": \"androidenterprise#usersListResponse\",\n \"user\": [\n users Resource\n ]\n}\n```\n\n| Property name | Value | Description | Notes |\n|---------------|----------|------------------------------------------------------------------------------------------------------------|-------|\n| `user[]` | `list` | A user of an enterprise. | |\n| `kind` | `string` | Identifies what kind of resource this is. Value: the fixed string `\"androidenterprise#usersListResponse\"`. | |"]]