Detalhes de Conexão do Google Directory

Introdução

Versão do conector

Esta documentação é baseada na versão 22.0.8510 do conector.

Começando

Suporte à versão do Google Directory

Estabelecendo uma Conexão

Autenticação no Google Directory

O conector oferece suporte ao uso de contas de usuário, contas de serviço e contas de instância do GCP para autenticação.

As seções a seguir discutem os esquemas de autenticação disponíveis para o Google Directory:

• Contas de usuário (OAuth)
• Conta de serviço (OAuthJWT)
• Conta de instância do GCP

Contas de Usuário (oauth)

AuthScheme deve ser definido como OAuth em todos os fluxos de conta de usuário.

Aplicativos de Área de Trabalho

fornece um aplicativo OAuth incorporado que simplifica a autenticação de área de trabalho OAuth. Como alternativa, você pode criar um aplicativo OAuth personalizado. Consulte Criando um aplicativo OAuth personalizado para obter informações sobre como criar aplicativos customizados e os motivos para fazê-lo.

Para autenticação, a única diferença entre os dois métodos é que você deve definir duas propriedades de conexão adicionais ao usar aplicativos OAuth personalizados.

Depois de definir as seguintes propriedades de conexão, você está pronto para se conectar:

• InitiateOAuth: Defina para GETANDREFRESH, que instrui o conector a tentar obter e atualizar automaticamente o token de acesso OAuth.
• OAuthClientId: (somente aplicativos personalizados) Defina isso como o ID do cliente nas configurações do aplicativo OAuth personalizado.
• OAuthClientSecret: (somente aplicativos personalizados) Defina isso como Segredo do cliente nas configurações do aplicativo OAuth personalizado.

Quando você conecta, o conector abre o endpoint OAuth em seu navegador padrão. Faça login e conceda permissões ao aplicativo. O conector conclui o processo OAuth da seguinte maneira:

• Extrai o token de acesso do URL de retorno de chamada.
• Obtém um novo token de acesso quando o antigo expira.
• Salva valores OAuth em OAuthSettingsLocation que persistem nas conexões.

Aplicativos da Web

Ao conectar por meio de um aplicativo da Web, você precisa criar e registrar um aplicativo OAuth personalizado no Google Directory. Você pode então usar o conector para adquirir e gerenciar os valores de token OAuth. Consulte Criando um aplicativo OAuth personalizado para obter mais informações sobre aplicativos personalizados.

Obtenha um token de acesso OAuth

Defina as seguintes propriedades de conexão para obter o OAuthAccessToken:

• OAuthClientId: Defina isso para o ID do cliente nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como o segredo do cliente nas configurações do aplicativo.

Em seguida, chame procedimentos armazenados* para concluir a troca OAuth:

1. Chame o GetOAuthAuthorizationURL procedimento armazenado. Defina a entrada CallbackURL para o URL de retorno especificado nas configurações do aplicativo. O procedimento armazenado* retorna a URL para o endpoint OAuth.
2. Navegue até a URL que o procedimento armazenado* retornado na Etapa 1. Efetue login no aplicativo OAuth customizado e autorize o aplicativo da web. Depois de autenticado, o navegador o redireciona para o URL de retorno de chamada.
3. Chame o GetOAuthAccessToken procedimento armazenado. Definir AuthMode como WEB e a entrada do verificador para o parâmetro "code" na string de consultar do URL de retorno de chamada.

Depois de obter os tokens de acesso e atualização, você pode se conectar aos dados e atualizar o token de acesso OAuth automática ou manualmente.

Atualização automática do token de acesso OAuth

Para que o driver atualize automaticamente o token de acesso OAuth, defina o seguinte na primeira conexão de dados:

• InitiateOAuth: Defina para REFRESH.
• OAuthClientId: Defina isso para o ID do cliente nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como Segredo do cliente nas configurações do aplicativo.
• OAuthAccessToken: Defina isso para o token de acesso retornado por GetOAuthAccessToken.
• OAuthRefreshToken: Defina isso para o token de atualização retornado por GetOAuthAccessToken.
• OAuthSettingsLocation: Defina como o caminho em que o conector salva os valores do token OAuth, que persistem nas conexões.

Nas conexões de dados subsequentes, os valores para OAuthAccessToken e OAuthRefreshToken são obtidos de OAuthSettingsLocation.

Atualização manual do token de acesso OAuth

O único valor necessário para atualizar manualmente o token de acesso OAuth ao conectar-se aos dados é o token de atualização OAuth.

Use o RefreshOAuthAccessToken procedimento armazenado* para atualizar manualmente o OAuthAccessToken após o valor do parâmetro ExpiresIn retornado por GetOAuthAccessToken tiver decorrido e, em seguida, defina as seguintes propriedades de conexão:

• OAuthClientId: Defina isso para o ID do cliente nas configurações do aplicativo.
• OAuthClientSecret: Defina isso como o segredo do cliente nas configurações do aplicativo.

Em seguida, chame RefreshOAuthAccessToken com OAuthRefreshToken definido para o token de atualização OAuth retornado por GetOAuthAccessToken. Após a recuperação dos novos tokens, abra uma nova conexão definindo a propriedade OAuthAccessToken com o valor retornado por RefreshOAuthAccessToken.

Por fim, armazene o token de atualização OAuth para que você possa usá-lo para atualizar manualmente o token de acesso OAuth depois que ele expirar.

Máquinas Sem Cabeça

Para configurar o driver para usar OAuth com uma conta de usuário em uma máquina headless, você precisa autenticar em outro dispositivo que tenha um navegador de internet.

1. Escolha uma das duas opções:
   • Opção 1: Obtenha o OAuthVerifier valor conforme descrito em "Obter e trocar um código verificador" abaixo.
   • Opção 2: instale o conector em uma máquina com um navegador da Internet e transfira os valores de autenticação OAuth após a autenticação por meio do fluxo normal baseado no navegador, conforme descrito em "Configurações de transferência OAuth" abaixo.
2. Em seguida, configure o conector para atualizar automaticamente o token de acesso na máquina sem periféricos.

Opção 1: obter e trocar um código verificador

Para obter um código verificador, você deve se autenticar no URL de autorização OAuth.

Siga as etapas abaixo para autenticar na máquina com um navegador da Internet e obter o OAuthVerifier propriedade de conexão.

1. Escolha uma destas opções:
   • Se você estiver usando o aplicativo OAuth incorporado, clique em endpoint OAuth do Google Directory para abrir o endpoint em seu navegador.

   • Se você estiver usando um aplicativo OAuth personalizado, crie a URL de autorização definindo as seguintes propriedades:

     • InitiateOAuth: Definido como OFF.
     • OAuthClientId: Defina para o ID do cliente atribuído quando você registrou seu aplicativo.
     • OAuthClientSecret: Defina o segredo do cliente atribuído quando você registrou seu aplicativo.

     Em seguida, chame o GetOAuthAuthorizationURL procedimento armazenado* com o CallbackURL apropriado. Abra a URL retornada pelo procedimento armazenado* em um navegador. 2. Efetue login e conceda permissões ao conector. Você será redirecionado para o URL de retorno de chamada, que contém o código do verificador. 3. Salve o valor do código do verificador. Mais tarde, você definirá isso no OAuthVerifier propriedade de conexão.

Em seguida, você precisa trocar o código do verificador OAuth por atualização OAuth e tokens de acesso. Defina as seguintes propriedades:

Na máquina sem periféricos, defina as seguintes propriedades de conexão para obter os valores de autenticação OAuth:

• InitiateOAuth: Defina para REFRESH.
• OAuthVerifier: Defina isso para o código do verificador.
• OAuthClientId: (somente aplicativos personalizados) Defina isso como o ID do cliente nas configurações do aplicativo OAuth personalizado.
• OAuthClientSecret: (somente aplicativos personalizados) Defina isso como Segredo do cliente nas configurações do aplicativo OAuth personalizado.
• OAuthSettingsLocation: Defina para manter os valores de autenticação OAuth criptografados no arquivo especificado.

