Method: users.get

Recupera un usuario.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
userKey

string

Identifica al usuario en la solicitud a la API. El valor puede ser la dirección de correo electrónico principal del usuario, la dirección de correo electrónico de alias o el ID de usuario único.

Parámetros de consulta

Parámetros
customFieldMask

string

Una lista de nombres de esquemas separados por comas. Se recuperan todos los campos de estos esquemas. Solo se debe configurar cuando projection=custom.

projection

enum (Projection)

Es el subconjunto de campos que se recuperarán para este usuario.

viewType

enum (ViewType)

Indica si se debe recuperar la vista pública del usuario solo para administradores o para todo el dominio. Para obtener más información, consulta Cómo recuperar un usuario como no administrador.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de User.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta la Guía de autorización.

Proyección

Enumeraciones
BASIC No incluyas ningún campo personalizado para el usuario.
CUSTOM Incluye campos personalizados de los esquemas solicitados en customFieldMask.
FULL Incluye todos los campos asociados con este usuario.

ViewType

Enumeraciones
admin_view Los resultados incluyen campos públicos del dominio y de solo administrador para el usuario.
domain_public Los resultados solo incluyen campos del usuario que son visibles públicamente para otros usuarios del dominio.