Method: users.get
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Richiesta HTTP
GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri del percorso
Parametri |
userKey |
string
Identifica l'utente nella richiesta API. Il valore può essere l'indirizzo email principale, l'indirizzo email alias o l'ID utente univoco dell'utente.
|
Parametri di query
Parametri |
customFieldMask |
string
Un elenco separato da virgole di nomi di schemi. Vengono recuperati tutti i campi di questi schemi. Questo valore deve essere impostato solo quando projection=custom .
|
projection |
enum (Projection )
Il sottoinsieme di campi da recuperare per questo utente.
|
viewType |
enum (ViewType )
Indica se recuperare la visualizzazione pubblica solo per gli amministratori o a livello di dominio dell'utente. Per saperne di più, vedi Recuperare un utente come utente non amministratore.
|
Corpo della richiesta
Il corpo della richiesta deve essere vuoto.
Corpo della risposta
In caso di esito positivo, il corpo della risposta contiene un'istanza di User
.
Ambiti di autorizzazione
Richiede uno dei seguenti ambiti OAuth:
https://www.googleapis.com/auth/admin.directory.user
https://www.googleapis.com/auth/admin.directory.user.readonly
Per ulteriori informazioni, consulta la Guida all'autorizzazione.
Projection
Enum |
BASIC |
Non includere campi personalizzati per l'utente. |
CUSTOM |
Includi i campi personalizzati dagli schemi richiesti in customFieldMask . |
FULL |
Includi tutti i campi associati a questo utente. |
ViewType
Enum |
admin_view |
I risultati includono sia i campi riservati agli amministratori sia quelli pubblici del dominio per l'utente. |
domain_public |
I risultati includono solo i campi per l'utente che sono visibili pubblicamente agli altri utenti del dominio. |
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-25 UTC.
[null,null,["Ultimo aggiornamento 2025-07-25 UTC."],[],[],null,["Retrieves a user.\n\nHTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|-----------|---------------------------------------------------------------------------------------------------------------------------------------------|\n| `userKey` | `string` Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. |\n\nQuery parameters\n\n| Parameters ||\n|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customFieldMask` | `string` A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`. |\n| `projection` | `enum (`[Projection](/workspace/admin/directory/reference/rest/v1/users/get#Projection)`)` What subset of fields to fetch for this user. |\n| `viewType` | `enum (`[ViewType](/workspace/admin/directory/reference/rest/v1/users/get#ViewType)`)` Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin). |\n\nRequest body\n\nThe request body must be empty.\n\nResponse body\n\nIf successful, the response body contains an instance of [User](/workspace/admin/directory/reference/rest/v1/users#User).\n\nAuthorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/admin.directory.user`\n- `\n https://www.googleapis.com/auth/admin.directory.user.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nProjection\n\n| Enums ||\n|----------|--------------------------------------------------------------------|\n| `BASIC` | Do not include any custom fields for the user. |\n| `CUSTOM` | Include custom fields from schemas requested in `customFieldMask`. |\n| `FULL` | Include all fields associated with this user. |\n\nViewType\n\n| Enums ||\n|-----------------|--------------------------------------------------------------------------------------------------|\n| `admin_view` | Results include both administrator-only and domain-public fields for the user. |\n| `domain_public` | Results only include fields for the user that are publicly visible to other users in the domain. |"]]