LDAP

O conector LDAP permite configurar um servidor LDAP genérico.

Versões compatíveis

Esse conector é compatível com as versões 2 e 3 do LDAP.

Antes de começar

Antes de usar o conector LDAP, faça o seguinte:

  • No seu projeto do Google Cloud, faça o seguinte:
    • Conceda a função IAM roles/connectors.admin ao usuário que está configurando o conector.
    • Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.

    • Ative os seguintes serviços:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Para entender como ativar os serviços, consulte Como ativar serviços.

    Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:

  1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

    Acessar a página "Conexões"

  2. Clique em + CRIAR NOVO para abrir a página Criar conexão.
  3. Na seção Local, escolha o local da conexão.
    1. Região: selecione um local na lista suspensa.

      Para conferir a lista de todas as regiões com suporte, consulte Locais.

    2. Clique em PRÓXIMA.
  4. Na seção Detalhes da conexão, faça o seguinte:
    1. Conector: selecione LDAP na lista suspensa de conectores disponíveis.
    2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
    3. No campo Nome da conexão, insira um nome para a instância de conexão

      Os nomes de conexão precisam atender aos seguintes critérios:

      • Os nomes de conexões podem usar letras, números ou hifens.
      • As letras precisam ser minúsculas.
      • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das conexões não podem ter mais de 49 caracteres.
    4. Como opção, insira uma Descrição para a instância de conexão.
    5. Se quiser, ative o Cloud Logging. e selecione um nível de registro. Por padrão, o nível de registro é definido como Error.
    6. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
    7. Opcionalmente, defina as Configurações do nó de conexão:

      • Número mínimo de nós: digite o número mínimo de nós de conexão.
      • Número máximo de nós: digite o número máximo de nós de conexão.

      Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

    8. DN de base: a parte base do nome distinto, usada para limitar os resultados a subárvores específicas.
    9. Mecanismo de autenticação: o mecanismo de autenticação a ser usado na conexão com o servidor LDAP.
    10. Seguir indicações: segue ou não as referências LDAP retornadas pelo servidor LDAP.
    11. GUID compatível: se você quer retornar valores de atributo GUID em um formato legível.
    12. SID compatível: se serão retornados os valores do atributo SID em um formato legível.
    13. Versão do LDAP: a versão do LDAP usada para se conectar e se comunicar com o servidor.
    14. Escopo: se você quer limitar o escopo da pesquisa à subárvore inteira (BaseDN e todos os descendentes), um único nível (BaseDN e seus descendentes diretos) ou o objeto base (apenas BaseDN).
    15. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
    16. Clique em PRÓXIMA.
  5. Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
    1. Tipo de destino: selecione um Tipo de destino.
      • Selecione Endereço do host na lista para especificar o nome do host ou o endereço IP do destino.
      • Para estabelecer uma conexão particular com seus sistemas de back-end, Selecione Anexo de endpoint na lista e depois selecione o anexo de endpoint necessário. na lista Endpoint Attachment.

      Para estabelecer uma conexão pública com os sistemas de back-end com mais segurança, considere configurar endereços IP de saída estáticos para suas conexões e configure as regras de firewall para autorizar apenas os endereços IP estáticos específicos.

      Para inserir outros destinos, clique em +ADICIONAR DESTINO.

    2. Clique em PRÓXIMA.
  6. Na seção Autenticação, insira os detalhes da autenticação.
    1. Selecione um Tipo de autenticação e insira os detalhes relevantes.

      Os seguintes tipos de autenticação são compatíveis com a conexão do LDAP:

      • Nome de usuário e senha

      2. Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

    2. Clique em PRÓXIMA.
  7. Revisão: revise os detalhes de conexão e autenticação.
  8. Clique em Criar.

Configurar a autenticação

Digite os detalhes com base na autenticação que você quer usar.

  • Nome de usuário e senha
    • Nome de usuário: nome de usuário para o conector
    • Senha: a senha do Secret Manager que contém a senha associada ao conector.

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

  • Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

    No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.

  • Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:

    Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações de entidade, essas operações sem suporte não serão listadas na lista Operations.

  • Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada, . No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Ações

Esta seção lista todas as ações aceitas pelo conector LDAP.

Ação MoveToDN

Essa ação move objetos de um DN (nome distinto) para outro.

Parâmetros de entrada da ação MoveToDN

Nome do parâmetro Tipo de dados Obrigatório Descrição
DN String Sim O DN atual do objeto a ser movido no servidor LDAP. Por exemplo, CN=Google Cloud,OU=Bangalore,OU=India,OU=Domain_Users,DC=test-ldap,DC=com
NewParentDN String Sim O novo DN pai do objeto. Por exemplo, OU=Mysore,OU=India,OU=Domain_Users,DC=test-ldap,DC=com

Parâmetros de saída da ação DownloadFile

