La API de Directory proporciona métodos programáticos para crear, actualizar y borrar usuarios. También puedes obtener información sobre usuarios individuales o listas de usuarios que cumplen con criterios específicos. A continuación, se incluyen ejemplos de algunas operaciones básicas del usuario.
Crear una cuenta de usuario
Puedes agregar una cuenta de usuario a cualquiera de los dominios de tu cuenta de Google Workspace. Antes de agregar una cuenta de usuario, confirma la propiedad del dominio.
Si actualizaste tu cuenta personal de Gmail a una cuenta de correo electrónico empresarial con tu propio nombre de dominio, no podrás crear cuentas de usuario nuevas hasta que desbloquees la configuración adicional de Google Workspace. Para obtener más información, consulta Cuentas de correo electrónico de G Suite Business actualizadas a G Suite Basic.
Para crear una cuenta de usuario con uno de tus dominios, utiliza la siguiente solicitud POST y, luego, incluye la autorización que se describe en Más información sobre la autenticación y la autorización. Puedes ver los permisos disponibles para la API de Directory en la lista de permisos de OAuth 2.0. Para conocer las propiedades de la cadena de consulta de la solicitud, consulta el método users.insert().
POST https://admin.googleapis.com/admin/directory/v1/users
Todas las solicitudes de creación requieren que envíes la información necesaria para completarlas. Si usas bibliotecas cliente, estas convierten los objetos de datos del lenguaje que elegiste en objetos con formato de datos JSON.
Solicitud JSON
En el siguiente JSON, se muestra una solicitud de ejemplo para crear un usuario. Para obtener la lista completa de las propiedades de solicitud y respuesta, consulta la referencia de la API.
{ "primaryEmail": "[email protected]", "name": { "givenName": "Elizabeth", "familyName": "Smith" }, "suspended": false, "password": "new user password", "hashFunction": "SHA-1", "changePasswordAtNextLogin": false, "ipWhitelisted": false, "ims": [ { "type": "work", "protocol": "gtalk", "im": "[email protected]", "primary": true } ], "emails": [ { "address": "[email protected]", "type": "home", "customType": "", "primary": true } ], "addresses": [ { "type": "work", "customType": "", "streetAddress": "1600 Amphitheatre Parkway", "locality": "Mountain View", "region": "CA", "postalCode": "94043" } ], "externalIds": [ { "value": "12345", "type": "custom", "customType": "employee" } ], "organizations": [ { "name": "Google Inc.", "title": "SWE", "primary": true, "type": "work", "description": "Software engineer" } ], "phones": [ { "value": "+1 nnn nnn nnnn", "type": "work" } ], "orgUnitPath": "/corp/engineering", "includeInGlobalAddressList": true }
Si tu tasa de consultas para las solicitudes de creación es demasiado alta, es posible que recibas respuestas HTTP 503 del servidor de la API que indiquen que se excedió tu cuota. Si recibes estas respuestas, usa un algoritmo de retirada exponencial para reintentar tus solicitudes.
Ten en cuenta lo siguiente sobre una cuenta nueva:
- Si la Cuenta de Google compró licencias de correo electrónico, se asignará automáticamente un buzón de correo a la cuenta de usuario nueva. Esta tarea puede tardar unos minutos en completarse y activarse.
- El servicio de la API ignora de forma silenciosa la edición de un campo de solo lectura en una solicitud, como
isAdmin. - La cantidad máxima de dominios permitidos en una cuenta es de 600 (1 dominio principal + 599 dominios adicionales).
- Si no se asignó a un usuario a una unidad organizativa específica cuando se creó la cuenta de usuario, esta se encuentra en la unidad organizativa de nivel superior. La unidad organizativa de un usuario determina a qué servicios de Google Workspace tiene acceso. Si se traslada a un usuario a una organización nueva, su acceso cambia. Para obtener más información sobre las estructuras de organización, consulta el Centro de ayuda de administración. Para obtener más información sobre cómo trasladar a un usuario a otra organización, consulta Cómo actualizar un usuario.
- Se requiere un
passwordpara las cuentas de usuario nuevas. Si se especifica unhashFunction, la contraseña debe ser una clave de hash válida. Si no se especifica, la contraseña debe estar en texto simple y tener entre 8 y 100 caracteres ASCII. Para obtener más información, consulta la Referencia de la API. - En el caso de los usuarios que tienen un plan flexible de Google Workspace, crear usuarios con esta API tendrá un impacto monetario y generará cargos en la cuenta de facturación de tu cliente. Para obtener más información, consulta la información de facturación de la API.
- Una cuenta de Google Workspace puede incluir cualquiera de tus dominios. En una cuenta de varios dominios, los usuarios de un dominio pueden compartir servicios con usuarios de otros dominios de la cuenta. Para obtener más información sobre los usuarios en varios dominios, consulta la información sobre varios dominios de la API.
- Es posible que haya cuentas en conflicto. Comprueba si las personas que planeas agregar ya tienen una Cuenta de Google. Luego, sigue los pasos para evitar conflictos con esas cuentas. Consulta Cómo buscar y resolver cuentas en conflicto.
- Es posible que haya cuentas de visitante. Si los usuarios invitan a personas ajenas a tu organización que no tienen Cuentas de Google a colaborar en Drive, recibirán cuentas de visitante, con el formato nombre_de_usuario_del_visitante@tu_dominio.com. Si agregas un usuario con el mismo nombre de usuario que una cuenta de visitante, esta se convertirá en una cuenta completa de Google Workspace. La cuenta conservará sus permisos de archivos de Drive actuales. Consulta Cómo compartir documentos con los visitantes.
Una respuesta correcta muestra un código de estado HTTP 200. Junto con el código de estado, la respuesta devuelve las propiedades de la nueva cuenta de usuario.
Actualiza una cuenta de usuario
Para actualizar una cuenta de usuario, usa la siguiente solicitud PUT y, luego, incluye la autorización que se describe en Autorizar solicitudes. El userKey puede ser la dirección de correo electrónico principal del usuario, el id del usuario único o una de las direcciones de correo electrónico de alias del usuario.
PUT https://admin.googleapis.com/admin/directory/v1/users/userKey
Tanto el cuerpo de la solicitud como el de la respuesta contienen una instancia de User. Sin embargo, la API de Directory admite semántica de parche, por lo que solo debes enviar los campos actualizados en tu solicitud.
Solicitud de muestra
En el siguiente ejemplo, el givenName del usuario era “Elizabeth” cuando se creó la cuenta de usuario, y solo se proporcionó una dirección de correo electrónico de trabajo.
{
"name": {
"givenName": "Elizabeth",
"familyName": "Smith"
},
"emails": [
{
"address": "[email protected]",
"type": "work",
"primary": true
}
}
La siguiente solicitud actualiza givenName de “Elizabeth” a “Liz” y también agrega una dirección de correo electrónico particular. Ten en cuenta que ambas direcciones de correo electrónico se proporcionan por completo porque el campo es un array.
PUT https://admin.googleapis.com/admin/directory/v1/users/[email protected]
{
"name": {
"givenName": "Liz",
},
"emails": [
{
"address": "[email protected]",
"type": "work",
"primary": true
},
{
"address": "[email protected]",
"type": "home"
}
]
}
Una respuesta correcta muestra un código de estado HTTP 200 y un recurso User con los campos actualizados.
Ten en cuenta lo siguiente cuando actualices el nombre de la cuenta de un usuario:
- Si cambias el nombre de una cuenta de usuario, se cambia la dirección de correo electrónico principal y el dominio que se usa cuando se recupera la información de este usuario. Antes de cambiar el nombre de un usuario, te recomendamos que lo desconectes de todas las sesiones y los servicios del navegador.
- El proceso de cambiar el nombre de una cuenta de usuario puede tardar hasta 10 minutos en propagarse a todos los servicios.
- Cuando cambias el nombre de un usuario, el nombre anterior se conserva como alias para garantizar la entrega continua de correo electrónico en el caso de la configuración de reenvío de correo electrónico y no está disponible como nombre de usuario nuevo.
- En general, también recomendamos no usar la dirección de correo electrónico del usuario como clave para los datos persistentes, ya que esta dirección está sujeta a cambios.
- Para obtener una lista completa de los efectos de cambiar el nombre de un usuario en las apps de Google Workspace, consulta el Centro de ayuda para administradores.
Convierte a un usuario en administrador
Para que el usuario sea un administrador avanzado, usa la siguiente solicitud POST y, luego, incluye la autorización que se describe en Cómo autorizar solicitudes. userKey puede ser la dirección de correo electrónico principal del usuario, el id del usuario único o una de las direcciones de correo electrónico de alias del usuario. Para conocer las propiedades de solicitud y respuesta, consulta la referencia de la API. Para obtener más información sobre los superadministradores, consulta el Centro de ayuda de administración.
POST https://admin.googleapis.com/admin/directory/v1/users/userKey/makeAdminSolicitud JSON
En este ejemplo, el usuario cuyo userKey es [email protected] se convirtió en administrador avanzado:
POST https://admin.googleapis.com/admin/directory/v1/users/[email protected]/makeAdmin
{
"status": true
}Una respuesta correcta muestra un código de estado HTTP 200.
Administra las relaciones de los usuarios
La API de Directory usa el campo relations para definir diferentes tipos de relaciones entre los usuarios. En un entorno empresarial, las personas suelen usar este campo para las relaciones entre gerente y empleado, y asistente, pero también admite muchos otros tipos. La relación se muestra en la tarjeta “Personas relacionadas” del usuario en cualquier aplicación de Google Workspace que admita la tarjeta. Para ver ejemplos de dónde se muestra la tarjeta, consulta Agrega información al perfil del directorio de un usuario.
Crea una relación entre los usuarios
Puedes definir una relación en una sola dirección, a partir del usuario “propietario”, cuyo registro incluye el campo relations. type describe la relación de la otra persona con el usuario propietario. Por ejemplo, en una relación entre gerente y empleado, el empleado es el usuario propietario y agregas un campo relations a su cuenta con el tipo manager. Para ver los tipos permitidos, consulta la referencia del objeto User.
Para configurar la relación, crea o actualiza
el usuario propietario con un cuerpo de solicitud JSON que incluya el campo relations.
Puedes crear varias relaciones en una sola solicitud.
{
"relations": [
{
"value": "EMAIL_ADDRESS_RELATION_1",
"type": "manager"
},
{
"value": "EMAIL_ADDRESS_RELATION_2",
"type": "dotted_line_manager"
}
]
}
Cómo actualizar o borrar una relación
Solo puedes actualizar el campo relations como un todo. No puedes dirigirte a las personas individuales que aparecen en la lista para cambiar el tipo de relación ni quitarlas. En el ejemplo anterior, para quitar la relación de administrador existente
y hacer que el administrador de línea punteada sea el administrador del usuario propietario, actualiza
la cuenta del usuario propietario con todos los valores del campo como quieras.
{
"relations": [
{
"value": "EMAIL_ADDRESS_RELATION_2",
"type": "manager"
}
]
}
Para quitar todas las relaciones del usuario propietario, establece relations como vacío:
{
"relations": []
}
Cómo recuperar un usuario
Para recuperar un usuario, usa la siguiente solicitud GET y, luego, incluye la autorización que se describe en Autorizar solicitudes. userKey puede ser la dirección de correo electrónico principal del usuario, el id del usuario único o una de las direcciones de correo electrónico de alias del usuario. Para conocer las propiedades de solicitud y respuesta, consulta la referencia de la API.
GET https://admin.googleapis.com/admin/directory/v1/users/userKeyEn este ejemplo, se muestran las propiedades de la cuenta de usuario cuyo alias o dirección de correo electrónico principal es [email protected]:
GET https://admin.googleapis.com/admin/directory/v1/users/[email protected]
Respuesta JSON
Una respuesta correcta muestra un código de estado HTTP 200. Junto con el código de estado, la respuesta devuelve las propiedades de la cuenta de usuario.
{ "kind": "directory#user", "id": "the unique user id", "primaryEmail": "[email protected]", "name": { "givenName": "Liz", "familyName": "Smith", "fullName": "Liz Smith" }, "isAdmin": true, "isDelegatedAdmin": false, "lastLoginTime": "2013-02-05T10:30:03.325Z", "creationTime": "2010-04-05T17:30:04.325Z", "agreedToTerms": true, "hashFunction": "SHA-1", "suspended": false, "changePasswordAtNextLogin": false, "ipWhitelisted": false, "ims": [ { "type": "work", "protocol": "gtalk", "im": "[email protected]", "primary": true } ], "emails": [ { "address": "[email protected]", "type": "home", "customType": "", "primary": true } ], "addresses": [ { "type": "work", "customType": "", "streetAddress": "1600 Amphitheatre Parkway", "locality": "Mountain View", "region": "CA", "postalCode": "94043" } ], "externalIds": [ { "value": "employee number", "type": "custom", "customType": "office" } ], "organizations": [ { "name": "Google Inc.", "title": "SWE", "primary": true, "customType": "", "description": "Software engineer" } ], "phones": [ { "value": "+1 nnn nnn nnnn", "type": "work" } ], "aliases": [ "[email protected]", "[email protected]" ], "nonEditableAliases": [ "[email protected]" ], "customerId": "C03az79cb", "orgUnitPath": "corp/engineering", "isMailboxSetup": true, "includeInGlobalAddressList": true }
Cómo recuperar todos los usuarios de un dominio
Para recuperar todos los usuarios del mismo dominio, usa la siguiente solicitud GET y, luego, incluye la autorización que se describe en Autorizar solicitudes. Para facilitar la lectura, este ejemplo usa saltos de línea:
GET https://admin.googleapis.com/admin/directory/v1/users ?domain=primary domain name&pageToken=token for next results page &maxResults=max number of results per page &orderBy=email, givenName, or familyName &sortOrder=ascending or descending &query=email, givenName, or familyName:the query's value*
Para conocer las propiedades de solicitud y respuesta, consulta la referencia de la API.
Respuesta JSON
En este ejemplo, se muestran todos los usuarios del dominio example.com con un máximo de 2 dominios de usuario por página de respuesta. Hay un nextPageToken para la lista de seguimiento de usuarios en esta respuesta. De forma predeterminada, el sistema muestra una lista de 100 usuarios en orden alfabético según la dirección de correo electrónico:
GET https://admin.googleapis.com/admin/directory/v1/users?domain=example.com&maxResults=2
Una respuesta correcta muestra un código de estado HTTP 200. Junto con el código de estado, la respuesta devuelve 2 cuentas de usuario en el dominio example.com (maxResults=2):
{ "kind": "directory#users", "users": [ { "kind": "directory#user", "id": "the unique user id", "primaryEmail": "[email protected]", "name": { "givenName": "Liz", "familyName": "Smith", "fullName": "Liz Smith" }, "isAdmin": true, "isDelegatedAdmin": false, "lastLoginTime": "2013-02-05T10:30:03.325Z", "creationTime": "2010-04-05T17:30:04.325Z", "agreedToTerms": true, "hashFunction": "SHA-1", "suspended": false, "changePasswordAtNextLogin": false, "ipWhitelisted": false, "ims": [ { "type": "work", "protocol": "gtalk", "im": "[email protected]", "primary": true } ], "emails": [ { "address": "[email protected]", "type": "work", "customType": "", "primary": true } ], "addresses": [ { "type": "work", "customType": "", "streetAddress": "1600 Amphitheatre Parkway", "locality": "Mountain View", "region": "CA", "postalCode": "94043" } ], "externalIds": [ { "value": "employee number", "type": "custom", "customType": "office" } ], "organizations": [ { "name": "Google Inc.", "title": "SWE", "primary": true, "customType": "", "description": "Software engineer" } ], "phones": [ { "value": "+1 nnn nnn nnnn", "type": "work" } ], "aliases": [ "[email protected]", "[email protected]" ], "nonEditableAliases": [ "[email protected]" ], "customerId": "C03az79cb", "orgUnitPath": "corp/engineering", "isMailboxSetup": true, "includeInGlobalAddressList": true }, { "kind": "directory#user", "id": "user unique ID", "primaryEmail": "[email protected]", "name": { "givenName": "admin", "familyName": "two", "fullName": "admin two" }, "isAdmin": true, "isDelegatedAdmin": true, "lastLoginTime": "2013-02-05T10:30:03.325Z", "creationTime": "2010-04-05T17:30:04.325Z", "agreedToTerms": true, "hashFunction": "SHA-1", "suspended": true, "suspensionReason": "ADMIN", "changePasswordAtNextLogin": false, "ipWhitelisted": false, "emails": [ { "address": "[email protected]", "type": "work", "customType": "", "primary": true } ], "externalIds": [ { "value": "contractor license number", "type": "custom", "customType": "work" } ], "aliases": [ "[email protected]" ], "nonEditableAliases": [ "[email protected]" ], "customerId": "C03az79cb", "orgUnitPath": "corp/engineering", "isMailboxSetup": true, "includeInGlobalAddressList": true } ], "nextPageToken": "next page token" }
Cómo recuperar todos los usuarios de la cuenta
Para recuperar todos los usuarios de una cuenta que puede constar de varios dominios, usa la siguiente solicitud GET y, luego, incluye la autorización que se describe en Autorizar solicitudes. Para facilitar la lectura, este ejemplo usa saltos de línea:
GET https://admin.googleapis.com/admin/directory/v1/users ?customer=my_customer or customerId&pageToken=token for next results page &maxResults=max number of results per page &orderBy=email, givenName, or familyName &sortOrder=ascending or descending &query=user attributes
- La cadena de consulta
customeres el valormy_customerocustomerId. - Usa la cadena
my_customerpara representar elcustomerIdde tu cuenta. - Como administrador de revendedor, usa el
customerIddel cliente al que se le revendió el producto. ParacustomerId, usa el nombre de dominio principal de la cuenta en la solicitud de la operación Retrieve all users in a domain. La respuesta resultante tiene el valorcustomerId. - La cadena de consulta opcional
orderBydetermina si la lista se ordena por la dirección de correo electrónico principal, el apellido o el nombre del usuario. Cuando usasorderBy, también puedes usar la cadena de consultasortOrderpara mostrar los resultados en orden ascendente o descendente. - La cadena de consulta opcional
querypermite realizar búsquedas en muchos campos de un perfil de usuario, incluidos los campos principales y personalizados. Consulta Cómo buscar usuarios para ver ejemplos.
Para conocer las propiedades de solicitud y respuesta, consulta la referencia de la API.
En este ejemplo, un administrador de la cuenta solicita que se muestren todos los usuarios de la cuenta con una entrada de usuario en cada página de respuesta. El nextPageToken va a la página de resultados de seguimiento:
GET https://admin.googleapis.com/admin/directory/v1/users?customer=my_customer&maxResults=1
En este ejemplo, un administrador de revendedor solicita todos los usuarios de una cuenta revendida que tiene el valor customerId de C03az79cb.
GET https://admin.googleapis.com/admin/directory/v1/users?customer=C03az79cb&maxResults=1
Respuesta JSON
Una respuesta correcta muestra un código de estado HTTP 200. Junto con el código de estado, la respuesta muestra todos los usuarios de esta cuenta:
{ "kind": "directory#users", "users": [ { "kind": "directory#user", "id": "the unique user id", "username": "[email protected]", "name": { "givenName": "admin", "familyName": "two", "fullName": "admin two" }, "isAdmin": true, "isDelegatedAdmin": true, "lastLoginTime": "2013-02-05T10:30:03.325Z", "creationTime": "2010-04-05T17:30:04.325Z", "agreedToTerms": true, "hashFunction": "SHA-1", "suspended": false, "changePasswordAtNextLogin": false, "ipWhitelisted": false, "emails": [ { "address": "[email protected]", "type": "work", "customType": "", "primary": true } ], "externalIds": [ { "value": "employee number", "type": "custom", "customType": "office" } ], "aliases": [ "[email protected]" ], "nonEditableAliases": [ "[email protected]" ], "customerId": "C03az79cb", "orgUnitPath": "/", "isMailboxSetup": true, "includeInGlobalAddressList": true }, { "kind": "directory#user", "id": "the unique user id", "username": "[email protected]", "name": { "givenName": "Elizabeth", "familyName": "Smith", "fullName": "Elizabeth Smith" }, "isAdmin": false, "isDelegatedAdmin": false, "lastLoginTime": "1336509883546", "creationTime": "1404802800000", "agreedToTerms": false, "hashFunction": "SHA-1", "suspended": false, "changePasswordAtNextLogin": false, "ipWhitelisted": false, "emails": [ { "address": "[email protected]", "type": "home", "customType": "", "primary": true } ], "externalIds": [ { "value": "employee number", "type": "custom", "customType": "bank" } ], "relations": [ { "value": "liz", "type": "friend", "customType": "" } ], "aliases": [ "[email protected]", "[email protected]" ], "nonEditableAliases": [ "[email protected]" ], "customerId": "C03az79cb", "orgUnitPath": "/", "isMailboxSetup": true, "includeInGlobalAddressList": true }, { "kind": "directory#user", "id": "the unique user id", "username": "[email protected]", "name": { "givenName": "Tester", "familyName": "Three", "fullName": "Tester Three" }, "isAdmin": false, "isDelegatedAdmin": false, "lastLoginTime": "1336509883546", "creationTime": "1404802800000", "agreedToTerms": true, "hashFunction": "SHA-1", "suspended": false, "changePasswordAtNextLogin": false, "ipWhitelisted": false, "emails": [ { "address": "[email protected]", "type": "work", "customType": "", "primary": true } ], "externalIds": [ { "value": "employee number", "type": "custom", "customType": "office" } ], "aliases": [ "[email protected]" ], "nonEditableAliases": [ "[email protected]" ], "customerId": "C03az79cb", "orgUnitPath": "/", "isMailboxSetup": true, "includeInGlobalAddressList": true }, { "kind": "directory#user", "id": "the unique user id", "username": "[email protected]", "name": { "givenName": "Admin", "familyName": "Work", "fullName": "Admin Work" }, "isAdmin": true, "isDelegatedAdmin": true, "lastLoginTime": "1336509883546", "creationTime": "1404802800000", "agreedToTerms": true, "hashFunction": "SHA-1", "suspended": false, "changePasswordAtNextLogin": false, "ipWhitelisted": false, "emails": [ { "address": "[email protected]", "type": "work", "customType": "", "primary": true } ], "externalIds": [ { "value": "employee number", "type": "custom", "customType": "office" } ], "aliases": [ "[email protected]" ], "nonEditableAliases": [ "[email protected]" ], "customerId": "C03az79cb", "orgUnitPath": "/", "isMailboxSetup": true, "includeInGlobalAddressList": true } ], "nextPageToken": "NNNNN" }
Cómo recuperar usuarios borrados recientemente
Para recuperar todos los usuarios borrados en los últimos 20 días de una cuenta o de uno de sus dominios, usa las siguientes solicitudes GET y, además, incluye la autorización que se describe en Autorizar solicitudes. Para recuperar un usuario, consulta Cómo recuperar un usuario.
Para recuperar los usuarios borrados en los últimos 20 días del dominio principal de la cuenta o un subdominio, usa la siguiente solicitud GET. La cadena de consulta domain es el nombre de dominio principal del dominio. Para conocer las propiedades de solicitud y respuesta del usuario, consulta la referencia de la API. Además, para facilitar la lectura, este ejemplo usa saltos de línea:
GET https://admin.googleapis.com/admin/directory/v1/users ?domain=primary domain name&pageToken=token for next results page &maxResults=max number of results per page &showDeleted=true
GET. Para facilitar la lectura, este ejemplo usa saltos de línea:
GET https://admin.googleapis.com/admin/directory/v1/users ?customer=my_customer or customerId&pageToken=token for next results page &maxResults=max number of results per page&showDeleted=true
- La cadena de consulta
customeres el valormy_customerocustomerId. - Como administrador de la cuenta, usa la cadena
my_customerpara representar elcustomerIdde tu cuenta. - Como administrador de revendedor, usa el
customerIddel cliente al que se le revendió el producto. ParacustomerId, usa el nombre de dominio principal de la cuenta en la solicitud de la operación Retrieve all users in a domain. La respuesta resultante tiene el valorcustomerId.
Para conocer las propiedades de solicitud y respuesta, consulta la referencia de la API.
En este ejemplo, un administrador de la cuenta solicita todos los usuarios borrados de la cuenta:
GET https://admin.googleapis.com/admin/directory/v1/users?customer=my_customer&showDeleted=true
Respuesta JSON
Una respuesta correcta muestra un código de estado HTTP 200. Junto con el código de estado, la respuesta muestra todos los usuarios de la cuenta que se borraron en los últimos 20 días:
{ "kind": "directory#users", "users": [ { "kind": "directory#user", "id": "the unique user id", "primaryEmail": "[email protected]" }, { "kind": "directory#user", "id": "the unique user id", "primaryEmail": "[email protected]" } ], "nextPageToken": "token for next page of deleted users" }
Cómo recuperar la foto de un usuario
La API recupera una miniatura de foto, la foto de perfil de Google más reciente. Para recuperar la foto más reciente del usuario, usa la siguiente solicitud GET y, luego, incluye la autorización que se describe en Autorizar solicitudes. userKey puede ser la dirección de correo electrónico principal del usuario, el id del usuario o cualquiera de sus correos electrónicos de alias. Para conocer las propiedades de solicitud y respuesta, consulta la referencia de la API.
GET https://admin.googleapis.com/admin/directory/v1/users/userKey/photos/thumbnailEn este ejemplo, se muestra la foto más reciente de [email protected]:
GET https://admin.googleapis.com/admin/directory/v1/users/[email protected]/photos/thumbnail
JSON Response
Una respuesta correcta muestra un código de estado HTTP 200.
{ "kind": "directory#user#photo", "id": "the unique user id", "primaryEmail": "[email protected]", "mimeType": "the photo mime type", "height": "the photo height in pixels", "width": "the photo width in pixels", "photoData": "web safe base64 encoded photo data" }
La codificación en base64 segura para la Web de tus fotos de la API es similar a la RFC 4648 "base64url". Esto significa lo siguiente:
- El carácter barra (/) se reemplaza por el carácter guion bajo (_).
- El signo más (+) se reemplaza por el guion (-).
- El carácter signo igual (=) se reemplaza por el asterisco (*).
- Para el padding, se usa el carácter punto (.) en lugar de la definición de baseURL de RFC-4648, que usa el signo igual (=) para el padding. Esto se hace para simplificar el análisis de URL.
- Independientemente del tamaño de la foto que se sube, la API la reduce de forma proporcional a 96 × 96 píxeles.
Si necesitas crear vínculos compatibles desde JavaScript, la biblioteca Google Closure incluye funciones de codificación y decodificación de Base64 que se lanzan bajo la licencia Apache.
Cómo recuperar un usuario como usuario no administrador
Si bien solo los administradores pueden modificar las cuentas de usuario, cualquier usuario del dominio puede leer los perfiles de usuario. Un usuario que no es administrador puede realizar una solicitud users.get o users.list con el parámetro viewType igual a domain_public para recuperar el perfil público de un usuario. El alcance https://www.googleapis.com/auth/admin.directory.user.readonly es ideal para este caso de uso.
La vista domain_public permite que un usuario que no es administrador acceda a un conjunto estándar de campos principales. En el caso de un campo personalizado, puedes elegir si debe ser público o privado cuando definas
el esquema.
Actualiza la foto de un usuario
Para actualizar la foto de un usuario, usa la siguiente solicitud PUT y, luego, incluye la autorización que se describe en Autorizar solicitudes. userKey puede ser la dirección de correo electrónico principal del usuario, el id del usuario o cualquiera de los correos electrónicos de los alias del usuario. Para conocer las propiedades de solicitud y respuesta, consulta la referencia de la API.
PUT https://admin.googleapis.com/admin/directory/v1/users/userKey/photos/thumbnailEn este ejemplo, se actualiza la foto de [email protected]:
PUT https://admin.googleapis.com/admin/directory/v1/users/[email protected]/photos/thumbnail
{
"photoData": "web safe base64 encoded photo data"
}Cuando se actualiza una foto, la API ignora height y width.
JSON Response
Una respuesta correcta muestra un código de estado HTTP 200.
{ "kind": "directory#user#photo", "id": "the unique user id", "primaryEmail": "[email protected]", "mimeType": "the photo mime type", "height": "the photo height in pixels", "width": "the photo width in pixels", "photoData": "web safe base64 encoded photo data" }
Cómo borrar la foto de un usuario
Para borrar la foto de un usuario, usa la siguiente solicitud DELETE y, luego, incluye la autorización que se describe en Autorizar solicitudes. userKey puede ser la dirección de correo electrónico principal del usuario, el id del usuario o cualquiera de los correos electrónicos de los alias del usuario. Para conocer las propiedades de solicitud y respuesta, consulta la referencia de la API.
DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/photos/thumbnailUna vez que se borra, no se muestra la foto del usuario. Dondequiera que se requiera la foto de un usuario, se mostrará una silueta.
Borra una cuenta de usuario
Para borrar una cuenta de usuario, usa la siguiente solicitud DELETE y, luego, incluye la autorización que se describe en Autorizar solicitudes. userKey puede ser la dirección de correo electrónico principal del usuario, el id del usuario único o una de las direcciones de correo electrónico de alias del usuario. Para conocer las propiedades de solicitud y respuesta, consulta la referencia de la API.
DELETE https://admin.googleapis.com/admin/directory/v1/users/userKeyEn este ejemplo, se borra la cuenta de usuario [email protected]:
DELETE https://admin.googleapis.com/admin/directory/v1/users/[email protected]
Una respuesta correcta solo muestra un código de estado HTTP 200.
Aspectos importantes que debes tener en cuenta antes de borrar un usuario:
- El usuario borrado ya no podrá acceder.
- Para obtener más información sobre la eliminación de cuentas de usuario, consulta el Centro de ayuda de administración.
Cómo recuperar una cuenta de usuario
Los usuarios borrados en los últimos 20 días deben cumplir con ciertas condiciones para que se pueda restablecer su cuenta.
Para deshacer la eliminación de una cuenta de usuario, usa la siguiente solicitud POST y, luego, incluye la autorización que se describe en Autorizar solicitudes. userKey es el id de usuario único que se encuentra en la respuesta de la operación Retrieve users deleted within the past 20 days. No se puede usar la dirección de correo electrónico principal del usuario ni una de sus direcciones de correo electrónico de alias en userKey para esta operación. Para conocer las propiedades de solicitud y respuesta, consulta la referencia de la API.
POST https://admin.googleapis.com/admin/directory/v1/users/userKey/undeleteEn este ejemplo, el usuario, [email protected], no se borra. Se restablecen todas las propiedades de la cuenta anterior de este usuario:
POST https://admin.googleapis.com/admin/directory/v1/users/12309329403209438205/undelete
Una respuesta correcta solo muestra un código de estado HTTP 204. Para ver la cuenta del usuario que no se borró, usa la operación Recuperar un usuario.