Depois que o arquivo de configurações OAuth é gerado, você precisa redefinir as seguintes propriedades para se conectar:

• InitiateOAuth: Defina para REFRESH.
• OAuthClientId: (somente aplicativos personalizados) Defina isso para o ID do cliente atribuído quando você registrou seu aplicativo.
• OAuthClientSecret: (somente aplicativos personalizados) Defina isso como o segredo do cliente atribuído quando você registrou seu aplicativo.
• OAuthSettingsLocation: Defina isso para o arquivo que contém os valores de autenticação OAuth criptografados. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao conector para habilitar a atualização automática do token de acesso.

Opção 2: Transferir configurações de OAuth

Antes de conectar em uma máquina sem periféricos, você precisa criar e instalar uma conexão com o driver em um dispositivo compatível com um navegador da Internet. Defina as propriedades de conexão conforme descrito em "Aplicativos da área de trabalho" acima.

Depois de concluir as instruções em "Aplicativos da área de trabalho", os valores de autenticação resultantes são criptografados e gravados no caminho especificado por OAuthSettingsLocation. O nome de arquivo padrão é OAuthSettings.txt.

Depois de testar a conexão com sucesso, copie o arquivo de configurações OAuth para sua máquina sem periféricos.

Na máquina sem periféricos, defina as seguintes propriedades de conexão para se conectar aos dados:

• InitiateOAuth: Defina para REFRESH.
• OAuthClientId: (somente aplicativos personalizados) Defina isso para o ID do cliente atribuído quando você registrou seu aplicativo.
• OAuthClientSecret: (somente aplicativos personalizados) Defina isso como o segredo do cliente atribuído quando você registrou seu aplicativo.
• OAuthSettingsLocation: Defina isso como o caminho para o arquivo de configurações OAuth. Certifique-se de que este arquivo forneça permissões de leitura e gravação ao conector para habilitar a atualização automática do token de acesso.

Contas de Serviço (oauthjwt)

Para autenticar usando uma conta de serviço, você deve criar uma nova conta de serviço e ter uma cópia do certificado de contas. Se você ainda não tiver uma conta de serviço, poderá criar uma seguindo o procedimento em Criando um aplicativo OAuth personalizado.

Para um arquivo JSON, defina estas propriedades:

• AuthScheme: Defina para OAuthJWT.
• InitiateOAuth: Defina para GETANDREFRESH.
• OAuthJWTCertType: Defina para GOOGLEJSON.
• OAuthJWTCert: Defina isso como o caminho para o .json arquivo fornecido pelo Google.
• OAuthJWTSubject: (opcional) Defina este valor apenas se a conta de serviço fizer parte de um domínio GSuite e você quiser habilitar a delegação. O valor desta propriedade deve ser o endereço e-mail do usuário cujos dados você deseja acessar.

Para um arquivo PFX, defina estas propriedades:

• AuthScheme: Defina para OAuthJWT.
• InitiateOAuth: Defina para GETANDREFRESH.
• OAuthJWTCertType: Defina para PFXFILE.
• OAuthJWTCert: Defina isso como o caminho para o .pfx arquivo fornecido pelo Google.
• OAuthJWTCertPassword: (opcional) Defina isso para o .pfx senha do arquivo. Na maioria dos casos, você deve fornecer isso, pois o Google criptografa os certificados PFX.
• OAuthJWTCertSubject: (opcional) Defina isso apenas se estiver usando um OAuthJWTCertType que armazena vários certificados. Não deve ser definido para certificados PFX gerados pelo Google.
• OAuthJWTIssuer: Defina isso para o endereço e-mail da conta de serviço. Este endereço geralmente incluirá o domínio iam.gserviceaccount.com.
• OAuthJWTSubject: (opcional) Defina este valor apenas se a conta de serviço fizer parte de um domínio GSuite e você quiser habilitar a delegação. O valor desta propriedade deve ser o endereço e-mail do usuário cujos dados você deseja acessar.

Contas de Instância do GCP

Ao executar em uma máquina virtual GCP, o conector pode autenticar usando uma conta de serviço vinculada à máquina virtual. Para usar este modo, defina AuthScheme para GCPInstanceAccount.

Criando um Aplicativo OAuth Personalizado

Introdução

Você pode usar um aplicativo OAuth personalizado para autenticar uma conta de serviço ou uma conta de usuário. Você sempre pode criar um aplicativo OAuth personalizado, mas observe que as conexões de desktop e headless oferecem suporte a OAuth incorporado, o que simplifica o processo de autenticação.

Quando Criar um Aplicativo OAuth Personalizado

incorpora credenciais de aplicativos OAuth com marcas que podem ser usadas ao se conectar por meio de um aplicativo de desktop ou de uma máquina sem periféricos.

Você pode optar por usar suas próprias credenciais de aplicativo OAuth quando quiser

• marca de controle da caixa de diálogo de autenticação
• controlar o URI de redirecionamento para o qual o aplicativo redireciona o usuário após a autenticação do usuário
• personalize as permissões que você está solicitando do usuário

Ativar a API de Diretório

Siga estas etapas para habilitar a Directory API:

1. Navegue até o Console do Google Cloud.
2. Selecione Library no menu de navegação à esquerda. Isso abre o Library página.
3. No campo de pesquisa, digite "Directory API" e selecione Directory API dos resultados da pesquisa.
4. No Directory API página, clique ENABLE.

Criar um Aplicativo OAuth para Contas de Usuário (oauth)

Ao usar AuthScheme=OAuth e estiver usando um aplicativo da web, você deve criar um aplicativo OAuth Client ID. Para fluxos de desktop e headless, a criação de um aplicativo OAuth personalizado é opcional.

Siga estas etapas para criar um aplicativo OAuth personalizado:

1. Navegue até o Console do Google Cloud.
2. Crie um novo projeto ou selecione um projeto existente.
3. Selecione Credentials no menu de navegação à esquerda.
4. Crie uma tela de consentimento se ainda não houver uma configurada para o projeto selecionado clicando em CONFIGURE CONSENT SCREEN. Se você não estiver usando uma conta do Google Workspace, poderá criar uma tela de consentimento do tipo externo, que requer a especificação de um e-mail de suporte e e-mail de contato do desenvolvedor. Informações adicionais são opcionais.
5. No Credentials página, selecione Create Credentials > OAuth Client ID.
6. No Application Type menu, selecione Web application.
7. Especifique um nome para seu aplicativo da web personalizado OAuth.
8. Sob Authorized redirect URIs, clique ADD URI e insira um URI de redirecionamento. Imprensa Enter.
9. Clique em CREATE, que o leva de volta ao Credentials página.
10. Uma janela é aberta, exibindo seu ID e segredo do cliente. Embora o segredo do cliente possa ser acessado no Console do Google Cloud, recomendamos que você anote o segredo do cliente. Você precisa do segredo do cliente e do ID do cliente para especificar o OAuthClientId e OAuthClientSecret propriedades de conexão.

Criar um Aplicativo OAuth para Contas de Serviço (oauthjwt)

Você pode usar uma conta de serviço neste fluxo OAuth para acessar as APIs do Google em nome dos usuários em um domínio. Um administrador de domínio pode delegar acesso em todo o domínio à conta de serviço.

Para concluir o fluxo da conta de serviço, gere uma chave privada no Console do Google Cloud. No fluxo da conta de serviço, o driver troca um JSON Web token (JWT) pelo OAuthAccessToken. A chave privada é necessária para assinar o JWT. O driver terá as mesmas permissões concedidas à conta de serviço. Ao usar AuthScheme=OAuthJWT, você deve criar uma conta de serviço. Siga esses passos:

1. Navegue até o Console do Google Cloud.
2. Crie um novo projeto ou selecione um projeto existente.
3. Selecione Credentials no menu de navegação à esquerda.
4. Selecione Create Credentials > Service account.
5. No Create service account, insira o nome da conta de serviço, o ID da conta de serviço e, opcionalmente, uma descrição.
6. Clique em DONE. Isso o leva de volta ao Credentials página.
7. Selecione a conta de serviço recém-criada em Service Accounts seção.
8. Clique no KEYS tab > ADD KEY > Create new key.
9. Selecione qualquer tipo de chave compatível (consulte OAuthJWTCert e OAuthJWTCertType).
10. Clique em CREATE. A chave será baixada automaticamente para o seu dispositivo e todas as informações adicionais específicas da chave serão exibidas.

Características Avançadas

Esta seção detalha uma seleção de recursos avançados do conector do Google Directory.

Visualizações definidas pelo usuário

O conector permite definir tabelas virtuais, denominadas visões definidas pelo usuário, cujo conteúdo é decidido por uma consultar pré-configurada. Essas exibições são úteis quando você não pode controlar diretamente as consultas enviadas aos drivers. Consulte Visualizações definidas pelo usuário para obter uma visão geral da criação e configuração de exibições personalizadas.

Configuração SSL

Use Configuração SSL para ajustar como o conector lida com as negociações de certificado TLS/SSL. Você pode escolher entre vários formatos de certificado; Veja o SSLServerCert propriedade em "Opções de cadeia de conexão" para obter mais informações.

Procurador

Para configurar o conector usando configurações de proxy do Agente Privado, selecione os Use Proxy Settings caixa de seleção na tela de configuração da conexão.

Processamento de consulta

O conector transfere o máximo possível do processamento da instrução SELECT para o Google Directory e, em seguida, processa o restante da consultar na memória (do lado do cliente).

Consulte Processamento de consultas Para maiores informações.

Visualizações Definidas pelo Usuário

O Jitterbit Connector for Google Directory permite definir uma tabela virtual cujo conteúdo é decidido por uma consultar pré-configurada. Elas são chamadas de Visualizações Definidas pelo Usuário, que são úteis em situações onde você não pode controlar diretamente a consultar que está sendo emitida para o driver, por exemplo, ao usar o driver do Jitterbit. As Visualizações Definidas pelo Usuário podem ser usadas para definir predicados que são sempre aplicados. Se você especificar predicados adicionais na consultar para a visualização, eles serão combinados com a consultar já definida como parte da visualização.

Há duas maneiras de criar exibições definidas pelo usuário:

• Crie um arquivo de configuração em formato JSON definindo as visualizações desejadas.
• declarações DDL.

Definindo Visualizações Usando um Arquivo de Configuração

As visualizações definidas pelo usuário são definidas em um arquivo de configuração formatado em JSON chamado UserDefinedViews.json. O conector detecta automaticamente as visualizações especificadas neste arquivo.

Você também pode ter várias definições de exibição e controlá-las usando o UserDefinedViews propriedade de conexão. Quando você usa essa propriedade, apenas as exibições especificadas são vistas pelo conector.

Este arquivo de configuração de exibição definida pelo usuário é formatado da seguinte forma:

• Cada elemento raiz define o nome de uma visualização.
• Cada elemento raiz contém um elemento filho, chamado query, que contém a consultar SQL personalizada para a exibição.

Por exemplo:

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

Use o UserDefinedViews propriedade de conexão para especificar a localização do seu arquivo de configuração JSON. Por exemplo:

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

Definindo Exibições Usando Instruções DDL

O conector também é capaz de criar e alterar o esquema por meio de instruções DDL, como CREATE LOCAL VIEW, ALTER LOCAL VIEW e DROP LOCAL VIEW.

Criar uma Visualização

Para criar uma nova visualização usando instruções DDL, forneça o nome da visualização e a consultar da seguinte forma:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

Se não existir nenhum arquivo JSON, o código acima criará um. A exibição é então criada no arquivo de configuração JSON e agora pode ser descoberta. O local do arquivo JSON é especificado pelo UserDefinedViews propriedade de conexão.

Alterar uma Visualização

Para alterar uma exibição existente, forneça o nome de uma exibição existente ao lado da nova consultar que você gostaria de usar:

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

A visualização é então atualizada no arquivo de configuração JSON.

Solte uma Visualização

Para descartar uma exibição existente, forneça o nome de um esquema existente ao lado da nova consultar que você gostaria de usar.

DROP LOCAL VIEW [MyViewName]

Isso remove a visualização do arquivo de configuração JSON. Não pode mais ser consultado.

Esquema para Exibições Definidas pelo Usuário

Visualizações definidas pelo usuário são expostas no UserViews esquema por padrão. Isso é feito para evitar que o nome da exibição entre em conflito com uma entidade real no modelo de dados. Você pode alterar o nome do esquema usado para UserViews definindo o UserViewsSchemaName propriedade.

Trabalhando com Exibições Definidas pelo Usuário

Por exemplo, uma instrução SQL com uma Visualização Definida pelo Usuário chamada UserViews.RCustomers lista apenas clientes em Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Exemplo de consultar ao driver:

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

Resultando na consultar efetiva à fonte:

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

Esse é um exemplo muito simples de uma consultar a uma exibição definida pelo usuário que é efetivamente uma combinação da consultar de exibição e da definição de exibição. É possível compor essas consultas em padrões bem mais complexos. Todas as operações SQL são permitidas em ambas as consultas e são combinadas quando apropriado.

Configuração SSL

Personalizando a Configuração SSL

Por padrão, o conector tenta negociar SSL/TLS verificando o certificado do servidor em relação ao armazenamento de certificados confiáveis do sistema.

Para especificar outro certificado, consulte o SSLServerCert propriedade para os formatos disponíveis para fazê-lo.

Modelo de Dados

O Jitterbit Connector for Google Directory modela as APIs do Google Directory como tabelas relacionais, exibições e procedimentos armazenados. As limitações e requisitos da API para os objetos disponíveis estão documentados nesta seção. O conector transfere o máximo possível do processamento da instrução SELECT para as APIs do Google Directory e, em seguida, processa o restante da consultar na memória; As limitações e requisitos da API estão documentados em Tabelas e Visualizações.

Ver SupportEnhancedSQL para obter mais informações sobre como o conector contorna as limitações da API com processamento na memória do lado do cliente.

Mesas

O provedor do conector modela a API do Google Directory como relacional Tabelas.

Visualizações

Visualizações oferecem informações adicionais do Google Directory.

Procedimentos armazenados

NOTE: Procedimentos armazenados não são suportados atualmente. Veja a nota para detalhes.

Procedimentos armazenados são interfaces semelhantes a funções para a fonte de dados.

Tabelas

O conector modela os dados no Google Directory em uma lista de tabelas que podem ser consultadas usando instruções SQL padrão.

Geralmente, consultar tabelas do Google Directory é o mesmo que consultar uma tabela em um banco de dados relacional. Às vezes, há casos especiais, por exemplo, incluir uma determinada coluna na cláusula WHERE pode ser necessário para obter dados para determinadas colunas na tabela. Isso geralmente é necessário para situações em que uma solicitação separada deve ser feita para cada linha para obter determinadas colunas. Esses tipos de situações estão claramente documentados na parte superior da página da tabela vinculada abaixo.

Conector Jitterbit para Tabelas de Google Directory

Dispositivos do Chrome OS

Recupere todos os dispositivos Chrome de uma conta.

Informações Específicas da Tabela

Selecione

Para obter uma lista de todos os dispositivos Chrome de uma conta, a coluna CustomerId é necessária. Ele pode ser definido na string de conexão ou na condição da cláusula WHERE. Se não for especificado, será usado o CustomerId da conta atual. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pelas APIs do Google Directory:

SELECT * FROM ChromeOsDevices

Inserir

Inserções não são suportadas para esta tabela.

