Saltar al contenido

Detalles de Conexión del Google Directory

Introducción

Versión del conector

Esta documentación se basa en la versión 22.0.8510 del conector.

Empezando

Compatibilidad con la versión del Google Directory

Establecer una Conexión

Autenticación en el Google Directory

El conector admite el uso de cuentas de usuario, cuentas de servicio y cuentas de instancias de GCP para la autenticación.

Las siguientes secciones analizan los esquemas de autenticación disponibles para Google Directory:

  • Cuentas de usuario (OAuth)
  • Cuenta de servicio (OAuthJWT)
  • Cuenta de instancia de GCP
Cuentas de Usuario (oauth)

AuthScheme debe establecerse en OAuth en todos los flujos de cuentas de usuario.

Aplicaciones de Escritorio

proporciona una aplicación OAuth integrada que simplifica la autenticación de escritorio OAuth. Como alternativa, puede crear una aplicación OAuth personalizada. Consulte Crear una aplicación OAuth personalizada para obtener información sobre la creación de aplicaciones personalizadas y las razones para hacerlo.

Para la autenticación, la única diferencia entre los dos métodos es que debe establecer dos propiedades de conexión adicionales al usar aplicaciones OAuth personalizadas.

Después de configurar las siguientes propiedades de conexión, está listo para conectarse:

  • InitiateOAuth: Establézcalo en GETANDREFRESH, que indica al conector que intente obtener y actualizar automáticamente el token de acceso de OAuth.
  • OAuthClientId: (solo aplicaciones personalizadas) Establezca esto en la ID del cliente en la configuración de su aplicación OAuth personalizada.
  • OAuthClientSecret: (solo aplicaciones personalizadas) Establézcalo en el secreto del cliente en la configuración de la aplicación OAuth personalizada.

Cuando se conecta, el conector abre el extremo de OAuth en su navegador predeterminado. Inicie sesión y otorgue permisos a la aplicación. Luego, el conector completa el proceso de OAuth de la siguiente manera:

  • Extrae el token de acceso de la URL de devolución de llamada.
  • Obtiene un nuevo token de acceso cuando caduca el anterior.
  • Guarda los valores de OAuth en OAuthSettingsLocation que persisten a través de las conexiones.
Aplicaciones Web

Al conectarse a través de una aplicación web, debe crear y registrar una aplicación OAuth personalizada con Google Directory. Luego puede usar el conector para adquirir y administrar los valores del token de OAuth. Consulte Crear una aplicación OAuth personalizada para obtener más información acerca de las aplicaciones personalizadas.

Obtenga un token de acceso de OAuth

Establezca las siguientes propiedades de conexión para obtener OAuthAccessToken:

  • OAuthClientId: establezca esto en la ID del cliente en la configuración de su aplicación.
  • OAuthClientSecret: establezca esto en el secreto del cliente en la configuración de su aplicación.

Luego llame a procedimientos almacenados* para completar el intercambio de OAuth:

  1. Llame a GetOAuthAuthorizationURL procedimiento almacenado. Establezca la entrada CallbackURL en la URL de devolución de llamada que especificó en la configuración de su aplicación. El procedimiento almacenado* devuelve la URL al extremo de OAuth.
  2. Navegue a la URL que el procedimiento almacenado* devuelto en el Paso 1. Inicie sesión en la aplicación OAuth personalizada y autorice la aplicación web. Una vez autenticado, el navegador lo redirige a la URL de devolución de llamada.
  3. Llame al GetOAuthAccessToken procedimiento almacenado. Establezca AuthMode en WEB y la entrada del Verificador al parámetro "código" en la cadena de consultar de la URL de devolución de llamada.

Una vez que haya obtenido los tokens de acceso y actualización, puede conectarse a los datos y actualizar el token de acceso de OAuth de forma automática o manual.

Actualización automática del token de acceso de OAuth

Para que el controlador actualice automáticamente el token de acceso de OAuth, configure lo siguiente en la primera conexión de datos:

  • InitiateOAuth: Establézcalo en REFRESH.
  • OAuthClientId: establezca esto en la ID del cliente en la configuración de su aplicación.
  • OAuthClientSecret: establezca esto en el secreto del cliente en la configuración de su aplicación.
  • OAuthAccessToken: establezca esto en el token de acceso devuelto por GetOAuthAccessToken.
  • OAuthRefreshToken: establezca esto en el token de actualización devuelto por GetOAuthAccessToken.
  • OAuthSettingsLocation: establezca esto en la ruta donde el conector guarda los valores del token de OAuth, que persisten entre las conexiones.

En conexiones de datos posteriores, los valores de OAuthAccessToken y OAuthRefreshToken se toman de OAuthSettingsLocation.

Actualización manual del token de acceso de OAuth

El único valor necesario para actualizar manualmente el token de acceso de OAuth cuando se conecta a los datos es el token de actualización de OAuth.

Use el RefreshOAuthAccessToken procedimiento almacenado* para actualizar manualmente el OAuthAccessToken después del valor del parámetro ExpiresIn devuelto por GetOAuthAccessToken ha transcurrido, luego configure las siguientes propiedades de conexión:

  • OAuthClientId: establezca esto en la ID del cliente en la configuración de su aplicación.
  • OAuthClientSecret: establezca esto en el secreto del cliente en la configuración de su aplicación.

Luego llame a RefreshOAuthAccessToken con OAuthRefreshToken establecido en el token de actualización de OAuth devuelto por GetOAuthAccessToken. Después de recuperar los nuevos tokens, abra una nueva conexión configurando la propiedad OAuthAccessToken en el valor devuelto por RefreshOAuthAccessToken.

Finalmente, almacene el token de actualización de OAuth para que pueda usarlo para actualizar manualmente el token de acceso de OAuth después de que haya caducado.

Máquinas Sin Cabeza

Para configurar el controlador para usar OAuth con una cuenta de usuario en una máquina sin periféricos, debe autenticarse en otro dispositivo que tenga un navegador de Internet.

  1. Elija una de dos opciones:
    • Opción 1: Obtener el OAuthVerifier valor como se describe en "Obtener e intercambiar un código verificador" a continuación.
    • Opción 2: Instale el conector en una máquina con un navegador de Internet y transfiera los valores de autenticación de OAuth después de autenticarse a través del flujo habitual basado en el navegador, como se describe en "Transferir la configuración de OAuth" a continuación.
  2. Luego, configure el conector para actualizar automáticamente el token de acceso en la máquina sin periféricos.

Opción 1: obtener e intercambiar un código verificador

Para obtener un código de verificación, debe autenticarse en la URL de autorización de OAuth.

Siga los pasos a continuación para autenticarse desde la máquina con un navegador de Internet y obtener el OAuthVerifier propiedad de conexión.

  1. Elija una de estas opciones:
    • Si está utilizando la aplicación OAuth integrada, haga clic en extremo de OAuth de Google Directory para abrir el extremo en su navegador.
    • Si está utilizando una aplicación OAuth personalizada, cree la URL de autorización configurando las siguientes propiedades:

      • InitiateOAuth: Ajustado a OFF.
      • OAuthClientId: Establezca el ID de cliente asignado cuando registró su aplicación.
      • OAuthClientSecret: establezca el secreto de cliente asignado cuando registró su aplicación.

      Luego llame a GetOAuthAuthorizationURL procedimiento almacenado* con la URL de devolución de llamada adecuada. Abra la URL devuelta por el procedimiento almacenado* en un navegador. 2. Inicie sesión y otorgue permisos al conector. A continuación, se le redirige a la URL de devolución de llamada, que contiene el código verificador. 3. Guarde el valor del código verificador. Más tarde configurará esto en el OAuthVerifier propiedad de conexión.

A continuación, debe intercambiar el código verificador de OAuth por tokens de acceso y actualización de OAuth. Establezca las siguientes propiedades:

En la máquina sin periféricos, establezca las siguientes propiedades de conexión para obtener los valores de autenticación de OAuth:

  • InitiateOAuth: Establézcalo en REFRESH.
  • OAuthVerifier: Establézcalo en el código del verificador.
  • OAuthClientId: (solo aplicaciones personalizadas) Establezca esto en la ID del cliente en la configuración de su aplicación OAuth personalizada.
  • OAuthClientSecret: (solo aplicaciones personalizadas) Establézcalo en el secreto del cliente en la configuración de la aplicación OAuth personalizada.
  • OAuthSettingsLocation: configure esto para conservar los valores de autenticación OAuth cifrados en el archivo especificado.

Después de generar el archivo de configuración de OAuth, debe restablecer las siguientes propiedades para conectarse:

  • InitiateOAuth: Establézcalo en REFRESH.
  • OAuthClientId: (solo aplicaciones personalizadas) Establezca esto en el ID de cliente asignado cuando registró su aplicación.
  • OAuthClientSecret: (solo aplicaciones personalizadas) Establezca esto en el secreto de cliente asignado cuando registró su aplicación.
  • OAuthSettingsLocation: Establézcalo en el archivo que contiene los valores de autenticación de OAuth cifrados. Asegúrese de que este archivo otorgue permisos de lectura y escritura al conector para habilitar la actualización automática del token de acceso.

Opción 2: Transferir la configuración de OAuth

Antes de conectarse a una máquina sin periféricos, debe crear e instalar una conexión con el controlador en un dispositivo que admita un navegador de Internet. Establezca las propiedades de conexión como se describe en "Aplicaciones de escritorio" más arriba.

Después de completar las instrucciones en "Aplicaciones de escritorio", los valores de autenticación resultantes se cifran y se escriben en la ruta especificada por OAuthSettingsLocation. El nombre de archivo predeterminado es OAuthSettings.txt.

Una vez que haya probado con éxito la conexión, copie el archivo de configuración de OAuth en su máquina sin periféricos.

En la máquina sin periféricos, configure las siguientes propiedades de conexión para conectarse a los datos:

  • InitiateOAuth: Establézcalo en REFRESH.
  • OAuthClientId: (solo aplicaciones personalizadas) Establezca esto en el ID de cliente asignado cuando registró su aplicación.
  • OAuthClientSecret: (solo aplicaciones personalizadas) Establezca esto en el secreto de cliente asignado cuando registró su aplicación.
  • OAuthSettingsLocation: establezca esto en la ruta a su archivo de configuración de OAuth. Asegúrese de que este archivo otorgue permisos de lectura y escritura al conector para habilitar la actualización automática del token de acceso.
Cuentas de Servicio (oauthjwt)

Para autenticarse usando una cuenta de servicio, debe crear una nueva cuenta de servicio y tener una copia del certificado de la cuenta. Si aún no tiene una cuenta de servicio, puede crear una siguiendo el procedimiento en Crear una aplicación OAuth personalizada.

Para un archivo JSON, establezca estas propiedades:

  • AuthScheme: Establézcalo en OAuthJWT.
  • InitiateOAuth: Establézcalo en GETANDREFRESH.
  • OAuthJWTCertType: Establézcalo en GOOGLEJSON.
  • OAuthJWTCert: Establézcalo en la ruta al .json archivo proporcionado por Google.
  • OAuthJWTSubject: (opcional) Solo establezca este valor si la cuenta de servicio es parte de un dominio de GSuite y desea habilitar la delegación. El valor de esta propiedad debe ser la dirección de correo del usuario a cuyos datos desea acceder.

Para un archivo PFX, establezca estas propiedades en su lugar:

  • AuthScheme: Establézcalo en OAuthJWT.
  • InitiateOAuth: Establézcalo en GETANDREFRESH.
  • OAuthJWTCertType: Establézcalo en PFXFILE.
  • OAuthJWTCert: Establézcalo en la ruta al .pfx archivo proporcionado por Google.
  • OAuthJWTCertPassword: (opcional) Establézcalo en el .pfx contraseña del archivo. En la mayoría de los casos, debe proporcionar esto, ya que Google encripta los certificados PFX.
  • OAuthJWTCertSubject: (opcional) Configure esto solo si está utilizando un OAuthJWTCertType que almacena múltiples certificados. No debe configurarse para certificados PFX generados por Google.
  • OAuthJWTIssuer: establezca esto en la dirección de correo de la cuenta de servicio. Esta dirección generalmente incluirá el dominio iam.gserviceaccount.com.
  • OAuthJWTSubject: (opcional) Solo establezca este valor si la cuenta de servicio es parte de un dominio de GSuite y desea habilitar la delegación. El valor de esta propiedad debe ser la dirección de correo del usuario a cuyos datos desea acceder.
Cuentas de Instancias de GCP

Cuando se ejecuta en una máquina virtual de GCP, el conector puede autenticarse mediante una cuenta de servicio vinculada a la máquina virtual. Para usar este modo, configure AuthScheme a GCPInstanceAccount.

Creación de una Aplicación OAuth Personalizada

Introducción

Puede usar una aplicación OAuth personalizada para autenticar una cuenta de servicio o una cuenta de usuario. Siempre puede crear una aplicación OAuth personalizada, pero tenga en cuenta que las conexiones de escritorio y sin cabeza admiten OAuth incorporado, lo que simplifica el proceso de autenticación.

Cuándo Crear una Aplicación OAuth Personalizada

incorpora Credenciales de aplicación OAuth con marca que se puede usar cuando se conecta a través de una aplicación de escritorio o desde una máquina sin cabeza.

Puede optar por utilizar sus propias Credenciales de aplicación de OAuth cuando desee

  • controlar la marca del diálogo de autenticación
  • controlar el URI de redireccionamiento al que la aplicación redirige al usuario después de que el usuario se autentica
  • personalizar los permisos que está solicitando al usuario

Habilitar la API de Directorio

Siga estos pasos para habilitar la API de directorio:

  1. Navegue a Google Cloud Console.
  2. Seleccione Library desde el menú de navegación de la izquierda. Esto abre el Library página.
  3. En el campo de búsqueda, ingrese " API de directorio" y seleccione Directory API de los resultados de búsqueda.
  4. En el Directory API página, haga clic en ENABLE.

