Method: users.get

Recupera um usuário.

Solicitação HTTP

GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
userKey

string

Identifica o usuário na solicitação de API. O valor pode ser o endereço de e-mail principal do usuário, o endereço de e-mail do alias ou o ID de usuário único.

Parâmetros de consulta

Parâmetros
customFieldMask

string

Uma lista separada por vírgulas de nomes de esquema. Todos os campos desses esquemas são buscados. Isso só deve ser definido quando projection=custom.

projection

enum (Projection)

O subconjunto de campos a ser buscado para este usuário.

viewType

enum (ViewType)

Se deve buscar a visualização pública somente de administrador ou de todo o domínio do usuário. Para mais informações, consulte Recuperar um usuário como um não administrador.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de User.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.user.readonly

Para mais informações, consulte o Guia de autorização.

Projection

Enums
BASIC Não inclua campos personalizados para o usuário.
CUSTOM Inclua campos personalizados dos esquemas solicitados em customFieldMask.
FULL Inclua todos os campos associados a este usuário.

Tipo de visualização

Enums
admin_view Os resultados incluem campos apenas do administrador e de domínio público do usuário.
domain_public Os resultados incluem apenas campos do usuário visíveis publicamente para outros usuários no domínio.