Atualizar

Atualiza as propriedades annotatedUser, annotatedLocation ou notas de um dispositivo. Para atualizar uma notificação, são necessárias as seguintes colunas: CustomerId e Id. Se não for especificado, será usado o CustomerId da conta atual.

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

Excluir

Exclusões não são suportadas para esta tabela.

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

DomainAliases

Crie, atualize e consultar aliases de um domínio.

Informações Específicas da Tabela

Selecione

Para obter uma lista de todos os aliases de um domínio, a coluna CustomerId é necessária. Ele pode ser definido na string de conexão ou na condição da cláusula WHERE. Se não for especificado, será usado o CustomerId da conta atual. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pelas APIs do Google Directory:

SELECT * FROM DomainAliases

Inserir

Para inserir um alias, são necessárias as seguintes colunas: CustomerId, ParentDomain e DomainAliasName.

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

Atualizar

As atualizações não são suportadas para esta tabela.

Excluir

Para excluir um alias, as seguintes colunas são necessárias: CustomerId e DomainAliasName.

DELETE FROM DomainAliases WHERE CustomerId='C020vaw0q' AND DomainAliasName='Alias'

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Domínios

Crie, exclua e consultar os domínios de um usuário.

Informações Específicas da Tabela

Selecione

Para obter uma lista de todos os domínios, a coluna CustomerId é necessária. Ele pode ser definido na string de conexão ou na condição da cláusula WHERE. Se não for especificado, será usado o CustomerId da conta atual, conforme a consultar a seguir. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pelas APIs do Google Directory:

SELECT * FROM Domains

Inserir

Para inserir um domínio, são necessárias as seguintes colunas: CustomerId e DomainName.

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

Atualizar

As atualizações não são suportadas para esta tabela.

Excluir

Para excluir um domínio, a coluna DomainName é necessária.

DELETE FROM Domains WHERE DomainName='exampledomain.com'

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

GroupAliases

Crie, exclua e consultar aliases para um grupo.

Informações Específicas da Tabela

Selecione

Para obter uma lista de todos os aliases de um grupo, a coluna GroupId é necessária. Se não for especificado, será usado o GroupId do primeiro grupo da tabela Groups. O conector processa outras consultas do lado do cliente na memória.

A consultar a seguir mostra o único lado do servidor processado pelo filtro pela API do Google Directory:

SELECT * FROM GroupAliases WHERE GroupId = '12345'

Inserir

Para inserir um alias, são necessárias as seguintes colunas: GroupId e Alias.

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

Atualizar

As atualizações não são suportadas para esta tabela.

Excluir

Para excluir um alias, as seguintes colunas são necessárias: GroupId e Alias.

DELETE FROM GroupAliases WHERE GroupId = '12345' AND Alias = 'Alias'

Colunas

Membros do Grupo

Crie, atualize, exclua e consultar os membros de um grupo.

Informações Específicas da Tabela

Selecione

Para obter uma lista de todos os membros de um grupo, a coluna GroupId é necessária. Se não for especificado, será usado o ID do primeiro grupo da tabela Grupos. O conector processa outras consultas do lado do cliente na memória.

A consultar a seguir mostra o único lado do servidor processado pelo filtro pela API do Google Directory:

SELECT * FROM GroupMembers WHERE GroupId = '12345'

Inserir

Para inserir um membro, são necessárias as seguintes colunas: E-mail e GroupId. A coluna Role aceita apenas os seguintes valores: MEMBER, MANAGER e OWNER.

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

Atualizar

Para atualizar um membro, as seguintes colunas são necessárias: GroupId e Id.

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

Excluir

Para excluir um membro, as seguintes colunas são necessárias: GroupId e Id.

DELETE FROM GroupMembers WHERE GroupId='1234' AND Id='12345'

Colunas

Grupos

Crie, atualize, exclua e consultar grupos.

Informações Específicas da Tabela

Selecione

Para obter uma lista de todos os grupos, o CustomerId é necessário. Você pode defini-lo na string de conexão ou na condição da cláusula WHERE. Se não for especificado, será usado o CustomerId da conta atual. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pela API do Google Directory:

SELECT * FROM Groups

Inserir

Para inserir um grupo, a coluna E-mail é obrigatória.

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

Atualizar

Para atualizar um grupo, o ID é necessário.

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

Excluir

Para excluir um grupo, a coluna ID é necessária.

DELETE FROM Groups WHERE Id='12345'

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Notificações

Atualizar, excluir e consultar notificações para um cliente.

Informações Específicas da Tabela

Selecione

Para obter uma lista de todas as notificações, a coluna CustomerId é necessária. Ele pode ser definido na string de conexão ou na condição da cláusula WHERE. Se não for especificado, será usado o CustomerId da conta atual. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pelas APIs do Google Directory:

SELECT * FROM Notifications

Inserir

Inserções não são suportadas para esta tabela.

Atualizar

Para atualizar uma notificação, são necessárias as seguintes colunas: CustomerId e Id. Se não for especificado, será usado o CustomerId da conta atual.

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

Excluir

Para excluir uma notificação, as seguintes colunas são necessárias: CustomerId e Id. Se não for especificado, será usado o CustomerId da conta atual.

DELETE FROM Notifications WHERE CustomerId = '1234' AND ID = '12345'

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Unidades Organizacionais

Crie, atualize, exclua e consultar as unidades organizacionais de um cliente.

Informações Específicas da Tabela

Selecione

Para obter uma lista de todas as unidades organizacionais, a coluna CustomerId é necessária. Ele pode ser definido na string de conexão ou na condição da cláusula WHERE. Se não for especificado, será usado o CustomerId da conta atual. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pelas APIs do Google Directory:

SELECT * FROM OrganizationUnits

Inserir

Para inserir uma unidade organizacional, são necessárias as seguintes colunas: CustomerId, Name e ParentOrgUnitId. Se não for especificado, será usado o CustomerId da conta atual.

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

Atualizar

Para atualizar uma unidade organizacional, são necessárias as seguintes colunas: CustomerId e Id. Se não for especificado, será usado o CustomerId da conta atual.

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

Excluir

Para excluir uma unidade organizacional, são necessárias as seguintes colunas: CustomerId e Id. Se não for especificado, será usado o CustomerId da conta atual.

DELETE FROM OrganizationUnits  WHERE CustomerId = '1234' AND ID = '12345'

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Atribuições de Função

Crie, exclua e consultar funções atribuídas a usuários.

Informações Específicas da Tabela

Selecione

Para obter uma lista de todas as funções atribuídas aos usuários, a coluna CustomerId é necessária. Se não for especificado, será usado o CustomerId da conta atual. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pelas APIs do Google Directory:

SELECT * FROM RoleAssignments

Inserir

Para atribuir uma papel a um usuário, as seguintes colunas são necessárias: RoleId, UserId, ScopeType e CustomerId. Se não for especificado, será usado o CustomerId da conta atual. ScopeType tem apenas dois valores aceitáveis: CUSTOMER e ORG_UNIT.

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

Atualizar

As atualizações não são suportadas para esta tabela.

Excluir

Para remover uma papel designada de um usuário, as colunas ID e CustomerId são necessárias. Se não for especificado, será usado o CustomerId da conta atual.

DELETE FROM RoleAssignments WHERE ID = '12345'

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Fichas

Consultar e excluir tokens para um usuário.

Informações Específicas da Tabela

Selecione

Para obter um conjunto atual de tokens que um usuário especificado emitiu para aplicativos de terceiros, a coluna UserId é necessária. Ele pode ser definido na string de conexão ou na condição da cláusula WHERE. Se não for especificado, será usado o ID do primeiro usuário da tabela Usuários. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pelas APIs do Google Directory:

SELECT * FROM Tokens

Inserir

Inserções não são suportadas para esta tabela.

Atualizar

As atualizações não são suportadas para esta tabela.

Excluir

Para excluir um token, as colunas UserId e ID são necessárias.

DELETE FROM Tokens WHERE UserId='12345' AND Id='123456'

Colunas

UserAliases

Lista aliases, que são endereços e-mail alternativos para um usuário.

Informações Específicas da Tabela

Selecione

Para obter uma lista de todos os aliases de um usuário, a coluna UserId é necessária. Ele pode ser definido na string de conexão ou na condição da cláusula WHERE. Caso contrário, o conector usará automaticamente o ID do primeiro usuário da tabela Usuários. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pelas APIs do Google Directory:

SELECT * FROM Aliases

Inserir

Para inserir um alias, são necessárias as seguintes colunas: UserId e Alias.

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

Atualizar

As atualizações não são suportadas para esta tabela.

Excluir

Para excluir um alias, as seguintes colunas são necessárias: UserId e Alias.

DELETE FROM Aliases WHERE ID = '12345' AND Alias = 'Alias'

Colunas

Usuários

Consultar informações do usuário.

Informações Específicas da Tabela

Selecione

Para obter uma lista de todos os usuários, o CustomerId é necessário. Você pode defini-lo na string de conexão ou na condição da cláusula WHERE. Se não for especificado, será usado o CustomerId da conta atual. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pelas APIs do Google Directory:

SELECT * FROM Users

Inserir

Para inserir um usuário, as seguintes colunas são necessárias: PrimaryEmail, FirstName, Surname e Password.

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

Atualizar

Para atualizar um usuário, a coluna ID é necessária.

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

Excluir

Para excluir usuários, a coluna ID é obrigatória.

DELETE FROM Users WHERE ID = '12345'

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Visualizações

As exibições são compostas por colunas e pseudocolunas. As exibições são semelhantes às tabelas na forma como os dados são representados; no entanto, as exibições não oferecem suporte a atualizações. Entidades que são representadas como exibições são normalmente entidades somente leitura. Frequentemente, um procedimento armazenado* está disponível para atualizar os dados se tal funcionalidade for aplicável à fonte de dados.

As consultas podem ser executadas em uma exibição como se fosse uma tabela normal, e os dados retornados são semelhantes nesse aspecto.

Visualizações dinâmicas, como consultas expostas como visualizações e visualizações para procurar combinações específicas de itens de trabalho project_team são suportadas.

Conector Jitterbit para Exibições de Google Directory

Senhas Específicas do Aplicativo

Lista todas as senhas específicas do aplicativo (senhas usadas com aplicativos que não aceitam códigos de verificação) emitidas por um usuário.

Informações Específicas da Tabela

Selecione

Para obter uma lista de todos os tokens específicos do aplicativo emitidos por um usuário, a coluna UserId é necessária. Ele pode ser definido na string de conexão ou na condição da cláusula WHERE. Se não for especificado, será usado o ID do primeiro usuário da tabela Usuários. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pela API do Google Directory:

SELECT * FROM AppSpecificPasswords

Colunas

Dispositivos Móveis

Lista os dispositivos móveis de uma conta.

Informações Específicas da Tabela

Selecione

Para obter uma lista de todos os dispositivos móveis de uma conta, a coluna CustomerId é necessária. Ele pode ser definido na string de conexão ou na condição da cláusula WHERE. Se não for especificado, será usado o CustomerId da conta atual. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pelas APIs do Google Directory:

SELECT * FROM MobileDevices

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Privilégios

Lista todos os Privilégios.

Informações Específicas da Tabela

Selecione

Para obter uma lista de todos os privilégios de uma conta, a coluna CustomerId é obrigatória. Ele pode ser definido na string de conexão ou na condição da cláusula WHERE. Se não for especificado, será usado o CustomerId da conta atual. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pelas APIs do Google Directory:

SELECT * FROM Privileges

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Funções

Lista funções em um domínio.

Informações Específicas da Tabela

Selecione

Para obter uma lista de todas as funções, a coluna CustomerId é necessária. Ele pode ser definido na string de conexão ou na condição da cláusula WHERE. Se não for especificado, será usado o CustomerId da conta atual. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pelas APIs do Google Directory:

SELECT * FROM Roles

Colunas

Pseudo-colunas

Os campos de pseudocoluna são usados na cláusula WHERE das instruções SELECT e oferecem um controle mais granular sobre as tuplas que são retornadas da fonte de dados.

Endereços de Usuário

Lista os endereços de um usuário.

Informações Específicas da Tabela

Selecione

Para obter uma lista de endereços de um usuário, a coluna UserId é necessária. Ele pode ser definido na string de conexão ou na condição da cláusula WHERE. Caso contrário, o conector usará automaticamente o UserId do primeiro usuário da tabela Users. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pelas APIs do Google Directory:

SELECT * FROM UserAddresses

Colunas

E-mails do Usuário

Consulte os e-mails de um usuário.

Informações Específicas da Tabela

Selecione

Para obter uma lista de endereços e-mail de um usuário, a coluna UserId é necessária. Ele pode ser definido na string de conexão ou na condição da cláusula WHERE. Caso contrário, o conector usará automaticamente o ID do primeiro usuário da tabela Usuários. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pelas APIs do Google Directory:

SELECT * FROM UserEmails

Colunas

UserInstantMessagingAccounts

Consulte as contas de mensagens instantâneas de um usuário.

Informações Específicas da Tabela

Selecione

Para obter uma lista de contas de mensagens instantâneas de um usuário, a coluna UserId é necessária. Ele pode ser definido na string de conexão ou na condição da cláusula WHERE. Caso contrário, o conector usará automaticamente o ID do primeiro usuário da tabela Usuários. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pelas APIs do Google Directory:

SELECT * FROM UserInstantMessagingAccounts

Colunas

Locais do Usuário

Consulte os locais de um usuário.

Informações Específicas da Tabela

Selecione

Para obter uma lista de locais de um usuário, a coluna UserId é necessária. Ele pode ser definido na string de conexão ou na condição da cláusula WHERE. Caso contrário, o conector usará automaticamente o ID do primeiro usuário da tabela Usuários. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pelas APIs do Google Directory:

SELECT * FROM UserLocations

Colunas

Organizações de Usuários

Consulte as organizações para um usuário.

Informações Específicas da Tabela

Selecione

Para obter uma lista de organizações para um usuário, a coluna UserId é obrigatória. Ele pode ser definido na string de conexão ou na condição da cláusula WHERE. Caso contrário, o conector usará automaticamente o ID do primeiro usuário da tabela Usuários. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pelas APIs do Google Directory:

SELECT * FROM UserOrganizations

Colunas

Telefones de Usuário

Consulte os números de telefone de um usuário.

Informações Específicas da Tabela

Selecione

Para obter uma lista de telefones de um usuário, a coluna UserId é necessária. Ele pode ser definido na string de conexão ou na condição da cláusula WHERE. Caso contrário, o conector usará automaticamente o ID do primeiro usuário da tabela Usuários. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pelas APIs do Google Directory:

SELECT * FROM UserPhones

Colunas

Sites do Usuário

Recupere uma lista dos sites de um usuário.

Informações Específicas da Tabela

Selecione

Para obter uma lista de sites de um usuário, a coluna UserId é obrigatória. Ele pode ser definido na string de conexão ou na condição da cláusula WHERE. Caso contrário, o conector usará automaticamente o ID do primeiro usuário da tabela Usuários. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pelas APIs do Google Directory:

SELECT * FROM UserWebsites

Colunas

Códigos de Verificação

Consultar códigos de verificação para um usuário.

Informações Específicas da Tabela

Selecione

Para obter um conjunto atual de códigos de verificação de backup válidos para um usuário especificado, a coluna UserId é necessária. Ele pode ser definido na string de conexão ou na condição da cláusula WHERE. Se não for especificado, será usado o ID do primeiro usuário da tabela Usuários. O conector processa outras consultas do lado do cliente na memória.