Crear una Aplicación OAuth para Cuentas de Usuario (oauth)

Cuando usa AuthScheme=OAuth y está usando una aplicación web, debe crear una aplicación de ID de cliente de OAuth. Para flujos de escritorio y sin cabeza, la creación de una aplicación OAuth personalizada es opcional.

Siga estos pasos para crear una aplicación OAuth personalizada:

  1. Navegue a Google Cloud Console.
  2. Cree un nuevo proyecto o seleccione un proyecto existente.
  3. Seleccione Credentials desde el menú de navegación de la izquierda.
  4. Cree una pantalla de consentimiento si aún no está configurada para su proyecto seleccionado haciendo clic en CONFIGURE CONSENT SCREEN. Si no está utilizando una cuenta de Google Workspace, está restringido a crear una Pantalla de consentimiento de tipo externo, que requiere especificar un correo de soporte y un correo de contacto del desarrollador. La información adicional es opcional.
  5. En el Credentials página, seleccione Create Credentials > OAuth Client ID.
  6. En el Application Type menú, seleccione Web application.
  7. Especifique un nombre para su aplicación web personalizada de OAuth.
  8. Bajo Authorized redirect URIs, haga clic en ADD URI e ingrese un URI de redireccionamiento. Prensa Enter.
  9. Haga clic en CREATE, que te devuelve al Credentials página.
  10. Se abre una ventana que muestra su ID de cliente y secreto de cliente. Aunque se puede acceder al secreto del cliente desde Google Cloud Console, le recomendamos que escriba el secreto del cliente. Necesita tanto el secreto del cliente como el ID del cliente para especificar OAuthClientId y OAuthClientSecret propiedades de conexión.

Crear una Aplicación OAuth para Cuentas de Servicio (oauthjwt)

Puede usar una cuenta de servicio en este flujo de OAuth para acceder a las APIs de Google en nombre de los usuarios de un dominio. Un administrador de dominio puede delegar el acceso de todo el dominio a la cuenta de servicio.

Para completar el flujo de la cuenta de servicio, genere una clave privada en Google Cloud Console. En el flujo de la cuenta de servicio, el controlador intercambia un token web JSON (JWT) por el OAuthAccessToken. Se requiere la clave privada para firmar el JWT. El controlador tendrá los mismos permisos otorgados a la cuenta de servicio. Al usar AuthScheme=OAuthJWT, debe crear una cuenta de servicio. Sigue estos pasos:

  1. Navegue a Google Cloud Console.
  2. Cree un nuevo proyecto o seleccione un proyecto existente.
  3. Seleccione Credentials desde el menú de navegación de la izquierda.
  4. Seleccione Create Credentials > Service account.
  5. En el Create service account página, ingrese el nombre de la cuenta de servicio, el ID de la cuenta de servicio y, opcionalmente, una descripción.
  6. Haga clic en DONE. Esto te devuelve al Credentials página.
  7. Seleccione la cuenta de servicio recién creada debajo de Service Accounts sección.
  8. Haga clic en KEYS tab > ADD KEY > Create new key.
  9. Seleccione cualquier tipo de clave compatible (consulte OAuthJWTCert y OAuthJWTCertType).
  10. Haga clic en CREATE. La clave se descargará automáticamente en su dispositivo y se mostrará cualquier información adicional específica de la clave.

Características Avanzadas

Esta sección detalla una selección de funciones avanzadas del conector de Google Directory.

Vistas definidas por el usuario

El conector le permite definir tablas virtuales, llamadas vistas definidas por el usuario, cuyo contenido se decide mediante una consultar preconfigurada. Estas vistas son útiles cuando no puede controlar directamente las consultas que se envían a los controladores. Consulte Vistas definidas por el usuario para obtener una descripción general de la creación y configuración de vistas personalizadas.

Configuración SSL

Usar Configuración SSL para ajustar cómo el conector maneja las negociaciones de certificados TLS/SSL. Puede elegir entre varios formatos de certificado; ver el SSLServerCert propiedad en "Opciones de cadena de conexión" para obtener más información.

Apoderado

Para configurar el conector mediante Configuración de proxy de Agente Privado, Selecciona el Use Proxy Settings casilla de verificación en la pantalla de configuración de la conexión.

Procesamiento de consultas

El conector descarga la mayor cantidad posible del procesamiento de la declaración SELECT en Google Directory y luego procesa el resto de la consultar en la memoria (lado del cliente).

Consulte Procesamiento de consultas para más información.

Vistas Definidas por el Usuario

El Jitterbit Connector for Google Directory te permite definir una tabla virtual cuyos contenidos se deciden mediante una consultar preconfigurada. Estas se denominan Vistas definidas por el usuario, que son útiles en situaciones en las que no puede controlar directamente la consultar que se envía al controlador, por ejemplo, cuando se utiliza el controlador de Jitterbit. Las vistas definidas por el usuario se pueden utilizar para definir predicados que siempre se aplican. Si especifica predicados adicionales en la consultar a la vista, se combinan con la consultar ya definida como parte de la vista.

Hay dos formas de crear vistas definidas por el usuario:

  • Cree un archivo de configuración con formato JSON que defina las vistas que desea.
  • Declaraciones DDL.

Definición de Vistas Utilizando un Archivo de Configuración

Las vistas definidas por el usuario se definen en un archivo de configuración con formato JSON llamado UserDefinedViews.json. El conector detecta automáticamente las vistas especificadas en este archivo.

También puede tener múltiples definiciones de vista y controlarlas usando UserDefinedViews propiedad de conexión. Cuando utiliza esta propiedad, el conector solo ve las vistas especificadas.

Este archivo de configuración de vista definida por el usuario tiene el siguiente formato:

  • Cada elemento raíz define el nombre de una vista.
  • Cada elemento raíz contiene un elemento hijo, llamado query, que contiene la consultar SQL personalizada para la vista.

Por ejemplo:

