Method: users.get

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

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, endereço de e-mail de alias ou ID exclusivo do usuário.

Parâmetros de consulta

Parâmetros
customFieldMask

string

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

projection

enum (Projection)

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

viewType

enum (ViewType)

Define se o usuário buscará a visualização pública somente do administrador ou do domínio. Veja mais informações em Recuperar um usuário como 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 a Visão geral do OAuth 2.0.

Projection

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

Tipo de vista

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