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, o endereço de e-mail do alias ou o 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. Só precisa ser definido quando projection=custom.
projection

enum (Projection)

Qual subconjunto de campos buscar para esse usuário.
viewType

enum (ViewType)

Define se a visualização pública do usuário será buscada somente pelo administrador ou em todo o domínio. Para mais informações, consulte Recuperar um usuário que 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 do 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.

Projeção

Tipos enumerados
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.

ViewType

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