Por exemplo, a consultar a seguir é processada no lado do servidor pelas APIs do Google Directory:

SELECT * FROM VerificationCodes

Colunas

Procedimentos Armazenados

Procedimentos armazenados* são interfaces semelhantes a funções que estendem a funcionalidade do conector além das simples operações SELECT/INSERT/UPDATE/DELETE com o Google Directory.

Procedimentos armazenados* aceitar uma lista de parâmetros, executar a função pretendida e, em seguida, retornar, se aplicável, quaisquer dados de resposta relevantes do Google Directory, junto com uma indicação de se o procedimento foi bem-sucedido ou falhou.

Conector Jitterbit para Procedimentos Armazenados do Google Directory

AlterarAdminStatus

Altere o status de administrador de um usuário.

Entrada

Gerar Códigos de Verificação

Gere códigos de verificação para um usuário.

Entrada

GetOAuthAccessToken

Obtém o token de acesso OAuth para ser usado para autenticação com vários serviços do Google. NOTE: Se, após executar este procedimento armazenado, o OAuthRefreshToken não foi retornado como parte do conjunto de resultados, altere o valor do Prompt para CONSENT e execute o procedimento novamente. Isso força o aplicativo a autenticar novamente e enviar novas informações de token.

Entrada

Colunas do Conjunto de Resultados

GetOAuthAuthorizationURL

Obtém o URL de autorização OAuth usado para autenticação com vários serviços do Google.

Entrada

Colunas do Conjunto de Resultados

InvalidateVerificationCodes

Invalidar códigos de verificação para um usuário.

Entrada

RefreshOAuthAccessToken

Obtém o token de acesso OAuth para ser usado para autenticação com vários serviços do Google.

Entrada

Colunas do Conjunto de Resultados

Tabelas do Sistema

Você pode consultar as tabelas do sistema descritas nesta seção para acessar informações de esquema, informações sobre a funcionalidade da fonte de dados e estatísticas de operação em lote.

Tabelas de Esquema

As tabelas a seguir retornam metadados do banco de dados para o Google Directory:

• sys_catalogs: Lista os bancos de dados disponíveis.
• sys_schemas: Lista os esquemas disponíveis.
• sys_tables: Lista as tabelas e exibições disponíveis.
• sys_tablecolumns: Descreve as colunas das tabelas e exibições disponíveis.
• sys_procedures: Descreve os procedimentos armazenados disponíveis.
• sys_procedureparameters: Descreve procedimento armazenado* parâmetros.
• sys_keycolumns: Descreve as chaves primárias e estrangeiras.
• sys_indexes: Descreve os índices disponíveis.

Tabelas de Fonte de Dados

As tabelas a seguir retornam informações sobre como se conectar e consultar a fonte de dados:

• sys_connection_props: Retorna informações sobre as propriedades de conexão disponíveis.
• sys_sqlinfo: Descreve as consultas SELECT que o conector pode descarregar para a fonte de dados.

Consultar Tabelas de Informações

A tabela a seguir retorna estatísticas de consultar para consultas de modificação de dados:

• sys_identity: Retorna informações sobre operações em lote ou atualizações únicas.

Sys_catalogs

Lista os bancos de dados disponíveis.

A consultar a seguir recupera todos os bancos de dados determinados pela string de conexão:

SELECT * FROM sys_catalogs

Colunas

Sys_schemas

Lista os esquemas disponíveis.

A consultar a seguir recupera todos os esquemas disponíveis:

SELECT * FROM sys_schemas

Colunas

Sys_tables

Lista as tabelas disponíveis.

A consultar a seguir recupera as tabelas e exibições disponíveis:

SELECT * FROM sys_tables

Colunas

Sys_tablecolumns

Descreve as colunas das tabelas e exibições disponíveis.

A consultar a seguir retorna as colunas e os tipos de dados da tabela Group:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Group' 

Colunas

Sys_procedures

Lista os procedimentos armazenados disponíveis.

A consultar a seguir recupera os procedimentos armazenados disponíveis:

SELECT * FROM sys_procedures

Colunas

Sys_procedureparameters

Descreve procedimento armazenado* parâmetros.

A consultar a seguir retorna informações sobre todos os parâmetros de entrada para o procedimento armazenado RefreshOAuthAccessToken:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='RefreshOAuthAccessToken' AND Direction=1 OR Direction=2

Colunas

Sys_keycolumns

Descreve as chaves primárias e estrangeiras. A consultar a seguir recupera a chave primária da tabela Group:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Group'

Colunas

Sys_foreignkeys

Descreve as chaves estrangeiras. A consultar a seguir recupera todas as chaves estrangeiras que se referem a outras tabelas:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Colunas

Sys_primarykeys

Descreve as chaves primárias. A consultar a seguir recupera as chaves primárias de todas as tabelas e exibições:

SELECT * FROM sys_primarykeys

Colunas

Sys_indexes

Descreve os índices disponíveis. Ao filtrar por índices, você pode escrever consultas mais seletivas com tempos de resposta de consultar mais rápidos.

A consultar a seguir recupera todos os índices que não são chaves primárias:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Colunas

Sys_connection_props

Retorna informações sobre as propriedades de conexão disponíveis e as definidas na string de conexão.

Ao consultar esta tabela, a string de conexão de configuração deve ser usada:

jdbc:cdata:googledirectory:config:

Esta string de conexão permite que você consultar esta tabela sem uma conexão válida.

A consultar a seguir recupera todas as propriedades de conexão que foram definidas na string de conexão ou definidas por meio de um valor padrão:

SELECT * FROM sys_connection_props WHERE Value <> ''

Colunas

Sys_sqlinfo

Descreve o processamento da consultar SELECT que o conector pode transferir para a fonte de dados.

Descobrindo os Recursos SELECT da Fonte de Dados

Abaixo está um exemplo de conjunto de dados de recursos SQL. O conjunto de resultados a seguir indica a funcionalidade SELECT que o conector pode descarregar para a fonte de dados ou processar o lado do cliente. Sua fonte de dados pode suportar sintaxe SQL adicional. Alguns aspectos da funcionalidade SELECT são retornados em uma lista separada por vírgulas, se suportados; caso contrário, a coluna contém NO.

A consultar a seguir recupera os operadores que podem ser usados na cláusula WHERE:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Observe que tabelas individuais podem ter diferentes limitações ou requisitos na cláusula WHERE; consulte o Modelo de Dados para obter mais informações.

Colunas

Sys_identity

Retorna informações sobre tentativas de modificação.

A consultar a seguir recupera os IDs das linhas modificadas em uma operação em lote:

SELECT * FROM sys_identity

Colunas

Propriedades de Configurações Avançadas

As propriedades de configurações avançadas são as várias opções que podem ser usadas para estabelecer uma conexão. Esta seção fornece uma lista completa das opções que você pode configurar. Clique nos links para mais detalhes.

Autenticação

OAuth

JWT OAuth

SSL

Esquema

Diversos

Autenticação

Esta seção fornece uma lista completa de propriedades de autenticação que você pode configurar.

AuthScheme

O tipo de autenticação a ser usado ao se conectar ao Google Directory.

Valores Possíveis

Auto, OAuth, OAuthJWT, GCPInstanceAccount

Tipo de Dados

string

Valor Padrão

"Auto"

Observações

• Auto: permite que o driver decida automaticamente com base nas outras propriedades de conexão que você definiu.
• OAuth: Defina para executar a autenticação OAuth usando uma conta de usuário padrão.
• OAuthJWT: defina para executar a autenticação OAuth usando uma conta de serviço OAuth.
• GCPInstanceAccount: defina para obter o token de acesso da instância do Google Cloud Platform.

OAuth

Esta seção fornece uma lista completa de propriedades OAuth que você pode configurar.

InitiateOAuth

Configure esta propriedade para iniciar o processo para obter ou atualizar o token de acesso OAuth ao se conectar.

Valores Possíveis

OFF, GETANDREFRESH, REFRESH

Tipo de Dados

string

Valor Padrão

"OFF"

Observações

As seguintes opções estão disponíveis:

1. OFF: Indica que o fluxo OAuth será tratado inteiramente pelo usuário. Um OAuthAccessToken será necessário para autenticação.
2. GETANDREFRESH: Indica que todo o fluxo OAuth será tratado pelo conector. Se nenhum token existir atualmente, ele será obtido solicitando ao usuário por meio do navegador. Se existir um token, ele será atualizado quando aplicável.
3. REFRESH: Indica que o conector tratará apenas da atualização do OAuthAccessToken. O usuário nunca será solicitado pelo conector a autenticar por meio do navegador. O usuário deve manipular a obtenção do OAuthAccessToken e OAuthRefreshToken inicialmente.

OAuthClientId

O ID do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

Como parte do registro de um aplicativo OAuth, você receberá o OAuthClientId valor, às vezes também chamado de chave do consumidor, e um segredo do cliente, o OAuthClientSecret.

OAuthClientSecret

O segredo do cliente atribuído quando você registra seu aplicativo com um servidor de autorização OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

Como parte do registro de um aplicativo OAuth, você receberá o OAuthClientId, também chamada de chave do consumidor. Você também receberá um segredo do cliente, também chamado de segredo do consumidor. Defina o segredo do cliente no OAuthClientSecret propriedade.

OAuthAccessToken

O token de acesso para conexão usando OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

O OAuthAccessToken propriedade é usada para conectar usando OAuth. O OAuthAccessToken é recuperado do servidor OAuth como parte do processo de autenticação. Ele tem um tempo limite dependente do servidor e pode ser reutilizado entre as solicitações.

O token de acesso é usado no lugar do seu nome de usuário e senha. O token de acesso protege suas credenciais, mantendo-as no servidor.

URL de Retorno

O URL de retorno de chamada OAuth ao qual retornar durante a autenticação. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.

Tipo de Dados

string

Valor Padrão

""

Observações

Durante o processo de autenticação, o servidor de autorização OAuth redireciona o usuário para esta URL. Esse valor deve corresponder ao URL de retorno especificado nas configurações do aplicativo.

Escopo

Especifique o escopo para obter o acesso inicial e o token de atualização.

Tipo de Dados

string

Valor Padrão

""

Observações

Especifique o escopo para obter o acesso inicial e o token de atualização.

OAuthVerifier

O código do verificador retornado da URL de autorização OAuth.

Tipo de Dados

string

Valor Padrão

""

Observações

O código do verificador retornado da URL de autorização OAuth. Isso pode ser usado em sistemas em que um navegador não pode ser iniciado, como sistemas headless.

Autenticação em Máquinas Sem Cabeça

Consulte para obter o OAuthVerifier valor.

Defina OAuthSettingsLocation juntamente com OAuthVerifier. Quando você conecta, o conector troca o OAuthVerifier para os tokens de autenticação OAuth e os salva, criptografados, no arquivo especificado. Definir InitiateOAuth para GETANDREFRESH para automatizar a troca.

Depois que o arquivo de configurações OAuth for gerado, você poderá remover OAuthVerifier nas propriedades de conexão e conecte-se com OAuthSettingsLocation definir.

Para atualizar automaticamente os valores do token OAuth, defina OAuthSettingsLocation e adicionalmente defina InitiateOAuth para ATUALIZAR.

OAuthRefreshToken

O token de atualização OAuth para o token de acesso OAuth correspondente.

Tipo de Dados

string

Valor Padrão

""

Observações

O OAuthRefreshToken a propriedade é usada para atualizar o OAuthAccessToken ao usar a autenticação OAuth.

OAuthExpiresIn

O tempo de vida em segundos do OAuth AccessToken.

Tipo de Dados

string

Valor Padrão

""

Observações

Emparelhe com OAuthTokenTimestamp para determinar quando o AccessToken expirará.

OAuthTokenTimestamp

O registro de data e hora da época do Unix em milissegundos quando o token de acesso atual foi criado.

Tipo de Dados

string

Valor Padrão

""

Observações

Emparelhe com OAuthExpiresIn para determinar quando o AccessToken expirará.

JWT OAuth

Esta seção fornece uma lista completa das propriedades JWT OAuth que você pode configurar.

OAuthJWTCert

A loja de certificados JWT.

Tipo de Dados

string

Valor Padrão

""

Observações

O nome do armazenamento de certificados para o certificado do cliente.

O OAuthJWTCertType campo especifica o tipo de armazenamento de certificado especificado por OAuthJWTCert. Se o armazenamento estiver protegido por senha, especifique a senha em OAuthJWTCertPassword.

OAuthJWTCert é usado em conjunto com o OAuthJWTCertSubject para especificar os certificados do cliente. Se OAuthJWTCert tem um valor e OAuthJWTCertSubject for definido, uma pesquisa por um certificado será iniciada. Consulte OAuthJWTCertSubject para obter detalhes.

As designações de armazenamentos de certificados dependem da plataforma.

A seguir estão as designações dos armazenamentos de certificados de Usuário e Máquina mais comuns no Windows:

Em Java, o armazenamento de certificados normalmente é um arquivo contendo certificados e chaves privadas opcionais.

Quando o tipo de armazenamento de certificado for PFXFile, essa propriedade deverá ser configurada para o nome do arquivo. Quando o tipo é PFXBlob, a propriedade deve ser configurada para o conteúdo binário de um arquivo PFX (ou seja, armazenamento de certificados PKCS12).

OAuthJWTCertType

O tipo de armazenamento de chaves que contém o certificado JWT.

Valores Possíveis

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 Dados

string

Valor Padrão

"USER"

Observações

Esta propriedade pode assumir um dos seguintes valores:

OAuthJWTCertPassword

A senha para o certificado OAuth JWT.

Tipo de Dados

string

Valor Padrão

""

Observações

Se o armazenamento de certificados for de um tipo que requer uma senha, essa propriedade será usada para especificar essa senha para abrir o armazenamento de certificados.

Isso não é necessário ao usar o GOOGLEJSON OAuthJWTCertType. As chaves JSON do Google não são criptografadas.

OAuthJWTCertSubject

O assunto do certificado OAuth JWT.

Tipo de Dados

string

Valor Padrão

"\*"

Observações

Ao carregar um certificado, o assunto é usado para localizar o certificado na loja.

Se uma correspondência exata não for encontrada, a loja é pesquisada em busca de assuntos que contenham o valor da propriedade.

Se uma correspondência ainda não for encontrada, a propriedade será definida como uma string vazia e nenhum certificado será selecionado.

O valor especial "*" seleciona o primeiro certificado no armazenamento de certificados.

O assunto do certificado é uma lista separada por vírgulas de campos e valores de nomes distintos. Por exemplo, "CN=www.server.com, OU=test, C=US, E=support@jitterbit.com". Os campos comuns e seus significados são exibidos abaixo.

Se um valor de campo contiver uma vírgula, ela deverá ser colocada entre aspas.

OAuthJWTIssuer

O emissor do Java Web Token.

Tipo de Dados

string

Valor Padrão

""

Observações

O emissor do Java Web Token. Normalmente, é o ID do cliente ou o endereço E-mail do aplicativo OAuth.

Isso não é necessário ao usar o GOOGLEJSON OAuthJWTCertType. As chaves JSON do Google contêm uma cópia da conta do emissor.

OAuthJWTSubject

O assunto do usuário para o qual o aplicativo está solicitando acesso delegado.

Tipo de Dados

string

Valor Padrão

""

Observações

O assunto do usuário para o qual o aplicativo está solicitando acesso delegado. Normalmente, o nome da conta do usuário ou endereço e-mail.

SSL

