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 da API. O valor pode ser o endereço de e-mail principal, o endereço de e-mail de alias ou o ID exclusivo do usuário.

Parâmetros de consulta

Parâmetros
customFieldMask

string

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

enum (Projection)

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

enum (ViewType)

Indica se a visualização pública do usuário é somente para administradores ou para todo o domínio. Para mais informações, consulte 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 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

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

ViewType

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