Essa ação retorna o status 200 (OK) com um corpo de resposta indicando os resultados.

Para entender como configurar a ação MoveToDN, consulte Exemplos de ação.

Ação GetAttributes

Essa ação recebe todos os nomes e valores de atributo de um DN.

Parâmetros de entrada da ação GetAttributes

Nome do parâmetro Tipo de dados Obrigatório Descrição
DN String Sim Nome distinto do objeto LDAP desejado. Se não for especificado, o BaseDN da string de conexão será usado.

Parâmetros de saída da ação GetAttributes

Essa ação retorna o status 200 (OK) com um corpo de resposta indicando os resultados.

Para entender como configurar a ação GetAttributes, consulte Exemplos de ação.

Ação "AddMembersToGroup"

Esta ação adiciona usuários a um grupo.

Parâmetros de entrada da ação GetAttributes

Nome do parâmetro Tipo de dados Obrigatório Descrição
GroupId String Sim ID do grupo ao qual você deseja adicionar os usuários.
UserDNs String Sim O conjunto de UserDNs ou uma tabela temporária que contém o DN dos usuários a serem adicionados ao grupo. O valor deve ser o DN do registro do usuário.

Parâmetros de saída da ação AddMembersToGroup

Essa ação retorna o status 200 (OK) com um corpo de resposta indicando os resultados.

Para entender como configurar a ação AddMembersToGroup, consulte Exemplos de ações.

Exemplos de ação

Esta seção descreve como realizar algumas das ações neste conector.

Exemplo: mover um objeto de um DN para outro

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação MoveToDN e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"DN": "CN=Google Cloud,OU=Bangalore,OU=India,OU=Domain_Users,DC=test-ldap,DC=com",
"NewParentDN": "OU=Mysore,OU=India,OU=Domain_Users,DC=test-ldap,DC=com"
}

    4. Este exemplo move um objeto de um DN para outro. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

    [{
"Success": null,
"result": "[ok]",
"modified": "true",
"rss:title": "The movement was successful.",
"resultcode": "0"
}]

Exemplo: acessar atributos de um DN

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação GetAttributes e clique em Concluído.
  3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value: 
    {
"DN": "CN=Bangalore user,OU=Bangalore,OU=India,OU=Domain_Users,DC=test-ldap,DC=com"
}

    4. Este exemplo recebe o atributo do DN especificado. Se a ação for bem-sucedida, seu Resposta connectorOutputPayload da tarefa do conector terá um valor semelhante ao seguinte:

    [{
    "AttributeName": "_op",
    "AttributeValue": "ldapadoGetAttributes"
  }, {
    "AttributeName": "usncreated",
    "AttributeValue": "36006"
  }, {
    "AttributeName": "countrycode",
    "AttributeValue": "0"
  }, {
    "AttributeName": "badpwdcount",
    "AttributeValue": "0"
  }, {
    "AttributeName": "dn",
    "AttributeValue": ""
  }, {
    "AttributeName": "dn",
    "AttributeValue": "CN=Bangalore user,OU=Bangalore,OU=India,OU=Domain_Users,DC=test-ldap,DC=com"
  }, {
    "AttributeName": "whenchanged",
    "AttributeValue": "20230913125155.0Z"
  }, {
    "AttributeName": "objectclass",
    "AttributeValue": "top"
  }, {
    "AttributeName": "objectclass",
    "AttributeValue": "person"
  }, {
    "AttributeName": "objectclass",
    "AttributeValue": "organizationalPerson"
  }, {
    "AttributeName": "objectclass",
    "AttributeValue": "user"
  }, {
    "AttributeName": "primarygroupid",
    "AttributeValue": "513"
  }, {
    "AttributeName": "givenname",
    "AttributeValue": "Bangalore"
  }, {
    "AttributeName": "dscorepropagationdata",
    "AttributeValue": "16010101000001.0Z"
  }, {
    "AttributeName": "sn",
    "AttributeValue": "user"
  }, {
    "AttributeName": "useraccountcontrol",
    "AttributeValue": "512"
  }, {
    "AttributeName": "cn",
    "AttributeValue": "Bangalore user"
  }, {
    "AttributeName": "codepage",
    "AttributeValue": "0"
  }, {
    "AttributeName": "accountexpires",
    "AttributeValue": "9223372036854775807"
  }, {
    "AttributeName": "userprincipalname",
    "AttributeValue": "user-1@test-l
  }]

Exemplo: adicionar usuários a um grupo

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação AddMembersToGroup e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"GroupId": "1|CN=Cert Publishers,CN=Users,DC=test-ldap,DC=com",
"UserDNs": "[{\"DN\":\"CN=Google AI,CN=Users,DC=test-ldap,DC=com;CN=Guest,CN=Users,DC=test-ldap,DC=com\"}]"
}

    4. Este exemplo adiciona um DN de usuário ao grupo com o ID 1|CN=Cert Publishers,CN=Users,DC=test-ldap,DC=com. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

    [{
  "Success": "True"
  }]