{
    "MyView": {
        "query": "SELECT * FROM Group WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Utilizar el UserDefinedViews propiedad de conexión para especificar la ubicación de su archivo de configuración JSON. Por ejemplo:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Definición de Vistas Usando Sentencias DDL

El conector también es capaz de crear y modificar el esquema a través de instrucciones DDL como CREATE LOCAL VIEW, ALTER LOCAL VIEW y DROP LOCAL VIEW.

Crear una Vista

Para crear una nueva vista usando declaraciones DDL, proporcione el nombre de la vista y la consultar de la siguiente manera:

CREATE LOCAL VIEW [MiNombre de Vista] AS SELECT * FROM Customers LIMIT 20;

Si no existe ningún archivo JSON, el código anterior crea uno. Luego, la vista se crea en el archivo de configuración JSON y ahora se puede detectar. La ubicación del archivo JSON se especifica mediante UserDefinedViews propiedad de conexión.

Modificar una Vista

Para modificar una vista existente, proporcione el nombre de una vista existente junto con la nueva consultar que le gustaría usar en su lugar:

ALTER LOCAL VIEW [MiNombre de vista] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

Luego, la vista se actualiza en el archivo de configuración JSON.

Suelta una Vista

Para descartar una vista existente, proporcione el nombre de un esquema existente junto con la nueva consultar que le gustaría usar en su lugar.

DROP LOCAL VIEW [MyViewName]

Esto elimina la vista del archivo de configuración JSON. Ya no se puede consultar.

Esquema para Vistas Definidas por el Usuario

Las vistas definidas por el usuario se exponen en UserViews esquema por defecto. Esto se hace para evitar que el nombre de la vista entre en conflicto con una entidad real en el modelo de datos. Puede cambiar el nombre del esquema utilizado para UserViews configurando UserViewsSchemaName propiedad.

Trabajar con Vistas Definidas por el Usuario

Por ejemplo, una instrucción SQL con una vista definida por el usuario llamada UserViews.RCustomers solo enumera clientes en Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Un ejemplo de una consultar al controlador:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Dando como resultado la consultar efectiva a la fuente:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

Ese es un ejemplo muy simple de una consultar a una vista definida por el usuario que es efectivamente una combinación de la consultar de vista y la definición de vista. Es posible componer estas consultas en patrones mucho más complejos. Todas las operaciones de SQL están permitidas en ambas consultas y se combinan cuando corresponde.

Configuración SSL

Personalización de la Configuración SSL

De forma predeterminada, el conector intenta negociar SSL/TLS comparando el certificado del servidor con el almacén de certificados de confianza del sistema.

Para especificar otro certificado, consulte SSLServerCert propiedad de los formatos disponibles para hacerlo.

Modelo de Datos

Jitterbit Connector for Google Directory modela las APIs de Google Directory como tablas relacionales, vistas y procedimientos almacenados. Las limitaciones y los requisitos de la API para los objetos disponibles se documentan en esta sección. El conector descarga la mayor parte posible del procesamiento de la declaración SELECT a las APIs de Google Directory y luego procesa el resto de la consultar en la memoria; Las limitaciones y los requisitos de la API se documentan en Tablas y Vistas.

Ver SupportEnhancedSQL para obtener más información sobre cómo el conector elude las limitaciones de la API con el procesamiento del lado del cliente en memoria.

Mesas

El proveedor del conector modela la API de Google Directory como Tablas.

Puntos de vista

Puntos de vista ofrecen información adicional del Google Directory.

Procedimientos almacenados

NOTE: Los procedimientos almacenados no se admiten actualmente. Consulte la nota anterior para detalles.

Procedimientos almacenados son interfaces similares a funciones para la fuente de datos.

Mesas

El conector modela los datos en Google Directory en una lista de tablas que se pueden consultar mediante declaraciones SQL estándar.

En general, consultar las tablas de Google Directory es lo mismo que consultar una tabla en una base de datos relacional. A veces hay casos especiales, por ejemplo, incluir una determinada columna en la cláusula WHERE puede ser necesario para obtener datos para ciertas columnas de la tabla. Esto suele ser necesario para situaciones en las que se debe realizar una solicitud separada para cada fila para obtener ciertas columnas. Estos tipos de situaciones están claramente documentados en la parte superior de la página de la tabla vinculada a continuación.

Conector Jitterbit para Tablas de Google Directory

Nombre Descripción
ChromeOsDevices Recupera todos los dispositivos Chrome para una cuenta.
DomainAliases Crear, actualizar y consultar alias de un dominio.
Domains Cree, elimine y consultar los dominios de un usuario.
GroupAliases Cree, elimine y consultar alias para un grupo.
GroupMembers Cree, actualice, elimine y consultar los miembros de un grupo.
Groups Crear, actualizar, eliminar y consultar grupos.
Notifications Actualice, elimine y consultar las notificaciones de un cliente.
OrganizationUnits Cree, actualice, elimine y consultar las unidades organizativas de un cliente.
RoleAssignments Cree, elimine y consultar los roles asignados a los usuarios.
Tokens Consultar y eliminar tokens para un usuario.
UserAliases Enumera los alias, que son direcciones de correo alternativas para un usuario.
Users Consulta de información del usuario.

ChromeOSDispositivos

Recupera todos los dispositivos Chrome para una cuenta.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de todos los dispositivos Chrome de una cuenta, se requiere la columna CustomerId. Se puede establecer en la cadena de conexión o en la condición de la cláusula WHERE. Si no se especifica, se utilizará el CustomerId de la cuenta actual. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, las APIs de Google Directory procesan la siguiente consultar del lado del servidor:

SELECT * FROM ChromeOsDevices
Insertar

Las inserciones no son compatibles con esta tabla.

Actualizar

Actualiza las propiedades de usuario anotado, ubicación anotada o notas de un dispositivo. Para actualizar una notificación, se requieren las siguientes columnas: CustomerId e Id. Si no se especifica, se utilizará el CustomerId de la cuenta actual.

UPDATE ChromeOsDevices SET AnnotatedUser='User_2' WHERE ID = '12345' AND CustomerId = '1234'.
Borrar

No se admiten eliminaciones para esta tabla.

Columnas
Nombre Tipo Solo lectura Descripción
Id [KEY] String Verdadero El ID único del dispositivo Chrome.
SerialNumber String Verdadero El número de serie del dispositivo Chrome ingresado cuando se habilitó el dispositivo. Este valor es el mismo que el Número de serie de la consola de administración en la pestaña Dispositivos de Chrome OS.
Model String Verdadero La información del modelo del dispositivo. Si el dispositivo no tiene esta información, esta propiedad no se incluye en la respuesta.
MEID String Verdadero El Identificador de Equipo Móvil (MEID) para la tarjeta móvil 3G en un dispositivo móvil. Un MEID generalmente se usa cuando se agrega un dispositivo al plan de servicio pospago de un proveedor de servicios inalámbricos. Si el dispositivo no tiene esta información, esta propiedad no se incluye en la respuesta.
LastSync Datetime Verdadero La fecha y la hora en que se inscribió el dispositivo por última vez.
AnnotatedUser String Falso El usuario del dispositivo según lo indicado por el administrador. La longitud máxima es de 100 caracteres. Se permiten valores vacíos.
AnnotatedLocation String Falso La dirección o ubicación del dispositivo según lo anotado por el administrador. La longitud máxima es de 200 caracteres. Se permiten valores vacíos.
AnnotatedAssetId String Falso El identificador de activos tal como lo anotó un administrador o lo especificó durante la inscripción.
Notes String Falso Notas sobre este dispositivo añadidas por el administrador. Esta propiedad se puede buscar con el parámetro de consultar del método de lista. La longitud máxima es de 500 caracteres. Se permiten valores vacíos.
OrgUnitPath String Falso La ruta principal completa con el nombre de la unidad organizativa asociada al dispositivo. Los nombres de las rutas no distinguen entre mayúsculas y minúsculas. Si la unidad organizativa principal es la organización de nivel superior, se representa como una barra diagonal, /. Esta propiedad se puede actualizar mediante la API
OrderNumber String Verdadero El número de pedido del dispositivo. Solo los dispositivos comprados directamente a Google tienen un número de pedido.
MacAddress String Verdadero La dirección MAC inalámbrica del dispositivo. Si el dispositivo no tiene esta información, no se incluye en la respuesta.
WillAutoRenew Boolean Verdadero Determina si el dispositivo renovará automáticamente su soporte después de la fecha de finalización del soporte. Esta es una propiedad de solo lectura.
OsVersion String Verdadero La versión del sistema operativo del dispositivo Chrome.
PlatformVersion String Verdadero La versión de la plataforma del dispositivo Chrome.
FirmwareVersion String Verdadero La versión de firmware del dispositivo Chrome.
BootMode String Verdadero El modo de arranque del dispositivo.
LastEnrollmentTime String Verdadero La fecha y la hora en que se inscribió el dispositivo por última vez.
TmpVersionInfoAggr String Verdadero Módulo de plataforma segura (TPM).
ActiveTimeRangesAggr String Verdadero Lista de rangos de tiempo activos.
RecentUsersAggr String Verdadero Lista de usuarios de dispositivos recientes, en orden descendente, por última hora de inicio de sesión.
DeviceFilesAggr String Verdadero Lista de archivos de dispositivo para descargar.
ETag String Verdadero ETag del recurso.
Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Nombre Tipo Descripción
CustomerId String Identificación del cliente

Alias de Dominio

Crear, actualizar y consultar alias de un dominio.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de todos los alias de un dominio, se requiere la columna CustomerId. Se puede establecer en la cadena de conexión o en la condición de la cláusula WHERE. Si no se especifica, se utilizará el CustomerId de la cuenta actual. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, las APIs de Google Directory procesan la siguiente consultar del lado del servidor:

SELECT * FROM DomainAliases
Insertar

Para insertar un alias, se requieren las siguientes columnas: CustomerId, ParentDomain y DomainAliasName.

INSERT INTO DomainAliases (CustomerId, DomainAliasName, ParentDomain) VALUES ('12345','Alias', 'parentdomain.com')
Actualizar

No se admiten actualizaciones para esta tabla.

Borrar

Para eliminar un alias, se requieren las siguientes columnas: CustomerId y DomainAliasName.

DELETE FROM DomainAliases WHERE CustomerId='C020vaw0q' AND DomainAliasName='Alias'
Columnas
Nombre Tipo Solo lectura Descripción
DomainAliasName [KEY] String Falso El nombre de alias de dominio.
ParentDomain String Falso El nombre de dominio principal con el que está asociado el alias de dominio.
IsVerified Boolean Verdadero Indica el estado de verificación de un alias de dominio.
CreationDate Timestamp Verdadero Marca de tiempo de la fecha de creación del alias de dominio en milisegundos.
ETag String Verdadero ETag del recurso
Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Nombre Tipo Descripción
CustomerId String Identificación del cliente

Dominios

Cree, elimine y consultar los dominios de un usuario.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de todos los dominios, se requiere la columna CustomerId. Se puede establecer en la cadena de conexión o en la condición de la cláusula WHERE. Si no se especifica, se utilizará el CustomerId de la cuenta actual, como en la siguiente consultar. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, las APIs de Google Directory procesan la siguiente consultar del lado del servidor:

SELECT * FROM Domains
Insertar

Para insertar un dominio, se requieren las siguientes columnas: CustomerId y DomainName.

INSERT INTO Domains (CustomerId, DomainName) VALUES ('12345', 'exampledomain.com')
Actualizar

No se admiten actualizaciones para esta tabla.

Borrar

Para eliminar un dominio, se requiere la columna DomainName.

DELETE FROM Domains WHERE DomainName='exampledomain.com'
Columnas
Nombre Tipo Solo lectura Descripción
DomainName [KEY] String Falso El nombre de dominio.
IsPrimary Boolean Verdadero Indica si el dominio es un dominio principal.
IsVerified Boolean Verdadero Indica el estado de verificación de un dominio.
CreationDate Datetime Verdadero La fecha de creación del dominio.
Aliases String Verdadero Los alias del dominio.
ETag String Verdadero ETag del recurso.
Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Nombre Tipo Descripción
CustomerId String Identificación del cliente

Alias de Grupo

Cree, elimine y consultar alias para un grupo.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de todos los alias de un grupo, se requiere la columna GroupId. Si no se especifica, se utilizará el GroupId del primer grupo de la tabla Grupos. El conector procesa otras consultas del lado del cliente en la memoria.

La siguiente consultar muestra el único filtro procesado del lado del servidor por la API de Google Directory:

SELECT * FROM GroupAliases WHERE GroupId = '12345'
Insertar

Para insertar un alias, se requieren las siguientes columnas: GroupId y Alias.

INSERT INTO GroupAliases (GroupId, Alias) VALUES ('12345', 'Alias')
Actualizar

No se admiten actualizaciones para esta tabla.

Borrar

Para eliminar un alias, se requieren las siguientes columnas: GroupId y Alias.

DELETE FROM GroupAliases WHERE GroupId = '12345' AND Alias = 'Alias'
Columnas
Nombre Tipo Solo lectura Descripción
Alias [KEY] String Falso La dirección de correo del alias.
GroupId String Verdadero Identificación del grupo.
PrimaryEmail String Verdadero Correo electrónico principal del grupo.
ETag String Verdadero ETag del recurso.

Miembros del Grupo

Cree, actualice, elimine y consultar los miembros de un grupo.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de todos los miembros de un grupo, se requiere la columna GroupId. Si no se especifica, se utilizará el ID del primer grupo de la tabla Grupos. El conector procesa otras consultas del lado del cliente en la memoria.

La siguiente consultar muestra el único filtro procesado del lado del servidor por la API de Google Directory:

SELECT * FROM GroupMembers WHERE GroupId = '12345'
Insertar

Para insertar un miembro, se requieren las siguientes columnas: Correo y GroupId. La columna Rol solo acepta los siguientes valores: MIEMBRO, ADMINISTRADOR y PROPIETARIO.

INSERT INTO GroupMembers (Email, GroupId, Role) VALUES ('john@example.com', '12345', 'MEMBER')
Actualizar

Para actualizar un miembro, se requieren las siguientes columnas: GroupId e Id.

UPDATE GroupMembers SET Role='MEMBER' WHERE GroupId='1234' AND Id='12345'
Borrar

Para eliminar un miembro, se requieren las siguientes columnas: GroupId e Id.

DELETE FROM GroupMembers WHERE GroupId='1234' AND Id='12345'
Columnas
Nombre Tipo Solo lectura Descripción
Id [KEY] String Falso El identificador único del miembro.
GroupId String Verdadero El identificador único del miembro.
Email String Falso El correo del miembro.
Role String Falso El nombre del miembro.
Status String Verdadero El estado del miembro.
Type String Verdadero El tipo de miembros.
ETag String Verdadero ETag del recurso

Grupos

Crear, actualizar, eliminar y consultar grupos.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de todos los grupos, se requiere el CustomerId. Puede configurarlo en la cadena de conexión o en la condición de la cláusula WHERE. Si no se especifica, se utilizará el CustomerId de la cuenta actual. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, la siguiente consultar se procesa del lado del servidor mediante la API de Google Directory:

SELECT * FROM Groups
Insertar

Para insertar un grupo, se requiere la columna Correo.

INSERT INTO Groups (Email, Name, Description) VALUES ('group@example.com', 'Group Example Name', 'Example Description')
Actualizar

Para actualizar un grupo, se requiere el ID.

UPDATE Groups SET Email = 'group@example.com', Name = 'Group', Description = 'Description' WHERE ID = 1231
Borrar

Para eliminar un grupo, se requiere la columna ID.

DELETE FROM Groups WHERE Id='12345'
Columnas
Nombre Tipo Solo lectura Descripción
Id [KEY] String Verdadero El identificador único para el grupo.
Email String Falso El correo del grupo.
Name String Falso El nombre del grupo.
MembersCount Long Verdadero El número de miembros.
Description String Falso Descripción del grupo.
Aliases String Verdadero Alias del grupo.
AdminCreated Boolean Verdadero Indica si el grupo fue creado por un administrador.
ETag String Verdadero ETag del recurso
Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Nombre Tipo Descripción
CustomerId String El ID de cliente del grupo.
Domain String Nombre de dominio.

Notificaciones

Actualice, elimine y consultar las notificaciones de un cliente.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de todas las notificaciones, se requiere la columna CustomerId. Se puede establecer en la cadena de conexión o en la condición de la cláusula WHERE. Si no se especifica, se utilizará el CustomerId de la cuenta actual. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, las APIs de Google Directory procesan la siguiente consultar del lado del servidor:

SELECT * FROM Notifications
Insertar

Las inserciones no son compatibles con esta tabla.

Actualizar

Para actualizar una notificación, se requieren las siguientes columnas: CustomerId e Id. Si no se especifica, se utilizará el CustomerId de la cuenta actual.

UPDATE Notifications SET IsUnread = true WHERE ID = '12345' AND CustomerId = '1234'.
Borrar

Para eliminar una notificación, se requieren las siguientes columnas: CustomerId e Id. Si no se especifica, se utilizará el CustomerId de la cuenta actual.

DELETE FROM Notifications WHERE CustomerId = '1234' AND ID = '12345'
Columnas
Nombre Tipo Solo lectura Descripción
Id [KEY] String Verdadero Id de la notificación
Subject String Falso Asunto de la notificación
Body String Verdadero El cuerpo de la notificación
SendDate Datetime Verdadero La fecha en que se envió la notificación
FromAddress String Verdadero La dirección desde la que se recibe la notificación
IsUnread Boolean Falso Indica si la notificación no ha sido leída o no
ETag String Verdadero ETag del recurso
Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Nombre Tipo Descripción
CustomerId String Identificación del cliente

Unidades de Organización

Cree, actualice, elimine y consultar las unidades organizativas de un cliente.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de todas las unidades de la organización, se requiere la columna CustomerId. Se puede establecer en la cadena de conexión o en la condición de la cláusula WHERE. Si no se especifica, se utilizará el CustomerId de la cuenta actual. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, las APIs de Google Directory procesan la siguiente consultar del lado del servidor:

SELECT * FROM OrganizationUnits
Insertar

Para insertar una unidad organizativa, se requieren las siguientes columnas: CustomerId, Name y ParentOrgUnitId. Si no se especifica, se utilizará el CustomerId de la cuenta actual.

INSERT INTO OrganizationUnits (CustomerId, Name, Description, OrgUnitPath, ParentOrgUnitId, ParentOrgUnitPath) VALUES ('12345', 'OrgUnit Name', 'OrgUnit Description', 'Path', '123456', 'ParentPath', '1234')
Actualizar

Para actualizar una unidad organizativa, se requieren las siguientes columnas: CustomerId e Id. Si no se especifica, se utilizará el CustomerId de la cuenta actual.

UPDATE OrganizationUnits SET Name='OrgUnit Name', 'Description = 'OrgUnit Description', OrgUnitPath = 'Path', ParentOrgUnitId = '123456', ParentOrgUnitPath = 'ParentPath' WHERE CustomerId='1234' AND Id='12345'
Borrar

Para eliminar una unidad organizativa, se requieren las siguientes columnas: CustomerId e Id. Si no se especifica, se utilizará el CustomerId de la cuenta actual.

DELETE FROM OrganizationUnits  WHERE CustomerId = '1234' AND ID = '12345'
Columnas
Nombre Tipo Solo lectura Descripción
Id [KEY] String Verdadero Id de la Unidad de Organización.
Name String Falso Nombre de la Unidad de Organización.
Description String Falso Descripción de la Unidad de Organización.
OrgUnitPath String Falso Ruta de la OrgOrganization Unit.Unit
ParentOrgUnitPath String Falso Ruta del padre de la unidad de organización.
ParentOrgUnitId String Falso Id del padre de la Unidad de Organización
ETag String Verdadero ETag del recurso.
Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Nombre Tipo Descripción
CustomerId String Identificación del cliente

Asignaciones de Roles

Cree, elimine y consultar los roles asignados a los usuarios.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de todos los roles asignados a los usuarios, se requiere la columna CustomerId. Si no se especifica, se utilizará el CustomerId de la cuenta actual. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, las APIs de Google Directory procesan la siguiente consultar del lado del servidor:

SELECT * FROM RoleAssignments
Insertar

Para asignar un rol a un usuario, se requieren las siguientes columnas: RoleId, UserId, ScopeType y CustomerId. Si no se especifica, se utilizará el CustomerId de la cuenta actual. ScopeType tiene solo dos valores aceptables: CLIENTE y ORG_UNIT.

INSERT INTO RoleAssignments (RoleId, UserId, ScopeType) VALUES ('12345', '123456', 'CUSTOMER')
Actualizar

No se admiten actualizaciones para esta tabla.

Borrar

Para eliminar un rol asignado de un usuario, se requieren las columnas ID y CustomerId. Si no se especifica, se utilizará el CustomerId de la cuenta actual.

DELETE FROM RoleAssignments WHERE ID = '12345'
Columnas
Nombre Tipo Solo lectura Descripción
Id [KEY] String Verdadero El identificador único de la asignación de rol.
RoleId String Falso El ID del rol que está asignado.
UserId String Falso El ID del usuario al que está asignado este rol.
OrgUnitId String Falso Si el rol está restringido a una unidad organizativa, este contiene el ID de la unidad organizativa a la que está restringido el ejercicio de este rol.
ScopeType String Falso El ámbito en el que se asigna este rol. Los valores aceptables son
Etag String Verdadero Etag del recurso.
Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Nombre Tipo Descripción
CustomerId String Identificación del cliente

Fichas

Consultar y eliminar tokens para un usuario.

Información Específica de la Tabla
Seleccionar

Para obtener un conjunto actual de tokens que un usuario específico ha emitido para aplicaciones de terceros, se requiere la columna UserId. Se puede establecer en la cadena de conexión o en la condición de la cláusula WHERE. Si no se especifica, se utilizará el ID del primer usuario de la tabla Usuarios. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, las APIs de Google Directory procesan la siguiente consultar del lado del servidor:

SELECT * FROM Tokens
Insertar

Las inserciones no son compatibles con esta tabla.

Actualizar

No se admiten actualizaciones para esta tabla.

Borrar

Para eliminar un token, se requieren las columnas UserId e ID.

DELETE FROM Tokens WHERE UserId='12345' AND Id='123456'
Columnas
Nombre Tipo Solo lectura Descripción
Id [KEY] String Falso El ID de cliente de la aplicación para la que se emite el token.
UserId String Falso Agregado de privilegios de niños.
DisplayText String Falso El nombre visible de la aplicación para la que se emite el token.
IsAnonymous Boolean Falso Indica si el nombre del privilegio.
IsNativeApp Boolean Falso Indica si el token se emite a una aplicación instalada.
ScopesAggregate String Falso Agregado de privilegios de niños.
Etag String Falso Etag del recurso.

Alias de Usuario

Enumera los alias, que son direcciones de correo alternativas para un usuario.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de todos los alias de un usuario, se requiere la columna UserId. Se puede establecer en la cadena de conexión o en la condición de la cláusula WHERE. De lo contrario, el conector utilizará automáticamente el ID del primer usuario de la tabla Usuarios. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, las APIs de Google Directory procesan la siguiente consultar del lado del servidor:

SELECT * FROM Aliases
Insertar

Para insertar un alias, se requieren las siguientes columnas: UserId y Alias.

INSERT INTO Aliases (UserId, Alias) VALUES ('12345', 'Alias')
Actualizar

No se admiten actualizaciones para esta tabla.

Borrar

Para eliminar un alias, se requieren las siguientes columnas: UserId y Alias.

DELETE FROM Aliases WHERE ID = '12345' AND Alias = 'Alias'
Columnas
Nombre Tipo Solo lectura Descripción
Alias [KEY] String Falso La dirección de correo del alias.
UserId String Verdadero Identificación del usuario.
PrimaryEmail String Verdadero Correo electrónico principal del usuario.
ETag String Verdadero ETag del recurso.

Usuarios

Consulta de información del usuario.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de todos los usuarios, se requiere CustomerId. Puede configurarlo en la cadena de conexión o en la condición de la cláusula WHERE. Si no se especifica, se utilizará el CustomerId de la cuenta actual. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, las APIs de Google Directory procesan la siguiente consultar del lado del servidor:

SELECT * FROM Users
Insertar

Para insertar un usuario, se requieren las siguientes columnas: PrimaryEmail, FirstName, Surname y Password.

INSERT INTO Users (PrimaryEmail, FirstName, Surname, Password, Suspended) VALUES ('john@example.com', 'John', 'Doe', '12345', true)
Actualizar

Para actualizar un usuario, se requiere la columna ID.

UPDATE Users SET PrimaryEmail = 'john@example.com', FirstName = 'John', Surname = 'Doe', Suspended = true WHERE ID = 1231
Borrar

Para eliminar usuarios, se requiere la columna ID.

DELETE FROM Users WHERE ID = '12345'
Columnas
Nombre Tipo Solo lectura Descripción
Id [KEY] String Verdadero El identificador único para el usuario.
CustomerId String Verdadero El ID de cliente del usuario.
PrimaryEmail String Falso El correo principal del usuario.
FirstName String Falso El primer nombre del usuario.
Surname String Falso El apellido del usuario.
Aliases String Verdadero Los alias del usuario.
IsAdmin Boolean Verdadero Indica si el usuario es un administrador.
IsDelegatedAdmin Boolean Verdadero Indica si el usuario es un administrador delegado.
LastLoginDate Datetime Verdadero Última vez que el usuario inició sesión.
CreationDate Datetime Verdadero Fecha de creación del usuario.
DeletionDate Datetime Verdadero Fecha de eliminación del usuario.
AgreedToTerms Boolean Verdadero Indica si el usuario aceptó los términos o no.
Suspended Boolean Falso Indica si el usuario fue suspendido.
SuspensionReason String Verdadero La razón por la que el usuario fue suspendido.
OrgUnitPath String Falso 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 inclinada (/es/).
IsMailBoxSetup Boolean Verdadero Indica si el buzón de Google del usuario está creado. Esta propiedad solo es aplicable si al usuario se le ha asignado una licencia de Gmail.
IsEnrolledIn2Sv Boolean Verdadero Indica si el usuario está inscrito en la verificación en dos pasos.
IsEnforcedIn2Sv Boolean Verdadero Indica si el usuario se aplica en la verificación de dos pasos.
IncludeInGlobalAddressList Boolean Verdadero Indica si el perfil del usuario está visible en la lista global de direcciones de G Suite cuando la función para compartir contactos está habilitada para el dominio.
ThumbnailPhotoUrl String Verdadero URL de la foto del usuario
Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Nombre Tipo Descripción
Password String La contraseña del usuario.
Domain String Nombre de dominio

Puntos de Vista

Las vistas se componen de columnas y pseudocolumnas. Las vistas son similares a las tablas en la forma en que se representan los datos; sin embargo, las vistas no admiten actualizaciones. Las entidades que se representan como vistas suelen ser entidades de solo lectura. A menudo, un procedimiento almacenado* está disponible para actualizar los datos si dicha funcionalidad es aplicable a la fuente de datos.

Las consultas se pueden ejecutar contra una vista como si fuera una tabla normal, y los datos que regresan son similares en ese sentido.

Se admiten las vistas dinámicas, como las consultas expuestas como vistas y las vistas para buscar combinaciones específicas de elementos de trabajo project_team.

Conector Jitterbit para Vistas de Google Directory

Nombre Descripción
AppSpecificPasswords Enumera todas las contraseñas específicas de la aplicación (contraseñas que se utilizan con aplicaciones que no aceptan códigos de verificación) emitidas por un usuario.
MobileDevices Enumera los dispositivos móviles de una cuenta.
Privileges Enumera todos los privilegios.
Roles Enumera los roles en un dominio.
UserAddresses Muestra las direcciones de un usuario.
UserEmails Consultar los correos de un usuario.
UserInstantMessagingAccounts Consultar las cuentas de IM de un usuario.
UserLocations Consultar las ubicaciones de un usuario.
UserOrganizations Consultar las organizaciones para un usuario.
UserPhones Consultar los números de teléfono de un usuario.
UserWebsites Recuperar una lista de los sitios web de un usuario.
VerificationCodes Consulta los códigos de verificación de un usuario.

Contraseñas Específicas de la Aplicación

Enumera todas las contraseñas específicas de la aplicación (contraseñas que se utilizan con aplicaciones que no aceptan códigos de verificación) emitidas por un usuario.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de todos los tokens específicos de la aplicación emitidos por un usuario, se requiere la columna UserId. Se puede establecer en la cadena de conexión o en la condición de la cláusula WHERE. Si no se especifica, se utilizará el ID del primer usuario de la tabla Usuarios. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, la siguiente consultar se procesa del lado del servidor mediante la API de Google Directory:

SELECT * FROM AppSpecificPasswords
Columnas
Nombre Tipo Descripción
Id [KEY] String El identificador único del ASP.
UserId String El identificador único del usuario que emitió el ASP.
Name String Nombre de la ASP.
CreationDate Datetime La fecha en que se creó el ASP.
LastTimeUsed Datetime La hora en que se utilizó por última vez el ASP.
Etag String Etag del recurso.

Dispositivos Móviles

Enumera los dispositivos móviles de una cuenta.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de todos los dispositivos móviles de una cuenta, se requiere la columna CustomerId. Se puede establecer en la cadena de conexión o en la condición de la cláusula WHERE. Si no se especifica, se utilizará el CustomerId de la cuenta actual. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, las APIs de Google Directory procesan la siguiente consultar del lado del servidor:

SELECT * FROM MobileDevices
Columnas
Nombre Tipo Descripción
Id [KEY] String El número de serie de un dispositivo móvil Google Sync. Para dispositivos Android e iOS, este es un identificador único generado por software.
ResourceId String El ID único que utiliza el servicio API para identificar el dispositivo móvil.
Name String Lista de los nombres de usuario del propietario.
AccountsList String Lista de cuentas agregadas en el dispositivo.
Email String Lista de los correos del propietario.
Model String El nombre del modelo del dispositivo móvil.
OS String El sistema operativo del dispositivo móvil
Type String El tipo de dispositivo móvil.
Status String El estado del dispositivo.
HardwareId String El identificador único IMEI/MEID para el hardware de Android.
FirstSyncDate Datetime La fecha y la hora en que el dispositivo se sincronizó inicialmente con la configuración de la política en la consola de administración.
LastSyncDate Datetime La fecha y la hora en que se sincronizó el dispositivo por última vez con la configuración de la política en la consola de administración.
UserAgent String Brinda información sobre el dispositivo, como la versión del sistema operativo.
SerialNumber String El número de serie del dispositivo.
IMEI String El número IMEI del dispositivo.
MEID String El número MEID del dispositivo.
WiFiMacAddress String La dirección MAC del dispositivo en redes Wi-Fi.
NetworkOperator String Dispositivo móvil Operador de red o móvil.
DefaultLanguage String El idioma predeterminado utilizado en el dispositivo.
DeviceCompromisedStatus String El estado del dispositivo comprometido.
BuildNumber String El número de compilación del sistema operativo del dispositivo.
KernelVersion String La versión del kernel del dispositivo.
BasebandVersion String La versión de banda base del dispositivo.
Manufacturer String El fabricante del dispositivo.
ReleaseVersion String Versión de versión de lanzamiento del dispositivo móvil.
SecurityPatchLevel String El nivel del parche de seguridad del dispositivo.
Brand String La marca del dispositivo.
BootloaderVersion String La versión del gestor de arranque del dispositivo.
Hardware String El hardware del dispositivo.
EncryptionStatus String El estado de cifrado del dispositivo.
DevicePasswordStatus String El estado de la contraseña del dispositivo
Privilege String Permiso DMAgent.
UnknownSourcesStatus Boolean Indica si las fuentes desconocidas están habilitadas o deshabilitadas en el dispositivo
AdbStatus Boolean Indica si adb (depuración USB) está habilitado o deshabilitado en el dispositivo
IsOnOwnerProfile Boolean Indica si esta cuenta está en el propietario/perfil principal o no.
SupportsWorkProfile Boolean Indica si el perfil de trabajo es compatible con el dispositivo.
Etag String Etag del recurso
Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Nombre Tipo Descripción
CustomerId String El ID del cliente

Privilegios

Enumera todos los privilegios.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de todos los privilegios de una cuenta, se requiere la columna CustomerId. Se puede establecer en la cadena de conexión o en la condición de la cláusula WHERE. Si no se especifica, se utilizará el CustomerId de la cuenta actual. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, las APIs de Google Directory procesan la siguiente consultar del lado del servidor:

SELECT * FROM Privileges
Columnas
Nombre Tipo Descripción
ServiceId [KEY] String El ID ofuscado del servicio para el que es este privilegio.
ServiceName [KEY] String El nombre del servicio para el que es este privilegio.
PrivilegeName String El nombre del privilegio.
ParentServiceId String El ID de servicio del privilegio principal.
ParentPrivilegeName String El nombre del privilegio del privilegio primario.
IsOrganizationUnitRestrictable Boolean Indica si el privilegio se puede restringir a una unidad de organización.
Etag String Etag del recurso.
Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Nombre Tipo Descripción
CustomerId String Identificación del cliente

Roles

Enumera los roles en un dominio.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de todos los roles, se requiere la columna CustomerId. Se puede establecer en la cadena de conexión o en la condición de la cláusula WHERE. Si no se especifica, se utilizará el CustomerId de la cuenta actual. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, las APIs de Google Directory procesan la siguiente consultar del lado del servidor:

SELECT * FROM Roles
Columnas
Nombre Tipo Descripción
Id [KEY] String El identificador único para el rol.
Name String Nombre del rol.
Description String Una breve descripción del rol.
PrivilegeName String El nombre del privilegio.
ServiceId String El ID del servicio para el que es el privilegio.
IsSystemRole Boolean Indica si se trata de un rol de sistema predefinido.
IsSuperAdminRole Boolean Indica si el rol es un rol de superadministrador.
Etag String Etag del recurso.
Pseudo-Columnas

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Nombre Tipo Descripción
CustomerId String Identificación del cliente

Direcciones de Usuario

Muestra las direcciones de un usuario.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de direcciones de un usuario, se requiere la columna UserId. Se puede establecer en la cadena de conexión o en la condición de la cláusula WHERE. De lo contrario, el conector utilizará automáticamente el ID de usuario del primer usuario de la tabla Usuarios. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, las APIs de Google Directory procesan la siguiente consultar del lado del servidor:

SELECT * FROM UserAddresses
Columnas
Nombre Tipo Descripción
UserId String El identificador único para el usuario.
Type String El tipo de dirección.
CustomType String El tipo personalizado de la dirección.
FormattedAddress String La dirección postal completa no estructurada.
PoBox String Apartado de correos de la dirección.
ExtendedAddress String La dirección extendida
StreetAddress String La dirección de la calle
Locality String El pueblo o ciudad de la dirección.
Region String La provincia o estado abreviado.
PostalCode String El código postal o postal, si corresponde.
Country String País en la dirección.
CountryCode String El código del país. Utiliza la norma ISO 3166-1.
IsPrimary Boolean Indica si esta es la dirección principal del usuario

Correos Electrónicos de Usuario

Consultar los correos de un usuario.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de direcciones de correo de un usuario, se requiere la columna UserId. Se puede establecer en la cadena de conexión o en la condición de la cláusula WHERE. De lo contrario, el conector utilizará automáticamente el ID del primer usuario de la tabla Usuarios. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, las APIs de Google Directory procesan la siguiente consultar del lado del servidor:

SELECT * FROM UserEmails
Columnas
Nombre Tipo Descripción
Address String La dirección de correo del usuario
UserId String El identificador único para el usuario.
IsPrimary String Indica si este es el correo principal del usuario.
CustomType String El tipo personalizado del correo.
Type String El tipo de la cuenta de correo.

Cuentas de Mensajería Instantánea de Usuario

Consultar las cuentas de IM de un usuario.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de cuentas de IM para un usuario, se requiere la columna UserId. Se puede establecer en la cadena de conexión o en la condición de la cláusula WHERE. De lo contrario, el conector utilizará automáticamente el ID del primer usuario de la tabla Usuarios. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, las APIs de Google Directory procesan la siguiente consultar del lado del servidor:

SELECT * FROM UserInstantMessagingAccounts
Columnas
Nombre Tipo Descripción
IM String El ID de red de mensajería instantánea del usuario.
UserId String El identificador único para el usuario.
Protocol String El protocolo IM identifica la red IM.
CustomProtocol String El tipo personalizado del protocolo IM.
IsPrimary String Indica si este es el MI principal del usuario.
CustomType String El tipo personalizado de la cuenta de IM.
Type String El tipo de cuenta de IM.

Ubicaciones de Usuario

Consultar las ubicaciones de un usuario.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de ubicaciones de un usuario, se requiere la columna UserId. Se puede establecer en la cadena de conexión o en la condición de la cláusula WHERE. De lo contrario, el conector utilizará automáticamente el ID del primer usuario de la tabla Usuarios. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, las APIs de Google Directory procesan la siguiente consultar del lado del servidor:

SELECT * FROM UserLocations
Columnas
Nombre Tipo Descripción
Area String Ubicación textual del usuario.
UserId String El identificador único para el usuario.
BuildingId String El identificador del edificio.
DeskCode String La ubicación del escritorio.
FloorName String El nombre/número del piso
FloorSection String La sección del piso.
CustomType String El tipo personalizado de la ubicación.
Type String El tipo de ubicación.

Organizaciones de Usuarios

Consultar las organizaciones para un usuario.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de organizaciones para un usuario, se requiere la columna UserId. Se puede establecer en la cadena de conexión o en la condición de la cláusula WHERE. De lo contrario, el conector utilizará automáticamente el ID del primer usuario de la tabla Usuarios. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, las APIs de Google Directory procesan la siguiente consultar del lado del servidor:

SELECT * FROM UserOrganizations
Columnas
Nombre Tipo Descripción
Name String El nombre de la organización.
UserId String El identificador único para el usuario.
OrganizationDomain String El dominio al que pertenece la organización.
Department String Especifica el departamento dentro de la organización.
Description String La descripción de la organización.
Title String El cargo del usuario dentro de la organización.
CostCenter String El centro de costos de la organización del usuario.
Location String La ubicación física de la organización.
IsPrimary Boolean Indica si esta es la organización principal del usuario.
Symbol String Símbolo de cadena de texto de la organización.
Type String País en la dirección.
CustomType String Si el valor de tipo es personalizado, esta propiedad contiene el tipo personalizado.

UsuarioTeléfonos

Consultar los números de teléfono de un usuario.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de teléfonos para un usuario, se requiere la columna UserId. Se puede establecer en la cadena de conexión o en la condición de la cláusula WHERE. De lo contrario, el conector utilizará automáticamente el ID del primer usuario de la tabla Usuarios. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, las APIs de Google Directory procesan la siguiente consultar del lado del servidor:

SELECT * FROM UserPhones
Columnas
Nombre Tipo Descripción
PhoneNumber String El número de teléfono del usuario.
UserId String El identificador único para el usuario.
IsPrimary String Indica si este es el MI principal del usuario.
CustomType String El tipo personalizado del número de teléfono.
Type String El tipo de número de teléfono.

Sitios Web de Usuario

Recuperar una lista de los sitios web de un usuario.

Información Específica de la Tabla
Seleccionar

Para obtener una lista de sitios web para un usuario, se requiere la columna UserId. Se puede establecer en la cadena de conexión o en la condición de la cláusula WHERE. De lo contrario, el conector utilizará automáticamente el ID del primer usuario de la tabla Usuarios. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, las APIs de Google Directory procesan la siguiente consultar del lado del servidor:

SELECT * FROM UserWebsites
Columnas
Nombre Tipo Descripción
URL String La URL del sitio web.
UserId String El identificador único para el usuario.
CustomType String El tipo personalizado del sitio web.
Type String El tipo de sitio web.
IsPrimary Boolean Indica si este es el sitio web principal del usuario o no

Códigos de Verificación

Consulta los códigos de verificación de un usuario.

Información Específica de la Tabla
Seleccionar

Para obtener un conjunto actual de códigos de verificación de respaldo válidos para un usuario específico, se requiere la columna UserId. Se puede establecer en la cadena de conexión o en la condición de la cláusula WHERE. Si no se especifica, se utilizará el ID del primer usuario de la tabla Usuarios. El conector procesa otras consultas del lado del cliente en la memoria.

Por ejemplo, las APIs de Google Directory procesan la siguiente consultar del lado del servidor:

SELECT * FROM VerificationCodes
Columnas
Nombre Tipo Descripción
UserId String La identificación única del usuario.
VerificationCode String Un código de verificación actual para el usuario.
Etag String Etag del recurso.

Procedimientos Almacenados

Procedimientos almacenados* son interfaces similares a funciones que amplían la funcionalidad del conector más allá de las simples operaciones SELECCIONAR/INSERTAR/ACTUALIZAR/ELIMINAR con Google Directory.

Procedimientos almacenados* aceptan una lista de parámetros, realizan la función prevista y luego devuelven, si corresponde, cualquier dato de respuesta relevante del Google Directory, junto con una indicación de si el procedimiento tuvo éxito o falló.

Jitterbit Connector para los Procedimientos Almacenados del Google Directory

Nombre Descripción
ChangeAdminStatus Cambiar el estado de administrador de un usuario.
GenerateVerificationCodes Generar códigos de verificación para un usuario.
GetOAuthAccessToken Obtiene el token de acceso de OAuth que se utilizará para la autenticación con varios servicios de Google.
GetOAuthAuthorizationURL Obtiene la URL de autorización de OAuth utilizada para la autenticación con varios servicios de Google.
InvalidateVerificationCodes Invalidar códigos de verificación para un usuario.
RefreshOAuthAccessToken Obtiene el token de acceso de OAuth que se utilizará para la autenticación con varios servicios de Google.

ChangeAdminStatus

Cambiar el estado de administrador de un usuario.

Aporte
Nombre Tipo Descripción
UserId String Identificación del usuario. El valor puede ser la dirección de correo principal del usuario, la dirección de correo de alias o el ID de usuario único.
Status String Nuevo estado de administrador del usuario.

Generar Códigos de Verificación

Generar códigos de verificación para un usuario.

Aporte
Nombre Tipo Descripción
UserId String Identificación del usuario.

Obtener Token de Acceso de OAuth

Obtiene el token de acceso de OAuth que se utilizará para la autenticación con varios servicios de Google. NOTE: Si, después de ejecutar este procedimiento almacenado, OAuthRefreshToken no se devolvió como parte del conjunto de resultados, cambie el valor de Solicitud a CONSENT y vuelva a ejecutar el procedimiento. Esto obliga a la aplicación a volver a autenticarse y enviar nueva información de token.

Aporte
Nombre Tipo Descripción
AuthMode String El tipo de modo de autenticación a utilizar. Los valores permitidos son APP, WEB. El valor predeterminado es WEB.
Verifier String El código verificador devuelto por Google después de que se haya otorgado el permiso para que la aplicación se conecte. Modo de autenticación WEB únicamente.
Scope String El alcance del acceso a las APIs de Google. De forma predeterminada, se especificará el acceso a todas las APIs utilizadas por este proveedor de datos. El valor predeterminado es *https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly https://www.googleapis.com/auth/admin.directory.domain.readonly https://www.googleapis.com/auth/admin.directory.user.readonly https://www.googleapis.com/auth/admin.directory.user.alias.readonly https://www.googleapis.com/auth/admin.directory.group.member.readonly https://www.googleapis.com/auth/admin.directory.group.readonly https://www.googleapis.com/auth/admin.directory.orgunit.readonly https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly https://www.googleapis.com/auth/admin.directory.device.mobile.readonly*.
CallbackURL String Este campo determina dónde se envía la respuesta. El valor de este parámetro debe coincidir exactamente con uno de los valores registrados en la consola de APIs, incluidos los esquemas HTTP o HTTPS, las mayúsculas y la barra diagonal final ('/').
Prompt String Este campo indica el aviso para presentar al usuario. Acepta uno de los siguientes valores: NINGUNO, CONSENTIMIENTO, SELECCIONAR CUENTA. El valor predeterminado es SELECT_ACCOUNT, por lo que se le pedirá a un usuario determinado que seleccione la cuenta a la que conectarse. Si se establece en CONSENTIMIENTO, el usuario verá una página de consentimiento cada vez, incluso si previamente ha dado su consentimiento a la aplicación para un conjunto determinado de ámbitos. Por último, si se establece en NINGUNO, no se mostrarán pantallas de autenticación o consentimiento al usuario. El valor predeterminado es SELECT_ACCOUNT.
AccessType String Este campo indica si su aplicación necesita acceder a una API de Google cuando el usuario no está presente en el navegador. Este parámetro está predeterminado en FUERA DE LÍNEA. Si su aplicación necesita actualizar los tokens de acceso cuando el usuario no está presente en el navegador, use OFFLINE. Esto hará que su aplicación obtenga un token de actualización la primera vez que intercambie un código de autorización para un usuario. Los valores permitidos son ONLINE, OFFLINE. El valor predeterminado es FUERA DE LÍNEA.
State String Este campo indica cualquier estado que pueda ser de utilidad para su solicitud al recibir la respuesta. Su aplicación recibe el mismo valor que envió, ya que este parámetro realiza un viaje de ida y vuelta al servidor de autorización de Google y viceversa. Los usos incluyen redirigir al usuario al recurso correcto en su sitio, usar nonces y mitigar la falsificación de solicitudes entre sitios.
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
OAuthAccessToken String El token de autenticación devuelto por Google. Esto se puede usar en llamadas posteriores a otras operaciones para este servicio en particular.
OAuthRefreshToken String Un token que puede usarse para obtener un nuevo token de acceso.
ExpiresIn String El tiempo de vida restante en el token de acceso.

Obtener URL de Autorización de OAuth

Obtiene la URL de autorización de OAuth utilizada para la autenticación con varios servicios de Google.

Aporte
Nombre Tipo Descripción
Scope String El alcance del acceso a las APIs de Google. De forma predeterminada, se especificará el acceso a todas las APIs utilizadas por este proveedor de datos. El valor predeterminado es *https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly https://www.googleapis.com/auth/admin.directory.domain.readonly https://www.googleapis.com/auth/admin.directory.user.readonly https://www.googleapis.com/auth/admin.directory.user.alias.readonly https://www.googleapis.com/auth/admin.directory.group.member.readonly https://www.googleapis.com/auth/admin.directory.group.readonly https://www.googleapis.com/auth/admin.directory.orgunit.readonly https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly https://www.googleapis.com/auth/admin.directory.device.mobile.readonly*.
CallbackURL String Este campo determina dónde se envía la respuesta. El valor de este parámetro debe coincidir exactamente con uno de los valores registrados en la consola de APIs, incluidos los esquemas HTTP o HTTPS, mayúsculas y minúsculas y barra diagonal final ('/').
Prompt String Este campo indica el aviso para presentar al usuario. Acepta uno de los siguientes valores: NINGUNO, CONSENTIMIENTO, SELECCIONAR CUENTA. El valor predeterminado es SELECT_ACCOUNT, por lo que se le pedirá a un usuario determinado que seleccione la cuenta a la que conectarse. Si se establece en CONSENTIMIENTO, el usuario verá una página de consentimiento cada vez, incluso si previamente ha dado su consentimiento a la aplicación para un conjunto determinado de ámbitos. Por último, si se establece en NINGUNO, no se mostrarán pantallas de autenticación o consentimiento al usuario. El valor predeterminado es SELECT_ACCOUNT.
AccessType String Este campo indica si su aplicación necesita acceder a una API de Google cuando el usuario no está presente en el navegador. Este parámetro está predeterminado en FUERA DE LÍNEA. Si su aplicación necesita actualizar los tokens de acceso cuando el usuario no está presente en el navegador, use OFFLINE. Esto hará que su aplicación obtenga un token de actualización la primera vez que intercambie un código de autorización para un usuario. Los valores permitidos son ONLINE, OFFLINE. El valor predeterminado es FUERA DE LÍNEA.
State String Este campo indica cualquier estado que pueda ser de utilidad para su solicitud al recibir la respuesta. Su aplicación recibe el mismo valor que envió, ya que este parámetro realiza un viaje de ida y vuelta al servidor de autorización de Google y viceversa. Los usos posibles incluyen redirigir al usuario al recurso correcto en su sitio, usar nonces y mitigar la falsificación de solicitudes entre sitios.
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
URL String La URL para completar la autenticación del usuario.

InvalidateVerificationCodes

Invalidar códigos de verificación para un usuario.

Aporte
Nombre Tipo Descripción
UserId String Identificación del usuario.

RefreshOAuthAccessToken

Obtiene el token de acceso de OAuth que se utilizará para la autenticación con varios servicios de Google.

Aporte
Nombre Tipo Descripción
OAuthRefreshToken String El token de actualización devuelto del intercambio de código de autorización original.
Columnas del Conjunto de Resultados
Nombre Tipo Descripción
OAuthAccessToken String El token de autenticación devuelto por Google. Esto se puede usar en llamadas posteriores a otras operaciones para este servicio en particular.
OAuthRefreshToken String El token de autenticación devuelto por Google. Esto se puede usar en llamadas posteriores a otras operaciones para este servicio en particular.
ExpiresIn String El tiempo de vida restante en el token de acceso.

Tablas del Sistema

Puede consultar las tablas del sistema que se describen en esta sección para acceder a la información del esquema, la información sobre la funcionalidad del origen de datos y las estadísticas de operación lote.

Tablas de Esquema

Las siguientes tablas devuelven metadatos de la base de datos para Google Directory:

Tablas de Fuentes de Datos

Las siguientes tablas devuelven información sobre cómo conectarse y consultar la fuente de datos:

  • sys_connection_props: Devuelve información sobre las propiedades de conexión disponibles.
  • sys_sqlinfo: describe las consultas SELECT que el conector puede descargar al origen de datos.

Tablas de Información de Consultas

La siguiente tabla devuelve estadísticas de consultar para consultas de modificación de datos:

  • identidad_sys: devuelve información sobre operaciones lote o actualizaciones individuales.

Sys_catalogs

Enumera las bases de datos disponibles.

La siguiente consultar recupera todas las bases de datos determinadas por la cadena de conexión:

SELECT * FROM sys_catalogs
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos.

Sys_schemas

Enumera los esquemas disponibles.

La siguiente consultar recupera todos los esquemas disponibles:

SELECT * FROM sys_schemas
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos.
SchemaName String El nombre del esquema.

Sys_tables

Enumera las tablas disponibles.

La siguiente consultar recupera las tablas y vistas disponibles:

SELECT * FROM sys_tables
Columnas
Nombre Tipo Descripción
CatalogName String La base de datos que contiene la tabla o vista.
SchemaName String El esquema que contiene la tabla o vista.
TableName String El nombre de la tabla o vista.
TableType String El tipo de tabla (tabla o vista).
Description String Una descripción de la tabla o vista.
IsUpdateable Boolean Si la tabla se puede actualizar.

Sys_tablecolumns

Describe las columnas de las tablas y vistas disponibles.

La siguiente consultar devuelve las columnas y los tipos de datos de la tabla Group:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Group' 
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos que contiene la tabla o vista.
SchemaName String El esquema que contiene la tabla o vista.
TableName String El nombre de la tabla o vista que contiene la columna.
ColumnName String El nombre de la columna.
DataTypeName String El nombre del tipo de datos.
DataType Int32 Un número entero que indica el tipo de datos. Este valor se determina en tiempo de ejecución en función del ambiente.
Length Int32 El tamaño de almacenamiento de la columna.
DisplaySize Int32 El ancho máximo normal de la columna designada en caracteres.
NumericPrecision Int32 El número máximo de dígitos en datos numéricos. La longitud de la columna en caracteres para datos de carácter y fecha y hora.
NumericScale Int32 La escala de columna o número de dígitos a la derecha del punto decimal.
IsNullable Boolean Si la columna puede contener nulo.
Description String Una breve descripción de la columna.
Ordinal Int32 El número de secuencia de la columna.
IsAutoIncrement String Si el valor de la columna se asigna en incrementos fijos.
IsGeneratedColumn String Si se genera la columna.
IsHidden Boolean Si la columna está oculta.
IsArray Boolean Si la columna es una matriz.

Sys_procedimientos

Enumera los procedimientos almacenados disponibles.

La siguiente consultar recupera los procedimientos almacenados disponibles:

SELECT * FROM sys_procedures
Columnas
Nombre Tipo Descripción
CatalogName String La base de datos que contiene el procedimiento almacenado.
SchemaName String El esquema que contiene el procedimiento almacenado.
ProcedureName String El nombre del procedimiento almacenado.
Description String Una descripción del procedimiento almacenado.
ProcedureType String El tipo de procedimiento, como PROCEDIMIENTO o FUNCIÓN.

Sys_procedureparameters

Describe procedimiento almacenado* parámetros.

La siguiente consultar devuelve información sobre todos los parámetros de entrada para el procedimiento almacenado RefreshOAuthAccessToken:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='RefreshOAuthAccessToken' AND Direction=1 OR Direction=2
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos que contiene el procedimiento almacenado.
SchemaName String El nombre del esquema que contiene el procedimiento almacenado.
ProcedureName String El nombre del procedimiento almacenado* que contiene el parámetro.
ColumnName String El nombre del procedimiento almacenado* parámetro.
Direction Int32 Un número entero correspondiente al tipo de parámetro: entrada (1), entrada/salida (2) o salida (4). Los parámetros de tipo de entrada/salida pueden ser tanto parámetros de entrada como de salida.
DataTypeName String El nombre del tipo de datos.
DataType Int32 Un número entero que indica el tipo de datos. Este valor se determina en tiempo de ejecución en función del ambiente.
Length Int32 El número de caracteres permitidos para los datos de caracteres. El número de dígitos permitidos para datos numéricos.
NumericPrecision Int32 La máxima precisión para datos numéricos. La longitud de la columna en caracteres para datos de carácter y fecha y hora.
NumericScale Int32 El número de dígitos a la derecha del punto decimal en datos numéricos.
IsNullable Boolean Si el parámetro puede contener nulo.
IsRequired Boolean Si el parámetro es necesario para la ejecución del procedimiento.
IsArray Boolean Si el parámetro es una matriz.
Description String La descripción del parámetro.
Ordinal Int32 El índice del parámetro.

Sys_keycolumns

Describe las claves primarias y foráneas. La siguiente consultar recupera la clave principal de la tabla Group:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Group'
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos que contiene la clave.
SchemaName String El nombre del esquema que contiene la clave.
TableName String El nombre de la tabla que contiene la clave.
ColumnName String El nombre de la columna clave.
IsKey Boolean Si la columna es una clave principal en la tabla a la que se hace referencia en el campo TableName.
IsForeignKey Boolean Si la columna es una clave externa a la que se hace referencia en el campo TableName.
PrimaryKeyName String El nombre de la clave principal.
ForeignKeyName String El nombre de la clave foránea.
ReferencedCatalogName String La base de datos que contiene la clave principal.
ReferencedSchemaName String El esquema que contiene la clave principal.
ReferencedTableName String La tabla que contiene la clave principal.
ReferencedColumnName String El nombre de la columna de la clave principal.

Sys_foreignkeys

Describe las claves foráneas. La siguiente consultar recupera todas las claves foráneas que hacen referencia a otras tablas:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos que contiene la clave.
SchemaName String El nombre del esquema que contiene la clave.
TableName String El nombre de la tabla que contiene la clave.
ColumnName String El nombre de la columna clave.
PrimaryKeyName String El nombre de la clave principal.
ForeignKeyName String El nombre de la clave foránea.
ReferencedCatalogName String La base de datos que contiene la clave principal.
ReferencedSchemaName String El esquema que contiene la clave principal.
ReferencedTableName String La tabla que contiene la clave principal.
ReferencedColumnName String El nombre de la columna de la clave principal.
ForeignKeyType String Designa si la clave externa es una clave de importación (apunta a otras tablas) o de exportación (hace referencia desde otras tablas).

Sys_primarykeys

Describe las claves primarias. La siguiente consultar recupera las claves principales de todas las tablas y vistas:

SELECT * FROM sys_primarykeys
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos que contiene la clave.
SchemaName String El nombre del esquema que contiene la clave.
TableName String El nombre de la tabla que contiene la clave.
ColumnName String El nombre de la columna clave.
KeySeq String El número de secuencia de la clave principal.
KeyName String El nombre de la clave principal.

Sys_indexes

Describe los índices disponibles. Al filtrar en los índices, puede escribir consultas más selectivas con tiempos de respuesta de consultar más rápidos.

La siguiente consultar recupera todos los índices que no son claves principales:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columnas
Nombre Tipo Descripción
CatalogName String El nombre de la base de datos que contiene el índice.
SchemaName String El nombre del esquema que contiene el índice.
TableName String El nombre de la tabla que contiene el índice.
IndexName String El nombre del índice.
ColumnName String El nombre de la columna asociada con el índice.
IsUnique Boolean True si el índice es único. Falso en caso contrario.
IsPrimary Boolean True si el índice es una clave principal. Falso en caso contrario.
Type Int16 Un valor entero correspondiente al tipo de índice: estadística (0), agrupado (1), hash (2) u otro (3).
SortOrder String El orden de clasificación: A para ascender o D para descender.
OrdinalPosition Int16 El número de secuencia de la columna en el índice.

Sys_connection_props

Devuelve información sobre las propiedades de conexión disponibles y las establecidas en la cadena de conexión.

Al consultar esta tabla, se debe usar la cadena de conexión de configuración:

jdbc:cdata:googledirectory:config:

Esta cadena de conexión le permite consultar esta tabla sin una conexión válida.

La siguiente consultar recupera todas las propiedades de conexión que se han establecido en la cadena de conexión o se han establecido a través de un valor predeterminado:

SELECT * FROM sys_connection_props WHERE Value <> ''
Columnas
Nombre Tipo Descripción
Name String El nombre de la propiedad de conexión.
ShortDescription String Una breve descripción.
Type String El tipo de datos de la propiedad de conexión.
Default String El valor predeterminado si no se establece uno explícitamente.
Values String Una lista separada por comas de valores posibles. Se lanza un error de validación si se especifica otro valor.
Value String El valor que establezca o un valor predeterminado preconfigurado.
Required Boolean Si la propiedad es necesaria para conectarse.
Category String La categoría de la propiedad de conexión.
IsSessionProperty String Si la propiedad es una propiedad de sesión, utilizada para guardar información sobre la conexión actual.
Sensitivity String El nivel de sensibilidad de la propiedad. Esto informa si la propiedad está ofuscada en los formularios de registro y autenticación.
PropertyName String Una forma truncada en mayúsculas y minúsculas del nombre de la propiedad de conexión.
Ordinal Int32 El índice del parámetro.
CatOrdinal Int32 El índice de la categoría de parámetro.
Hierarchy String Muestra las propiedades dependientes asociadas que deben configurarse junto con esta.
Visible Boolean Informa si la propiedad está visible en la interfaz de usuario de la conexión.
ETC String Diversa información miscelánea sobre la propiedad.

Sys_sqlinfo

Describe el procesamiento de consultar SELECT que el conector puede descargar al origen de datos.

Descubrimiento de las Capacidades SELECT de la Fuente de Datos

A continuación se muestra un conjunto de datos de ejemplo de las capacidades de SQL. El siguiente conjunto de resultados indica la funcionalidad SELECT que el conector puede descargar en el origen de datos o en el lado del cliente del proceso. Su fuente de datos puede admitir sintaxis SQL adicional. Algunos aspectos de la funcionalidad SELECT se devuelven en una lista separada por comas si es compatible; de lo contrario, la columna contiene NO.

Nombre Descripción Valores posibles
AGGREGATE_FUNCTIONS Funciones de agregación admitidas. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Si se admite la función COUNT. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR El carácter de apertura utilizado para escapar de un identificador. [
IDENTIFIER_QUOTE_CLOSE_CHAR El carácter de cierre utilizado para escapar de un identificador. ]
SUPPORTED_OPERATORS Una lista de operadores de SQL admitidos. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Si se admite GROUP BY y, de ser así, el grado de compatibilidad. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Funciones de cadena admitidas. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Funciones numéricas compatibles. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Funciones de fecha/hora admitidas. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Indica tablas omitidas durante la replicación.
REPLICATION_TIMECHECK_COLUMNS Una matriz de cadenas que contiene una lista de columnas que se usarán para verificar (en el orden dado) para usar como una columna modificada durante la replicación.
IDENTIFIER_PATTERN Valor de cadena que indica qué cadena es válida para un identificador.
SUPPORT_TRANSACTION Indica si el proveedor admite transacciones como compromiso y reversión. YES, NO
DIALECT Indica el dialecto SQL a usar.
KEY_PROPERTIES Indica las propiedades que identifican la base de datos uniforme.
SUPPORTS_MULTIPLE_SCHEMAS Indica si pueden existir varios esquemas para el proveedor. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indica si pueden existir varios catálogos para el proveedor. YES, NO
DATASYNCVERSION La versión de sincronización de datos necesaria para acceder a este controlador. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY La categoría Sincronización de datos de este controlador. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Si se admite la funcionalidad de SQL mejorada más allá de lo que ofrece la API. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Si se admiten las operaciones lote. YES, NO
SQL_CAP Todas las funciones de SQL admitidas para este controlador. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS Un valor de cadena especifica las cacheOptions preferidas.
ENABLE_EF_ADVANCED_QUERY Indica si el controlador admite directamente consultas avanzadas provenientes de Entity Framework. De lo contrario, las consultas se manejarán del lado del cliente. YES, NO
PSEUDO_COLUMNS Una matriz de cadenas que indica las pseudocolumnas disponibles.
MERGE_ALWAYS Si el valor es verdadero, el modo de combinación se ejecuta a la fuerza en la sincronización de datos. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY Una consultar de selección para devolver la fecha y hora de inicio de la réplica.
REPLICATION_MIN_FUNCTION Permite que un proveedor especifique el nombre de la fórmula que se usará para ejecutar un min del lado del servidor.
REPLICATION_START_DATE Permite que un proveedor especifique una fecha de inicio de réplica.
REPLICATION_MAX_DATE_QUERY Una consultar de selección para devolver la fecha y hora de finalización de la réplica.
REPLICATION_MAX_FUNCTION Permite que un proveedor especifique el nombre de la fórmula que se usará para ejecutar un máx. del lado del servidor.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE Una lista de tablas que omitirán dividir la réplica en fragmentos en la réplica inicial.
CHECKCACHE_USE_PARENTID Indica si la instrucción CheckCache debe realizarse en la columna de clave principal. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indica procedimientos almacenados* que se puede utilizar para generar archivos de esquema.

La siguiente consultar recupera los operadores que se pueden usar en la cláusula WHERE:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Tenga en cuenta que las tablas individuales pueden tener diferentes limitaciones o requisitos en la cláusula WHERE; consulte el Modelo de datos para obtener más información.

Columnas
Nombre Tipo Descripción
NAME String Un componente de la sintaxis SQL o una capacidad que se puede procesar en el servidor.
VALUE String Detalles sobre el SQL o la sintaxis de SQL admitidos.

Sys_identidad

Devuelve información sobre los intentos de modificación.

La siguiente consultar recupera los Id. de las filas modificadas en una operación lote:

SELECT * FROM sys_identity
Columnas
Nombre Tipo Descripción
Id String El ID generado por la base de datos devuelto de una operación de modificación de datos.
Batch String Un identificador para el lote. 1 para una sola operación.
Operation String El resultado de la operación en el lote: INSERTADO, ACTUALIZADO o ELIMINADO.
Message String ÉXITO o un mensaje de error si falla la actualización en el lote.

Propiedades de Configuraciones Avanzadas

Las propiedades de configuraciones avanzadas son las diversas opciones que se pueden utilizar para establecer una conexión. Esta sección proporciona una lista completa de las opciones que puede configurar. Haga clic en los enlaces para obtener más detalles.

Autenticación

Propiedad Descripción
AuthScheme El tipo de autenticación que se utilizará al conectarse a Google Directory.

OAuth

Propiedad Descripción
InitiateOAuth Establezca esta propiedad para iniciar el proceso para obtener o actualizar el token de acceso de OAuth cuando se conecte.
OAuthClientId El ID de cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.
OAuthClientSecret El secreto del cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.
OAuthAccessToken El token de acceso para conectarse mediante OAuth.
CallbackURL La URL de devolución de llamada de OAuth a la que volver cuando se autentica. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación.
Scope Especifique el ámbito para obtener el acceso inicial y el token de actualización.
OAuthVerifier El código verificador devuelto desde la URL de autorización de OAuth.
OAuthRefreshToken El token de actualización de OAuth para el token de acceso de OAuth correspondiente.
OAuthExpiresIn La vida útil en segundos del AccessToken de OAuth.
OAuthTokenTimestamp La marca de tiempo de la época de Unix en milisegundos cuando se creó el token de acceso actual.

JWT OAuth

Propiedad Descripción
OAuthJWTCert El almacén de certificados JWT.
OAuthJWTCertType El tipo de almacén de claves que contiene el certificado JWT.
OAuthJWTCertPassword La contraseña para el certificado OAuth JWT.
OAuthJWTCertSubject El asunto del certificado OAuth JWT.
OAuthJWTIssuer El emisor del token web de Java.
OAuthJWTSubject El sujeto de usuario para el que la aplicación solicita acceso delegado.

SSL

Propiedad Descripción
SSLServerCert El certificado que se aceptará del servidor al conectarse mediante TLS/SSL.

Esquema

Propiedad Descripción
Location Una ruta al directorio que contiene los archivos de esquema que definen tablas, vistas y procedimientos almacenados.
BrowsableSchemas Esta propiedad restringe los esquemas informados a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propiedad restringe las tablas notificadas a un subconjunto de las tablas disponibles. Por ejemplo, Tablas=TablaA, TablaB, TablaC.
Views Restringe las vistas informadas a un subconjunto de las tablas disponibles. Por ejemplo, Vistas=VistaA, VistaB, VistaC.

Misceláneas

Propiedad Descripción
CustomerId Restrinja los resultados de la consultar a este cliente.
Domain Restrinja las consultas a este dominio.
GroupId Restrinja los resultados de la consultar a este grupo.
MaxRows Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.
Other Estas propiedades ocultas se usan solo en casos de uso específicos.
Pagesize El número máximo de resultados que se devolverán por página desde el Google Directory.
PseudoColumns Esta propiedad indica si incluir o no pseudocolumnas como columnas en la tabla.
Timeout El valor en segundos hasta que se lanza el error de tiempo de espera, cancelando la operación.
UserDefinedViews Una ruta de archivo que apunta al archivo de configuración JSON que contiene sus vistas personalizadas.
UserId Restrinja los resultados de la consultar a este usuario.

Autenticación

Esta sección proporciona una lista completa de las propiedades de autenticación que puede configurar.

Propiedad Descripción
AuthScheme El tipo de autenticación que se utilizará al conectarse a Google Directory.

AuthScheme

El tipo de autenticación que se utilizará al conectarse a Google Directory.

Valores Posibles

Auto, OAuth, OAuthJWT, GCPInstanceAccount

Tipo de Datos

string

Valor por Defecto

"Auto"

Observaciones
  • Automático: permite que el controlador decida automáticamente según las otras propiedades de conexión que haya establecido.
  • OAuth: Configure esto para realizar la autenticación OAuth usando una cuenta de usuario estándar.
  • OAuthJWT: Configure esto para realizar la autenticación OAuth usando una cuenta de servicio OAuth.
  • GCPInstanceAccount: configure esto para obtener el token de acceso de la instancia de Google Cloud Platform.

OAuth

Esta sección proporciona una lista completa de las propiedades de OAuth que puede configurar.

Propiedad Descripción
InitiateOAuth Establezca esta propiedad para iniciar el proceso para obtener o actualizar el token de acceso de OAuth cuando se conecte.
OAuthClientId El ID de cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.
OAuthClientSecret El secreto del cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.
OAuthAccessToken El token de acceso para conectarse mediante OAuth.
CallbackURL La URL de devolución de llamada de OAuth a la que volver cuando se autentica. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación.
Scope Especifique el ámbito para obtener el acceso inicial y el token de actualización.
OAuthVerifier El código verificador devuelto desde la URL de autorización de OAuth.
OAuthRefreshToken El token de actualización de OAuth para el token de acceso de OAuth correspondiente.
OAuthExpiresIn La vida útil en segundos del AccessToken de OAuth.
OAuthTokenTimestamp La marca de tiempo de la época de Unix en milisegundos cuando se creó el token de acceso actual.

Iniciar OAuth

Establezca esta propiedad para iniciar el proceso para obtener o actualizar el token de acceso de OAuth cuando se conecte.

Valores Posibles

OFF, GETANDREFRESH, REFRESH

Tipo de Datos

string

Valor por Defecto

"OFF"

Observaciones

Las siguientes opciones están disponibles:

  1. OFF: Indica que el flujo de OAuth será manejado en su totalidad por el usuario. Se requerirá un OAuthAccessToken para la autenticación.
  2. GETANDREFRESH: indica que el conector manejará todo el flujo de OAuth. Si actualmente no existe ningún token, se obtendrá solicitándolo al usuario a través del navegador. Si existe un token, se actualizará cuando corresponda.
  3. REFRESH: indica que el conector solo manejará la actualización de OAuthAccessToken. El conector nunca le pedirá al usuario que se autentique a través del navegador. El usuario debe manejar la obtención de OAuthAccessToken y OAuthRefreshToken inicialmente.

OAuthClientId

El ID de cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Como parte del registro de una aplicación OAuth, recibirá el OAuthClientId valor, a veces también llamado clave de consumidor, y un secreto de cliente, el OAuthClientSecret.

OAuthClientSecretOAuthClientSecret

El secreto del cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Como parte del registro de una aplicación OAuth, recibirá el OAuthClientId, también denominada clave de consumidor. También recibirá un secreto de cliente, también llamado secreto de consumidor. Establezca el secreto del cliente en OAuthClientSecret propiedad.

Token de Acceso de OAuth

El token de acceso para conectarse mediante OAuth.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El OAuthAccessToken la propiedad se usa para conectarse usando OAuth. El OAuthAccessToken se recupera del servidor OAuth como parte del proceso de autenticación. Tiene un tiempo de espera dependiente del servidor y se puede reutilizar entre solicitudes.

El token de acceso se utiliza en lugar de su nombre de usuario y contraseña. El token de acceso protege sus credenciales manteniéndolas en el servidor.

URL de Devolución de Llamada

La URL de devolución de llamada de OAuth a la que volver cuando se autentica. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Durante el proceso de autenticación, el servidor de autorización de OAuth redirige al usuario a esta URL. Este valor debe coincidir con la URL de devolución de llamada que especifica en la configuración de su aplicación.

Alcance

Especifique el ámbito para obtener el acceso inicial y el token de actualización.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Especifique el ámbito para obtener el acceso inicial y el token de actualización.

OAuthVerifier

El código verificador devuelto desde la URL de autorización de OAuth.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El código verificador devuelto desde la URL de autorización de OAuth. Esto se puede usar en sistemas en los que no se puede iniciar un navegador, como los sistemas sin cabeza.

Autenticación en Máquinas Sin Cabeza

Ver para obtener el OAuthVerifier valor.

Establezca OAuthSettingsLocation junto con OAuthVerifier. Cuando se conecta, el conector intercambia el OAuthVerifier para los tokens de autenticación de OAuth y los guarda, encriptados, en el archivo especificado. Establecer Iniciar OAuth a GETANDREFRESH para automatizar el intercambio.

Una vez que se haya generado el archivo de configuración de OAuth, puede eliminar OAuthVerifier desde las propiedades de conexión y conéctese con OAuthSettingsLocation colocar.

Para actualizar automáticamente los valores del token de OAuth, establezca OAuthSettingsLocation y además configure InitiateOAuth refrescar.

OAuthRefreshToken

El token de actualización de OAuth para el token de acceso de OAuth correspondiente.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El OAuthRefreshToken la propiedad se usa para actualizar el OAuthAccessToken al usar la autenticación OAuth.

OAuthExpiresIn

La vida útil en segundos del AccessToken de OAuth.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Empareje con OAuthTokenTimestamp para determinar cuándo caducará el AccessToken.

OAuthTokenTimestamp

La marca de tiempo de la época de Unix en milisegundos cuando se creó el token de acceso actual.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Emparéjese con OAuthExpiresIn para determinar cuándo expirará AccessToken.

JWT OAuth

Esta sección proporciona una lista completa de las propiedades de JWT OAuth que puede configurar.

Propiedad Descripción
OAuthJWTCert El almacén de certificados JWT.
OAuthJWTCertType El tipo de almacén de claves que contiene el certificado JWT.
OAuthJWTCertPassword La contraseña para el certificado OAuth JWT.
OAuthJWTCertSubject El asunto del certificado OAuth JWT.
OAuthJWTIssuer El emisor del token web de Java.
OAuthJWTSubject El sujeto de usuario para el que la aplicación solicita acceso delegado.

OAuthJWTCert

El almacén de certificados JWT.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El nombre del almacén de certificados para el certificado de cliente.

El OAuthJWTCertType especifica el tipo de almacén de certificados especificado por OAuthJWTCert. Si la tienda está protegida con contraseña, especifique la contraseña en OAuthJWTCertPassword.

OAuthJWTCert se usa junto con OAuthJWTCertSubject para especificar certificados de cliente. Si OAuthJWTCert tiene un valor y OAuthJWTCertSubject, se inicia una búsqueda de un certificado. Consulte OAuthJWTCertSubject campo para más detalles.

Las designaciones de los almacenes de certificados dependen de la plataforma.

Las siguientes son designaciones de los almacenes de certificados de usuario y máquina más comunes en Windows:

Propiedad Descripción
MY Un almacén de certificados que contiene certificados personales con sus claves privadas asociadas.
CA Certificados de la autoridad certificadora.
ROOT Certificados raíz.
SPC Certificados de editor de software.

En Java, el almacén de certificados normalmente es un archivo que contiene certificados y claves privadas opcionales.

Cuando el tipo de almacén de certificados es PFXFile, esta propiedad debe establecerse en el nombre del archivo. Cuando el tipo es PFXBlob, la propiedad debe establecerse en el contenido binario de un archivo PFX (es decir, almacén de certificados PKCS12).

OAuthJWTCertType

El tipo de almacén de claves que contiene el certificado JWT.

Valores Posibles

GOOGLEJSONBLOB, USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB, GOOGLEJSON

Tipo de Datos

string

Valor por Defecto

"USER"

Observaciones

Esta propiedad puede tomar uno de los siguientes valores:

Propiedad Descripción
USER Para Windows, esto especifica que el almacén de certificados es un almacén de certificados propiedad del usuario actual. Nota: Este tipo de tienda no está disponible en Java.
MACHINE Para Windows, esto especifica que el almacén de certificados es un almacén de máquinas. Nota: este tipo de tienda no está disponible en Java.
PFXFILE El almacén de certificados es el nombre de un archivo PFX (PKCS12) que contiene certificados.
PFXBLOB El almacén de certificados es una cadena (codificada en base 64) que representa un almacén de certificados en formato PFX (PKCS12).
JKSFILE El almacén de certificados es el nombre de un archivo de almacén de claves Java (JKS) que contiene certificados. Nota: este tipo de tienda solo está disponible en Java.
JKSBLOB El almacén de certificados es una cadena (codificada en base 64) que representa un almacén de certificados en formato de almacén de claves Java (JKS). Nota: este tipo de tienda solo está disponible en Java.
PEMKEY_FILE El almacén de certificados es el nombre de un archivo con codificación PEM que contiene una clave privada y un certificado opcional.
PEMKEY_BLOB El almacén de certificados es una cadena (codificada en base64) que contiene una clave privada y un certificado opcional.
PUBLIC_KEY_FILE El almacén de certificados es el nombre de un archivo que contiene un certificado de clave pública con codificación PEM o DER.
PUBLIC_KEY_BLOB El almacén de certificados es una cadena (codificada en base 64) que contiene un certificado de clave pública con codificación PEM o DER.
SSHPUBLIC_KEY_FILE El almacén de certificados es el nombre de un archivo que contiene una clave pública de estilo SSH.
SSHPUBLIC_KEY_BLOB El almacén de certificados es una cadena (codificada en base 64) que contiene una clave pública de estilo SSH.
P7BFILE El almacén de certificados es el nombre de un archivo PKCS7 que contiene certificados.
PPKFILE El almacén de certificados es el nombre de un archivo que contiene una PPK (clave privada PuTTY).
XMLFILE El almacén de certificados es el nombre de un archivo que contiene un certificado en formato XML.
XMLBLOB El almacén de certificados es una cadena que contiene un certificado en formato XML.
GOOGLEJSON El almacén de certificados es el nombre de un archivo JSON que contiene la información de la cuenta de servicio. Solo válido cuando se conecta a un servicio de Google.
GOOGLEJSONBLOB El almacén de certificados es una cadena que contiene la cuenta de servicio JSON. Solo válido cuando se conecta a un servicio de Google.

OAuthJWTCertPassword

La contraseña para el certificado OAuth JWT.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Si el almacén de certificados es de un tipo que requiere una contraseña, esta propiedad se usa para especificar esa contraseña para abrir el almacén de certificados.

Esto no es necesario cuando se usa GOOGLEJSON OAuthJWTCertType. Las claves JSON de Google no están cifradas.

OAuthJWTCertSubject

El asunto del certificado OAuth JWT.

Tipo de Datos

string

Valor por Defecto

"\*"

Observaciones

Al cargar un certificado, el asunto se utiliza para ubicar el certificado en el almacén.

Si no se encuentra una coincidencia exacta, se busca en la tienda temas que contengan el valor de la propiedad.

Si aún no se encuentra una coincidencia, la propiedad se establece en una cadena vacía y no se selecciona ningún certificado.

El valor especial "*" selecciona el primer certificado en el almacén de certificados.

El asunto del certificado es una lista separada por comas de valores y campos de nombre distinguido. Por ejemplo, "CN=www.server.com, OU=test, C=US, E=support@jitterbit.com". Los campos comunes y sus significados se muestran a continuación.

Campo Significado
CN Nombre común. Este es comúnmente un nombre de alojar como www.server.com.
O Organización
OU Unidad organizativa
L localidad
S Estado
C País
E Dirección de Correo

Si un valor de campo contiene una coma, debe estar entre comillas.

OAuthJWTIssuer

El emisor del token web de Java.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El emisor del token web de Java. Suele ser el ID del cliente o la dirección de Correo de la aplicación OAuth.

Esto no es necesario cuando se usa GOOGLEJSON OAuthJWTCertType. Las claves JSON de Google contienen una copia de la cuenta del emisor.

OAuthJWTAsunto

El sujeto de usuario para el que la aplicación solicita acceso delegado.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El sujeto de usuario para el que la aplicación solicita acceso delegado. Por lo general, el nombre de la cuenta de usuario o la dirección de correo.

SSL

Esta sección proporciona una lista completa de las propiedades SSL que puede configurar.

Propiedad Descripción
SSLServerCert El certificado que se aceptará del servidor al conectarse mediante TLS/SSL.

SSLServerCert

El certificado que se aceptará del servidor al conectarse mediante TLS/SSL.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Si usa una conexión TLS/SSL, esta propiedad se puede usar para especificar el certificado TLS/SSL que se aceptará del servidor. Se rechaza cualquier otro certificado que no sea de confianza para la máquina.

Esta propiedad puede tomar las siguientes formas:

Descripción Ejemplo
Un certificado PEM completo (ejemplo abreviado por brevedad) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
Una ruta a un archivo local que contiene el certificado C:\cert.cer
La clave pública (ejemplo abreviado por brevedad) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
La huella digital MD5 (los valores hexadecimales también pueden estar separados por espacios o dos puntos) ecadbdda5a1529c58a1e9e09828d70e4
La huella digital SHA1 (los valores hexadecimales también pueden estar separados por espacios o dos puntos) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Si no se especifica, se acepta cualquier certificado en el que confíe la máquina.

La máquina valida los certificados como confiables según el almacén de confianza del sistema. El almacén de confianza utilizado es el valor 'javax.net.ssl.trustStore' especificado para el sistema. Si no se especifica ningún valor para esta propiedad, se utiliza el almacén de confianza predeterminado de Java (por ejemplo, JAVA_HOME\lib\security\cacerts).

Use '*' para indicar que acepta todos los certificados. Tenga en cuenta que esto no se recomienda debido a problemas de seguridad.

Esquema

Esta sección proporciona una lista completa de propiedades de esquema que puede configurar.

Propiedad Descripción
Location Una ruta al directorio que contiene los archivos de esquema que definen tablas, vistas y procedimientos almacenados.
BrowsableSchemas Esta propiedad restringe los esquemas informados a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Esta propiedad restringe las tablas notificadas a un subconjunto de las tablas disponibles. Por ejemplo, Tablas=TablaA, TablaB, TablaC.
Views Restringe las vistas informadas a un subconjunto de las tablas disponibles. Por ejemplo, Vistas=VistaA, VistaB, VistaC.

Ubicación

Una ruta al directorio que contiene los archivos de esquema que definen tablas, vistas y procedimientos almacenados.

Tipo de Datos

string

Valor por Defecto

"%APPDATA%\\\GoogleDirectory Data Provider\\Schema"

Observaciones

La ruta a un directorio que contiene los archivos de esquema para el conector (archivos .rsd para tablas y vistas, archivos .rsb para procedimientos almacenados). La ubicación de la carpeta puede ser una ruta relativa desde la ubicación del ejecutable. El Location La propiedad solo es necesaria si desea personalizar las definiciones (por ejemplo, cambiar el nombre de una columna, ignorar una columna, etc.) o ampliar el modelo de datos con nuevas tablas, vistas o procedimientos almacenados.

Si no se especifica, la ubicación predeterminada es "%APPDATA%\\GoogleDirectory Data Provider\Schema" con %APPDATA% estando configurado en el directorio de configuración del usuario:

Plataforma %APPDATA%
Windows El valor de la variable de ambiente APPDATA
Mac ~/Biblioteca/Soporte de aplicaciones
Linux ~/.config

Esquemas Navegables

Esta propiedad restringe los esquemas informados a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Enumerar los esquemas de las bases de datos puede resultar costoso. Proporcionar una lista de esquemas en la cadena de conexión mejora el rendimiento.

Mesas

Esta propiedad restringe las tablas notificadas a un subconjunto de las tablas disponibles. Por ejemplo, Tablas=TablaA,TablaB,TablaC.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Listar las tablas de algunas bases de datos puede resultar costoso. Proporcionar una lista de tablas en la cadena de conexión mejora el rendimiento del conector.

Esta propiedad también se puede utilizar como una alternativa a la lista automática de vistas si ya sabe con cuáles quiere trabajar y, de lo contrario, habría demasiadas para trabajar.

Especifique las tablas que desea en una lista separada por comas. Cada tabla debe ser un identificador SQL válido con cualquier carácter especial escapado usando corchetes, comillas dobles o acentos graves. Por ejemplo, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Tenga en cuenta que al conectarse a una fuente de datos con varios esquemas o catálogos, deberá proporcionar el nombre completo de la tabla en esta propiedad, como en el último ejemplo aquí, para evitar la ambigüedad entre las tablas que existen en varios catálogos o esquemas.

Puntos de Vista

Restringe las vistas informadas a un subconjunto de las tablas disponibles. Por ejemplo, Vistas=VistaA,VistaB,VistaC.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Listar las vistas de algunas bases de datos puede ser costoso. Proporcionar una lista de vistas en la cadena de conexión mejora el rendimiento del conector.

Esta propiedad también se puede utilizar como una alternativa a la lista automática de vistas si ya sabe con cuáles quiere trabajar y, de lo contrario, habría demasiadas para trabajar.

Especifique las vistas que desee en una lista separada por comas. Cada vista debe ser un identificador SQL válido con cualquier carácter especial escapado usando corchetes, comillas dobles o acentos graves. Por ejemplo, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Tenga en cuenta que al conectarse a una fuente de datos con varios esquemas o catálogos, deberá proporcionar el nombre completo de la tabla en esta propiedad, como en el último ejemplo aquí, para evitar la ambigüedad entre las tablas que existen en varios catálogos o esquemas.

Misceláneas

Esta sección proporciona una lista completa de propiedades misceláneas que puede configurar.

Propiedad Descripción
CustomerId Restrinja los resultados de la consultar a este cliente.
Domain Restrinja las consultas a este dominio.
GroupId Restrinja los resultados de la consultar a este grupo.
MaxRows Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.
Other Estas propiedades ocultas se usan solo en casos de uso específicos.
Pagesize El número máximo de resultados que se devolverán por página desde el Google Directory.
PseudoColumns Esta propiedad indica si incluir o no pseudocolumnas como columnas en la tabla.
Timeout El valor en segundos hasta que se lanza el error de tiempo de espera, cancelando la operación.
UserDefinedViews Una ruta de archivo que apunta al archivo de configuración JSON que contiene sus vistas personalizadas.
UserId Restrinja los resultados de la consultar a este usuario.

Identificación del Cliente

Restrinja los resultados de la consultar a este cliente.

Tipo de Datos

string

Valor por Defecto

"my_customer"

Observaciones

Esta propiedad se puede establecer en la cadena de conexión o en la consultar. De lo contrario, el conector utilizará el ID de cliente del usuario autenticado. También puede obtener este valor de la tabla Usuarios.

Dominio

Restrinja las consultas a este dominio.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

El nombre de dominio (por ejemplo, cdata.com). Utilice esta propiedad de conexión para obtener resultados de un solo dominio.

Identificación del Grupo

Restrinja los resultados de la consultar a este grupo.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Esta propiedad debe establecerse en la cadena de conexión o consultar. De lo contrario, el conector utilizará el primer ID de grupo encontrado. Puede obtener este valor de la tabla Grupos.

Filas Máximas

Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.

Tipo de Datos

int

Valor por Defecto

-1

Observaciones

Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.

Otro

Estas propiedades ocultas se usan solo en casos de uso específicos.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Las propiedades enumeradas a continuación están disponibles para casos de uso específicos. Los casos de uso y la funcionalidad normales del controlador no deberían requerir estas propiedades.

Especifique varias propiedades en una lista separada por punto y coma.

Integración y Formateo
Propiedad Descripción
DefaultColumnSize Establece la longitud predeterminada de los campos de cadena cuando la fuente de datos no proporciona la longitud de columna en los metadatos. El valor predeterminado es 2000.
ConvertDateTimeToGMT Determina si se convierten los valores de fecha y hora a GMT, en lugar de la hora local de la máquina.
RecordToFile=filename Registra la transferencia de datos del socket subyacente al archivo especificado.

Tamaño de Página

El número máximo de resultados que se devolverán por página desde el Google Directory.

Tipo de Datos

int

Valor por Defecto

100

Observaciones

El Pagesize la propiedad afecta la cantidad máxima de resultados que se devolverán por página desde el Google Directory. Establecer un valor más alto puede resultar en un mejor rendimiento a costa de memoria adicional asignada por página consumida.

Pseudocolumnas

Esta propiedad indica si incluir o no pseudocolumnas como columnas en la tabla.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Esta configuración es particularmente útil en Entity Framework, que no le permite establecer un valor para una pseudocolumna a menos que sea una columna de tabla. El valor de esta configuración de conexión tiene el formato "Tabla1=Columna1, Tabla1=Columna2, Tabla2=Columna3". Puede usar el carácter "*" para incluir todas las tablas y todas las columnas; por ejemplo, "*=*".

Se Acabó el Tiempo

El valor en segundos hasta que se lanza el error de tiempo de espera, cancelando la operación.

Tipo de Datos

int

Valor por Defecto

60

Observaciones

Si Timeout = 0, las operaciones no expiran. Las operaciones se ejecutan hasta que se completan correctamente o hasta que encuentran una condición de error.

Si Timeout caduca y la operación aún no se ha completado, el conector genera una excepción.

Vistas Definidas por el Usuario

Una ruta de archivo que apunta al archivo de configuración JSON que contiene sus vistas personalizadas.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

Las vistas definidas por el usuario se definen en un archivo de configuración con formato JSON llamado UserDefinedViews.json. El conector detecta automáticamente las vistas especificadas en este archivo.

También puede tener múltiples definiciones de vista y controlarlas usando UserDefinedViews propiedad de conexión. Cuando utiliza esta propiedad, el conector solo ve las vistas especificadas.

Este archivo de configuración de vista definida por el usuario tiene el siguiente formato:

  • Cada elemento raíz define el nombre de una vista.
  • Cada elemento raíz contiene un elemento hijo, llamado query, que contiene la consultar SQL personalizada para la vista.

Por ejemplo:

{
    "MyView": {
        "query": "SELECT * FROM Group WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Utilizar el UserDefinedViews propiedad de conexión para especificar la ubicación de su archivo de configuración JSON. Por ejemplo:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

ID de Usuario

Restrinja los resultados de la consultar a este usuario.

Tipo de Datos

string

Valor por Defecto

""

Observaciones

La identificación del usuario. Si no se especifica, se utilizará el primer usuario de la tabla Usuarios.