Esta seção fornece uma lista completa de propriedades SSL que você pode configurar.

SSLServerCert

O certificado a ser aceito do servidor ao conectar usando TLS/SSL.

Tipo de Dados

string

Valor Padrão

""

Observações

Se estiver usando uma conexão TLS/SSL, esta propriedade pode ser usada para especificar o certificado TLS/SSL a ser aceito do servidor. Qualquer outro certificado que não seja confiável para a máquina é rejeitado.

Esta propriedade pode assumir as seguintes formas:

Se não for especificado, qualquer certificado confiável pela máquina será aceito.

Os certificados são validados como confiáveis pela máquina com base no armazenamento confiável do sistema. O armazenamento confiável usado é o valor 'javax.net.ssl.trustStore' especificado para o sistema. Se nenhum valor for especificado para esta propriedade, o armazenamento confiável padrão do Java será usado (por exemplo, JAVA_HOME\lib\security\cacerts).

Use '*' para indicar a aceitação de todos os certificados. Observe que isso não é recomendado devido a questões de segurança.

Esquema

Esta seção fornece uma lista completa de propriedades de esquema que você pode configurar.

Localização

Um caminho para o diretório que contém os arquivos de esquema que definem tabelas, exibições e procedimentos armazenados.

Tipo de Dados

string

Valor Padrão

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

Observações

O caminho para um diretório que contém os arquivos de esquema para o conector (arquivos .rsd para tabelas e exibições, arquivos .rsb para procedimentos armazenados). A localização da pasta pode ser um caminho relativo a partir da localização do executável. O Location a propriedade só é necessária se você quiser personalizar definições (por exemplo, alterar um nome de coluna, ignorar uma coluna e assim por diante) ou estender o modelo de dados com novas tabelas, exibições ou procedimentos armazenados.

Se não for especificado, o local padrão é "%APPDATA%\\GoogleDirectory Data Provider\Schema" com %APPDATA% sendo definido para o diretório de configuração do usuário:

Esquemas Navegáveis

Essa propriedade restringe os esquemas relatados a um subconjunto dos esquemas disponíveis. Por exemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Tipo de Dados

string

Valor Padrão

""

Observações

Listar os esquemas de bancos de dados pode ser caro. Fornecer uma lista de esquemas na string de conexão melhora o desempenho.

Tabelas

Esta propriedade restringe as tabelas reportadas a um subconjunto das tabelas disponíveis. Por exemplo, Tabelas=TabelaA,TabelaB,TabelaC.

Tipo de Dados

string

Valor Padrão

""

Observações

Listar as tabelas de alguns bancos de dados pode ser caro. Fornecer uma lista de tabelas na string de conexão melhora o desempenho do conector.

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitas para trabalhar.

Especifique as tabelas que deseja em uma lista separada por vírgulas. Cada tabela deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.

Visualizações

Restringe as visualizações relatadas a um subconjunto das tabelas disponíveis. Por exemplo, Views=ViewA,ViewB,ViewC.

Tipo de Dados

string

Valor Padrão

""

Observações

Listar as exibições de alguns bancos de dados pode ser caro. Fornecer uma lista de exibições na string de conexão melhora o desempenho do conector.

Essa propriedade também pode ser usada como uma alternativa para listar automaticamente as exibições se você já souber com quais deseja trabalhar e, caso contrário, haveria muitos para trabalhar.

Especifique as exibições desejadas em uma lista separada por vírgulas. Cada exibição deve ser um identificador SQL válido com quaisquer caracteres especiais escapados usando colchetes, aspas duplas ou acentos graves. Por exemplo, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Observe que, ao conectar-se a uma fonte de dados com vários esquemas ou catálogos, você precisará fornecer o nome totalmente qualificado da tabela nesta propriedade, como no último exemplo aqui, para evitar ambigüidade entre tabelas que existem em vários catálogos ou esquemas.

Diversos

Esta seção fornece uma lista completa de diversas propriedades que você pode configurar.

Identificação do Cliente

Restrinja os resultados da consultar a este cliente.

Tipo de Dados

string

Valor Padrão

"my_customer"

Observações

Essa propriedade pode ser definida na string de conexão ou na consultar. Caso contrário, o conector usará a ID do cliente do usuário autenticado. Você também pode obter esse valor na tabela Usuários.

Domínio

Restrinja as consultas a este domínio.

Tipo de Dados

string

Valor Padrão

""

Observações

O nome de domínio (por exemplo, cdata.com). Use esta propriedade de conexão para obter resultados de apenas um domínio.

GroupId

Restrinja os resultados da consultar a este grupo.

Tipo de Dados

string

Valor Padrão

""

Observações

Essa propriedade deve ser definida na string de conexão ou consultar. Caso contrário, o conector usará o primeiro ID de grupo encontrado. Você pode obter esse valor na tabela Grupos.

MaxRows

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Tipo de Dados

int

Valor Padrão

-1

Observações

Limita o número de linhas retornadas quando nenhuma agregação ou agrupamento é usado na consultar. Isso ajuda a evitar problemas de desempenho em tempo de design.

Outro

Essas propriedades ocultas são usadas apenas em casos de uso específicos.

Tipo de Dados

string

Valor Padrão

""

Observações

As propriedades listadas abaixo estão disponíveis para casos de uso específicos. Os casos de uso e a funcionalidade normais do driver não devem exigir essas propriedades.

Especifique várias propriedades em uma lista separada por ponto e vírgula.

Integração e Formatação

Tamanho da Página

O número máximo de resultados a serem retornados por página do Google Directory.

Tipo de Dados

int

Valor Padrão

100

Observações

O Pagesize a propriedade afeta o número máximo de resultados a serem retornados por página do Google Directory. Definir um valor mais alto pode resultar em melhor desempenho ao custo de memória adicional alocada por página consumida.

Pseudocolunas

Esta propriedade indica se deve ou não incluir pseudocolunas como colunas na tabela.

Tipo de Dados

string

Valor Padrão

""

Observações

Essa configuração é particularmente útil no Entity Framework, que não permite definir um valor para uma pseudocoluna, a menos que seja uma coluna de tabela. O valor dessa configuração de conexão está no formato "Table1=Column1, Table1=Column2, Table2=Column3". Você pode usar o caractere "*" para incluir todas as tabelas e todas as colunas; por exemplo, "*=*".

Tempo Esgotado

O valor em segundos até que o erro de timeout seja lançado, cancelando a operação.

Tipo de Dados

int

Valor Padrão

60

Observações

Se Timeout = 0, as operações não expiram. As operações são executadas até serem concluídas com êxito ou até encontrarem uma condição de erro.

Se Timeout expira e a operação ainda não está concluída, o conector lança uma exceção.

Visualizações Definidas pelo Usuário

Um caminho de arquivo apontando para o arquivo de configuração JSON que contém suas exibições personalizadas.

Tipo de Dados

string

Valor Padrão

""

Observações

As visualizações definidas pelo usuário são definidas em um arquivo de configuração formatado em JSON chamado UserDefinedViews.json. O conector detecta automaticamente as visualizações especificadas neste arquivo.

Você também pode ter várias definições de exibição e controlá-las usando o UserDefinedViews propriedade de conexão. Quando você usa essa propriedade, apenas as exibições especificadas são vistas pelo conector.

Este arquivo de configuração de exibição definida pelo usuário é formatado da seguinte forma:

• Cada elemento raiz define o nome de uma exibição.
• Cada elemento raiz contém um elemento filho, chamado query, que contém a consultar SQL personalizada para a visualização.

Por exemplo:

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

Use o UserDefinedViews propriedade de conexão para especificar a localização do seu arquivo de configuração JSON. Por exemplo:

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

ID do Usuário

Restrinja os resultados da consultar a este usuário.

Tipo de Dados

string

Valor Padrão

""

Observações

O ID do usuário. Se não for especificado, será usado o primeiro usuário da tabela Usuários.