Exemplos de operações de entidade

Exemplo: listar usuários

Este exemplo lista todos os usuários na entidade User.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione User na lista Entity.
  3. Selecione a operação LIST e clique em Concluído.
  4. Também é possível filtrar o conjunto de resultados. Para filtrar o conjunto de resultados, na coluna Task Input da tarefa Conectores, defina a filterCláusula conforme necessário.

    Por exemplo, definir a cláusula de filtro como Id='1|CN=admin,CN=Users,DC=test-ldap,DC=com', lista apenas os registros cujo ID corresponde a esses critérios.

Exemplo: receber um registro de usuário

Este exemplo recebe um detalhe do usuário da entidade User.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione User na lista Entity.
  3. Selecione a operação GET e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em EntityId e insira 1|CN=admin,CN=Users,DC=test-ldap,DC=com no campo Valor padrão.

    Aqui, 1|CN=admin,CN=Users,DC=test-ldap,DC=com é um dos valores da chave primária da entidade User.

Exemplo: criar um registro de usuário

Neste exemplo, criamos um registro de usuário na entidade User.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione User na lista Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"RDN": "CN=MPATAI",
"ObjectClass": "top;person;organizationalPerson;user"
}

    Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

     {
"Id": "1|CN=MPATAI,CN=Users,DC=test-ldap,DC=com"
}

Exemplo: atualizar um tíquete

Este exemplo atualiza o registro do usuário especificado na entidade User.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione User na lista Entity.
  3. Selecione a operação Update e clique em Concluído.
  4. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value: 
    {
        "PostalCode": "560040"
      }
  5. Clique em entityId e insira 1|CN=admin,CN=Users,DC=test-ldap,DC=com no campo Valor padrão.

    Como alternativa, em vez de especificar o entityId, você também pode definir a filterClause como 1|CN=admin,CN=Users,DC=test-ldap,DC=com.

    Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

    {
"Id": "1|CN=admin,CN=Users,DC=test-ldap,DC=com"
}

Exemplo: excluir um registro de usuário

Este exemplo exclui um registro de usuário da entidade User.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione User na lista Entity.
  3. Selecione a operação Delete e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em entityId e insira 1|CN=admin,CN=Users,DC=test-ldap,DC=com no campo Valor padrão.
  5. Como alternativa, se a entidade User tiver chaves primárias compostas, em vez de especificar a entityId, é possível definir o filterFilter. Por exemplo, Id='1|CN=admin,CN=Users,DC=test-ldap,DC=com' and DN='CN=admin,CN=Users,DC=test-ldap,DC=com'.

Usar o Terraform para criar conexões

Use o recurso do Terraform para criar uma nova conexão.

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.

Para conferir um exemplo de modelo do Terraform para criação de conexão, consulte Exemplo de modelo.

Ao criar essa conexão usando o Terraform, defina as seguintes variáveis no arquivo de configuração do Terraform:

Nome do parâmetro Tipo de dados Obrigatório Descrição
base_dn STRING Verdadeiro A parte base do nome distinto, usada para limitar os resultados a subárvores específicas.
auth_mechanism ENUM Verdadeiro O mecanismo de autenticação a ser usado na conexão com o servidor LDAP. Os valores aceitos são: SIMPLE, DIGESTMD5, NEGOTIATE
follow_referrals BOOLEAN Falso Indica se as referências LDAP retornadas pelo servidor LDAP devem ou não ser seguidas.
friendly_guid BOOLEAN Falso Se você quer retornar valores de atributo GUID em um formato legível.
friendly_sid BOOLEAN Falso Se os valores do atributo SID serão retornados em um formato legível.
ldapversion ENUM Verdadeiro A versão do LDAP usada para se conectar e se comunicar com o servidor. Os valores aceitos são: 2, 3
escopo ENUM Verdadeiro Limitar o escopo da pesquisa à subárvore inteira (BaseDN e todos os descendentes), a um único nível (BaseDN e os descendentes diretos) ou ao objeto base (somente BaseDN). Os valores aceitos são: WHOLESUBTREE, SINGLELEVEL, BASEOBJECT

Usar a conexão LDAP em uma integração

Depois de criar a conexão, ela fica disponível na integração da Apigee e na integração do aplicativo. Você pode usar a conexão em uma integração pela tarefa Conectores.

  • Para entender como criar e usar a tarefa "Connectors" na integração da Apigee, consulte Tarefa Connectors.
  • Para entender como criar e usar a tarefa "Conectores" na integração de aplicativos, consulte Tarefa "Conectores".

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir