REST Resource: users

Recurso: User

La API de Directorio le permite crear y administrar los usuarios, los alias y las fotos de perfil de Google de su cuenta. Para obtener más información sobre las tareas comunes, consulta la Guía para desarrolladores sobre cuentas de usuario y la Guía para desarrolladores sobre alias de usuario.

Representación JSON

{ "id": string, "primaryEmail": string, "password": value, "hashFunction": string, "isAdmin": boolean, "isDelegatedAdmin": boolean, "agreedToTerms": boolean, "suspended": boolean, "changePasswordAtNextLogin": boolean, "ipWhitelisted": boolean, "name": { object (UserName) }, "kind": string, "etag": string, "emails": value, "externalIds": value, "relations": value, "aliases": [ string ], "isMailboxSetup": boolean, "customerId": string, "addresses": value, "organizations": value, "lastLoginTime": string, "phones": value, "suspensionReason": string, "thumbnailPhotoUrl": string, "languages": value, "posixAccounts": value, "creationTime": string, "nonEditableAliases": [ string ], "sshPublicKeys": value, "notes": value, "websites": value, "locations": value, "includeInGlobalAddressList": boolean, "keywords": value, "deletionTime": string, "gender": value, "thumbnailPhotoEtag": string, "ims": value, "customSchemas": value, "isEnrolledIn2Sv": boolean, "isEnforcedIn2Sv": boolean, "archived": boolean, "orgUnitPath": string, "recoveryEmail": string, "recoveryPhone": string }

Campos
id	string El ID único del usuario. Un usuario id se puede usar como userKey de un URI de solicitud de usuario.
primaryEmail	string La dirección de correo electrónico principal del usuario. Esta propiedad es obligatoria en una solicitud para crear una cuenta de usuario. El elemento primaryEmail debe ser único y no puede ser un alias de otro usuario.
password	value (Value format) Almacena la contraseña para la cuenta de usuario. El valor de la contraseña del usuario es obligatorio al crear una cuenta de usuario. Es opcional cuando se actualiza un usuario. Solo se debe proporcionar si el usuario actualiza la contraseña de su cuenta. El valor de la contraseña nunca se muestra en el cuerpo de la respuesta de la API. Una contraseña puede contener cualquier combinación de caracteres ASCII y debe tener entre 8 y 100 caracteres. Recomendamos enviar el parámetro password como un valor de hash con codificación hexadecimal y configurar hashFunction según corresponda. Si se especifica hashFunction, la contraseña debe ser una clave hash válida.
hashFunction	string Almacena el formato hash de la propiedad password. Se permiten los siguientes valores de hashFunction: MD5: Acepta valores simples con codificación hexadecimal. SHA-1: Acepta valores simples con codificación hexadecimal. crypt: Cumple con la biblioteca de encriptación C. Admite los algoritmos de hash DES, MD5 (prefijo hash $1$), SHA-256 (prefijo hash $5$) y SHA-512 (prefijo hash $6$). Si las rondas se especifican como parte del prefijo, deben ser 10,000 o menos.
isAdmin	boolean Solo salida. Indica un usuario con privilegios de administrador avanzado. La propiedad isAdmin solo se puede editar en la operación Convertir a un usuario en administrador ( método makeAdmin). Si se edita en los métodos insert o update del usuario, el servicio de la API ignora la edición.
isDelegatedAdmin	boolean Solo salida. Indica si el usuario es un administrador delegado. Los administradores delegados son compatibles con la API, pero no pueden crear ni recuperar usuarios, ni convertirlos en administradores de usuarios. El servicio de la API ignora estas solicitudes. Las funciones y los privilegios de los administradores se asignan a través de la Consola del administrador.
agreedToTerms	boolean Solo salida. Esta propiedad es true si el usuario completó un acceso inicial y aceptó las Condiciones del Servicio.
suspended	boolean Indica si el usuario está suspendido.
changePasswordAtNextLogin	boolean Indica si el usuario se ve obligado a cambiar su contraseña la próxima vez que acceda. Esta configuración no se aplica cuando el usuario accede a través de un proveedor de identidad de terceros.
ipWhitelisted	boolean Si es true, la dirección IP del usuario está sujeta a una configuración de dirección IP allowlist obsoleta.
name	object (UserName) Contiene los nombres de pila y apellido del usuario, y el valor de solo lectura fullName. La cantidad máxima de caracteres en givenName y en los valores de familyName es de 60. Además, los valores de nombre admiten caracteres unicode/UTF-8, y pueden contener espacios, letras (a-z), números (0-9), guiones (-), barras diagonales (/) y puntos (.). Para obtener más información sobre las reglas de uso de caracteres, consulte el Centro de ayuda para la administración. El tamaño máximo de datos permitido para este campo es de 1 KB.
kind	string Solo salida. Tipo de recurso de la API. Para los recursos de usuarios, el valor es admin#directory#user.
etag	string Solo salida. ETag del recurso.
emails	value (Value format) Es la lista de las direcciones de correo electrónico del usuario. El tamaño máximo permitido para los datos es de 10 KB. Campos emails[].address string La dirección de correo electrónico del usuario. También sirve como ID de correo electrónico. Este valor puede ser la dirección de correo electrónico principal del usuario o un alias. emails[].customType string Si la dirección de correo electrónico type es custom, esta propiedad contiene el valor personalizado y debe configurarse. emails[].primary boolean Indica si este es el correo electrónico principal del usuario. Solo se puede marcar una entrada como principal. emails[].type string Es el tipo de cuenta de correo electrónico. Si se configura como custom, también se debe configurar customType. Valores aceptables: custom, home, other, work.
externalIds	value (Value format) La lista de ID externos del usuario, como el ID de empleado o red. El tamaño máximo permitido para los datos es de 2 KB. Campos externalIds[].customType string Si el ID externo type es custom, esta propiedad contiene el valor personalizado y se debe establecer. externalIds[].type string El tipo de ID externo. Si se configura como custom, también se debe configurar customType. Valores aceptables: account, custom, customer, login_id, network, organization. externalIds[].value string El valor del ID externo.
relations	value (Value format) La lista de las relaciones del usuario con otros usuarios. El tamaño máximo de datos permitido para este campo es de 2 KB. Para obtener más información, consulta Administra cuentas de usuario. Campos relations[].customType string Si la relación type es custom, esta propiedad contiene el valor personalizado y se debe establecer. relations[].type string El tipo de relación. Si se configura como custom, también se debe configurar customType. Valores aceptables: admin_assistant assistant brother child custom domestic_partner dotted_line_manager exec_assistant father friend manager mother parent partner referred_by relative sister spouse relations[].value string La dirección de correo electrónico de la persona con la que está relacionado el usuario.
aliases[]	string Solo salida. La lista de las direcciones de correo electrónico del alias del usuario.
isMailboxSetup	boolean Solo salida. Indica si se creó el buzón de Google del usuario. Esta propiedad solo se aplica si se le asignó una licencia de Gmail al usuario.
customerId	string Solo salida. El ID de cliente para recuperar todos los usuarios de la cuenta. Puede usar el alias my_customer para representar el customerId de su cuenta. Como administrador del distribuidor, puede usar el customerId de la cuenta del cliente de reventa. Para obtener un customerId, usa el dominio principal de la cuenta en el parámetro domain de una solicitud de users.list.
addresses	value (Value format) Es la lista de las direcciones del usuario. El tamaño máximo permitido para los datos es de 10 KB. Campos addresses[].country string País. addresses[].countryCode string El código del país Usa la norma ISO 3166-1. addresses[].customType string Si la dirección type es custom, esta propiedad contiene el valor personalizado y se debe establecer. addresses[].extendedAddress string Para direcciones extendidas, como una dirección que incluya una subregión addresses[].formatted string Una dirección postal completa y no estructurada. Esto no se sincroniza con los campos de dirección estructurados. Incluye los siguientes atributos: dirección, apartado postal, ciudad, estado/provincia, código postal, país/región. addresses[].locality string El pueblo o la ciudad de la dirección. addresses[].poBox string La casilla de correo, si está presente. addresses[].postalCode string El código postal, si corresponde. addresses[].primary boolean Si es la dirección principal del usuario. La lista de direcciones puede contener solo una dirección principal. addresses[].region string La provincia o el estado abreviado. addresses[].sourceIsStructured boolean Indica si el formato de la dirección suministrada por el usuario. Por el momento, las direcciones con formato no son compatibles. addresses[].streetAddress string La dirección, como 1600 Amphitheatre Parkway. Se ignora el espacio en blanco dentro de la string, pero las líneas nuevas son significativas. addresses[].type string El tipo de dirección. Si se configura como custom, también se debe configurar customType. Valores aceptables: custom, home, other, work.
organizations	value (Value format) Indica la lista de organizaciones a las que pertenece el usuario. El tamaño máximo permitido para los datos es de 10 KB. Campos organizations[].costCenter string El centro de costos de la organización del usuario. organizations[].customType string Si el valor del tipo es personalizado, esta propiedad contiene el tipo personalizado. organizations[].department string Especifica el departamento dentro de la organización, como sales o engineering. organizations[].description string Es la descripción de la organización. organizations[].domain string El dominio al que pertenece la organización. organizations[].fullTimeEquivalent integer El percentil equivalente de tiempo completo dentro de la organización (100,000 = 100%). organizations[].location string La ubicación física de la organización. No es necesario que sea una dirección completamente calificada. organizations[].name string Es el nombre de la organización. organizations[].primary boolean Indica si esta es la organización principal del usuario. Un usuario solo puede tener una organización principal. organizations[].symbol string Símbolo de cadena de texto de la organización. Por ejemplo, el símbolo de texto para Google es GOOG. organizations[].title string Es el título del usuario dentro de la organización. Por ejemplo, member o engineer. organizations[].type string Es el tipo de organización. Valores aceptables: domain_only, school, unknown, work.
lastLoginTime	string Solo salida. La última vez que el usuario accedió a su cuenta. El valor debe expresarse en formato de fecha y hora ISO 8601. La hora es la fecha completa más horas, minutos y segundos en el formato YYYY-MM-DDThh:mm:ssTZD. Por ejemplo, 2010-04-05T17:30:04+01:00.
phones	value (Value format) Una lista de los números de teléfono del usuario. El tamaño máximo permitido para los datos es de 1 KB. Campos phones[].customType string Si el número de teléfono type es custom, esta propiedad contiene el valor personalizado y debe establecerse. phones[].primary boolean Si es true, es el número de teléfono principal del usuario. Un usuario solo puede tener un número de teléfono principal. phones[].type string El tipo de número de teléfono. Si estableces la política en custom, también se deberá configurar customType. Valores aceptables: assistant, callback, car, company_main, custom, grand_central, home, home_fax, isdn, main, mobile, other, other_fax, pager, work_fax, work_fax. phones[].value string Un número de teléfono legible. Puede estar en cualquier formato de número de teléfono.
suspensionReason	string Solo salida. Tiene el motivo por el que el administrador o Google suspendieron la cuenta de un usuario al momento de la suspensión. La propiedad solo se muestra si la propiedad suspended es true.
thumbnailPhotoUrl	string Solo salida. La URL de la foto de perfil del usuario. La URL puede ser temporal o privada.
languages	value (Value format) Es la lista de los idiomas del usuario. El tamaño máximo permitido para los datos es de 1 KB. Campos languages[].customLanguage string Otro idioma. El usuario puede proporcionar su propio nombre de idioma si no existe un código de idioma ISO 639 correspondiente. Si estableces esta opción, no se podrá establecer languageCode. languages[].languageCode string Representación de la string ISO 639 de un idioma. Consulta Códigos de idioma para ver la lista de códigos admitidos. La API aceptará códigos de idioma válidos fuera del conjunto admitido, pero puede provocar un comportamiento inesperado. Los valores ilegales generan SchemaException. Si estableces esta opción, no se podrá establecer customLanguage. languages[].preference string Opcional. Si está presente, controla si el languageCode especificado es el idioma preferido del usuario. Si se establece customLanguage, no se puede establecer esta opción. Los valores permitidos son preferred y not_preferred.
posixAccounts	value (Value format) La lista de información de cuenta POSIX para el usuario. Campos posixAccounts[].accountId string Un identificador de campo de cuenta POSIX. posixAccounts[].gecos string El GECOS (información del usuario) de esta cuenta posixAccounts[].gid unsigned long Es el ID de grupo predeterminado. posixAccounts[].homeDirectory string La ruta de acceso al directorio principal de esta cuenta. posixAccounts[].operatingSystemType string Es el tipo de sistema operativo de esta cuenta. Valores aceptables: linux, unspecified, windows. posixAccounts[].primary boolean Si es la cuenta principal del usuario dentro del SystemId. posixAccounts[].shell string La ruta al shell de acceso de esta cuenta. posixAccounts[].systemId string Es el identificador del sistema para el que se aplican el nombre de usuario o el Uid de la cuenta. posixAccounts[].uid unsigned long El ID de usuario que cumple con POSIX. posixAccounts[].username string El nombre de usuario de la cuenta.
creationTime	string Solo salida. La hora en la que se creó la cuenta del usuario. El valor debe expresarse en formato de fecha y hora ISO 8601. La hora es la fecha completa más horas, minutos y segundos en el formato YYYY-MM-DDThh:mm:ssTZD. Por ejemplo, 2010-04-05T17:30:04+01:00.
nonEditableAliases[]	string Solo salida. La lista de direcciones de correo electrónico de alias no editables del usuario. Por lo general, estos se encuentran fuera del dominio principal o subdominio de la cuenta.
sshPublicKeys	value (Value format) Una lista de claves públicas SSH. Campos sshPublicKeys[].expirationTimeUsec long Un tiempo de vencimiento en microsegundos desde el ciclo de entrenamiento. sshPublicKeys[].fingerprint string Una huella digital SHA-256 de la clave pública SSH. (solo lectura) sshPublicKeys[].key string Una clave pública SSH
notes	value (Value format) Notas para el usuario como objeto anidado. Campos notes.contentType string Tipo de contenido del contenido de la nota, ya sea texto sin formato o HTML El valor predeterminado es texto sin formato. Valores aceptables: text_plain, text_html. notes.value string Contenido de notas.
websites	value (Value format) Es la lista de los sitios web del usuario. Campos websites[].customType string Si el sitio web type es custom, esta propiedad contiene el valor personalizado y se debe establecer. websites[].primary boolean Si es true, este es el sitio web principal del usuario. websites[].type string El tipo o propósito del sitio web Por ejemplo, un sitio web puede etiquetarse como home o blog. Como alternativa, una entrada puede tener un tipo custom. Si se configura como custom, también se debe configurar customType. Valores aceptables: app_install_page, blog, custom, ftp, home, home_page, other, profile, reservations, resume, work. websites[].value string La URL del sitio web.
locations	value (Value format) Es la lista de las ubicaciones del usuario. El tamaño máximo permitido para los datos es de 10 KB. Campos locations[].area string Ubicación textual. Esto es más útil para la visualización, a fin de describir de manera concisa la ubicación. Por ejemplo, Mountain View, CA o Near Seattle. locations[].buildingId string Identificador de edificio locations[].customType string Si la ubicación type es custom, esta propiedad contiene el valor personalizado y se debe establecer. locations[].deskCode string Es el código textual más específico de la ubicación individual del escritorio. locations[].floorName string Nombre/número del piso. locations[].floorSection string Sección del piso. Ubicación más específica dentro del piso. Por ejemplo, si un piso se divide en las secciones A, B y C, este campo identificará uno de esos valores. locations[].type string El tipo de ubicación. Si se configura como custom, también se debe configurar customType. Valores aceptables: custom, default, desk.
includeInGlobalAddressList	boolean Indica si el perfil del usuario es visible en la lista de direcciones global de Google Workspace cuando la función de uso compartido de contactos está habilitada para el dominio. Para obtener más información sobre cómo excluir perfiles de usuario, consulte el Centro de ayuda para la administración.
keywords	value (Value format) Es la lista de palabras clave del usuario. El tamaño máximo permitido para los datos es de 1 KB. Campos keywords[].customType string Si la palabra clave type es custom, esta propiedad contiene el valor personalizado y debe configurarse. keywords[].type string Cada entrada puede tener un tipo que indique el tipo estándar de esa entrada. Por ejemplo, la palabra clave puede ser de tipo occupation o outlook. Además del tipo estándar, una entrada puede tener un tipo custom y asignarle un nombre. Si se configura como custom, también se debe configurar customType. Valores aceptables: custom, mission, occupation, outlook. keywords[].value string Palabra clave.
deletionTime	string Solo salida. La hora en que se borró la cuenta del usuario. El valor debe expresarse en formato de fecha y hora ISO 8601. La hora es la fecha completa más horas, minutos y segundos en el formato YYYY-MM-DDThh:mm:ssTZD. Por ejemplo 2010-04-05T17:30:04+01:00.
gender	value (Value format) Es un objeto anidado que contiene el género del usuario. El tamaño máximo de datos permitido para este campo es de 1 KB. Campos gender.addressMeAs string Una string legible que contiene la forma adecuada de referirse al propietario del perfil mediante personas, por ejemplo, "él" o "él/su(s)". gender.customGender string Nombre de un género personalizado. gender.type string El tipo de género. Valores aceptables: female male other unknown
thumbnailPhotoEtag	string Solo salida. ETag de la fotografía del usuario (solo lectura)
ims	value (Value format) Las cuentas de mensajería instantánea (IM) del usuario. Una cuenta de usuario puede tener varias propiedades ims, pero solo una de estas propiedades de ims puede ser el contacto principal de mensajería instantánea. Campos ims[].customProtocol string Si el valor del protocolo es custom_protocol, esta propiedad contiene la string del protocolo personalizado. ims[].customType string Si el IM type es custom, esta propiedad contiene el valor personalizado y debe establecerse. ims[].im string El ID de red IM del usuario. ims[].primary boolean Si es el IM principal del usuario. Solo una entrada en la lista de IM puede tener el valor true. ims[].protocol string Un protocolo de IM identifica la red de IM. El valor puede ser una red personalizada o una red estándar. Valores aceptables: aim: Protocolo de mensajería instantánea de AOL custom_protocol: Es un protocolo de red de IM personalizado. gtalk: Protocolo de Google Talk icq: Protocolo ICQ jabber: Protocolo Jabber msn: Protocolo de MSN Messenger net_meeting: Protocolo de reunión Neta qq: Protocolo QQ skype: Protocolo de Skype yahoo: Protocolo de Yahoo Messenger ims[].type string El tipo de cuenta de mensajería instantánea Si se configura como custom, también se debe configurar customType. Valores aceptables: custom, home, other, work.
customSchemas	value (Value format) Campos personalizados del usuario. La clave es una schemaName y sus valores son 'fieldName': 'field_value'. customSchemas.(key) es un objeto anidado. customSchemas.(key).(key) puede ser cualquier valor.
isEnrolledIn2Sv	boolean Solo salida. Se inscribió en la verificación en 2 pasos (solo lectura).
isEnforcedIn2Sv	boolean Solo salida. Se aplica la verificación en 2 pasos de manera forzosa (solo lectura)
archived	boolean Indica si el usuario está archivado.
orgUnitPath	string La ruta completa de la organización principal asociada con el usuario. Si la organización principal es el nivel superior, se representa como una barra diagonal (/).
recoveryEmail	string Correo de recuperación del usuario.
recoveryPhone	string Teléfono de recuperación del usuario. El número de teléfono debe estar en formato E.164 y comenzar con el signo más (+). Ejemplo: [phone].

Nombre de usuario

Representación JSON
{ "fullName": string, "familyName": string, "givenName": string, "displayName": string }

Campos
fullName	string El nombre completo del usuario formado mediante la concatenación de los valores del nombre y el apellido.
familyName	string El apellido del usuario. Es obligatorio al crear una cuenta de usuario.
givenName	string El nombre del usuario. Es obligatorio al crear una cuenta de usuario.
displayName	string El nombre visible del usuario. Límite: 256 caracteres

Métodos
delete	Borra un usuario.
get	Recupera un usuario.
insert	Crea un usuario.
list	Recupera una lista paginada de los usuarios borrados o de todos los usuarios de un dominio.
makeAdmin	Convierte a un usuario en administrador avanzado.
patch	Actualiza un usuario mediante la semántica de parches.
signOut	Cierra la sesión de un usuario en todas las sesiones web y de dispositivos, y restablece sus cookies de acceso.
undelete	Permite recuperar un usuario borrado.
update	Actualiza a un usuario.
watch	Observa si hay cambios en la lista de usuarios.