LDAP

Le connecteur LDAP vous permet de configurer un serveur LDAP générique.

Versions compatibles

Ce connecteur est compatible avec les versions 2 et 3 de LDAP.

Avant de commencer

Avant d'utiliser le connecteur LDAP, effectuez les tâches suivantes :

  • Dans votre projet Google Cloud :
    • Accordez le rôle IAM roles/connectors.admin à l'utilisateur qui configure le connecteur.
    • Attribuez les rôles IAM suivants au compte de service que vous souhaitez utiliser pour le connecteur :
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Un compte de service est un compte Google spécial destiné à représenter un utilisateur non humain qui doit s'authentifier et obtenir les autorisations permettant d'accéder aux données des API Google. Si vous ne possédez pas de compte de service, vous devez en créer un. Pour plus d'informations, consultez la section Créer un compte de service.

    • Activez les services suivants :
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Pour savoir comment activer des services, consultez la page Activer des services.

    Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer lors de la configuration du connecteur.

Configurer le connecteur

Pour configurer le connecteur, vous devez créer une connexion à votre source de données (système backend). Une connexion est spécifique à une source de données. Cela signifie que si vous disposez de nombreuses sources de données, vous devez créer une connexion distincte pour chacune d'elles. Pour créer une connexion, procédez comme suit :

  1. Dans la console Cloud, accédez à la page Integration Connectors > Connections (Connecteurs d'intégration > Connexions), puis sélectionnez ou créez un projet Google Cloud.

    Accéder à la page "Connexions"

  2. Cliquez sur + CRÉER pour ouvrir la page Créer une connexion.
  3. Dans la section Emplacement, choisissez l'emplacement de la connexion.
    1. Région : sélectionnez un emplacement dans la liste déroulante.

      Pour obtenir la liste de toutes les régions disponibles, consultez la page Emplacements.

    2. Cliquez sur NEXT (Suivant).
  4. Dans la section Informations de connexion, procédez comme suit :
    1. Connecteur : sélectionnez LDAP dans la liste déroulante des connecteurs disponibles.
    2. Version du connecteur : sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
    3. Dans le champ Nom de connexion, saisissez un nom pour l'instance de connexion.

      Les noms de connexion doivent répondre aux critères suivants :

      • Les noms de connexion peuvent contenir des lettres, des chiffres ou des traits d'union.
      • Les lettres doivent être en minuscules.
      • Les noms de connexion doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
      • Les noms de connexion ne peuvent pas dépasser 63 caractères.
    4. Saisissez éventuellement une Description pour l'instance de connexion.
    5. Compte de service : sélectionnez un compte de service disposant des rôles requis.
    6. Vous pouvez également configurer les paramètres du nœud de connexion :

      • Nombre minimal de nœuds : saisissez le nombre minimal de nœuds de connexion.
      • Nombre maximal de nœuds : saisissez le nombre maximal de nœuds de connexion.

      Un nœud est une unité (ou instance répliquée) de connexion qui traite des transactions. Pour traiter plus de transactions pour une connexion, plus de nœuds sont nécessaires. À l'inverse, moins de nœuds sont nécessaires pour traiter moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez la section Tarifs des nœuds de connexion. Si vous ne saisissez aucune valeur, le nombre minimal de nœuds est défini par défaut sur 2 (pour une meilleure disponibilité) et le nombre maximal sur 50.

    7. Nom unique de base : partie de base du nom distinctif, utilisée pour limiter les résultats à des sous-arborescences spécifiques.
    8. Mécanisme d'authentification : mécanisme d'authentification à utiliser lors de la connexion au serveur LDAP.
    9. Suivre les parrainages : indique si vous souhaitez suivre les parrainages LDAP renvoyés par le serveur LDAP.
    10. GUID convivial : indique s'il faut renvoyer les valeurs d'attributs GUID dans un format lisible.
    11. SID convivial : indique s'il faut renvoyer des valeurs d'attributs SID dans un format lisible.
    12. Version LDAP : version LDAP utilisée pour se connecter au serveur et communiquer avec.
    13. Champ d'application : limite la recherche à la sous-arborescence entière (BaseDN et tous ses descendants), à un seul niveau (BaseDN et ses descendants directs) ou à l'objet de base (BaseDN uniquement).
    14. Vous pouvez également cliquer sur + AJOUTER UN LIBELLÉ pour ajouter un libellé à la connexion sous la forme d'une paire clé/valeur.
    15. Cliquez sur NEXT (Suivant).
  5. Dans la section Destinations, saisissez les informations concernant l'hôte distant (système backend) auquel vous souhaitez vous connecter.
    1. Type de destination : sélectionnez un type de destination.
      • Dans la liste, sélectionnez Host address (Adresse de l'hôte) pour spécifier le nom d'hôte ou l'adresse IP de la destination.
      • Si vous souhaitez établir une connexion privée à vos systèmes de backend, sélectionnez Rattachement de point de terminaison dans la liste, puis sélectionnez le rattachement de point de terminaison requis dans la liste Rattachement de point de terminaison.

      Si vous souhaitez établir une connexion publique avec vos systèmes backend avec une sécurité supplémentaire, vous pouvez envisager de configurer des adresses IP sortantes statiques pour vos connexions, puis configurer vos règles de pare-feu pour n'ajouter à la liste d'autorisation que les adresses IP statiques spécifiques.

      Pour saisir d'autres destinations, cliquez sur + AJOUTER UNE DESTINATION.

    2. Cliquez sur NEXT (Suivant).
  6. Dans la section Authentification, saisissez les informations d'authentification.
    1. Sélectionnez un type d'authentification, puis saisissez les informations appropriées.

      Les types d'authentification suivants sont compatibles avec la connexion LDAP :

      • Nom d'utilisateur et mot de passe
    2. Pour comprendre comment configurer ces types d'authentification, consultez la section Configurer l'authentification.

    3. Cliquez sur NEXT (Suivant).
  7. Vérifiez vos informations de connexion et d'authentification.
  8. Cliquez sur Créer.

Configurer l'authentification

Saisissez les détails en fonction de l'authentification que vous souhaitez utiliser.

  • Nom d'utilisateur et mot de passe
    • Nom d'utilisateur : nom d'utilisateur du connecteur
    • Mot de passe : Secret de Secret Manager contenant le mot de passe associé au connecteur.

Entités, opérations et actions

Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que via cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

  • Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connecté. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, dans un connecteur de serveur de fichiers, les dossiers sont les entités et, dans un connecteur de système de messagerie, les files d'attente sont les entités.

    Toutefois, il est possible qu'un connecteur ne soit pas compatible ou ne possède aucune entité. Dans ce cas, la liste Entities est vide.

  • Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Vous pouvez effectuer l'une des opérations suivantes sur une entité :

    La sélection d'une entité dans la liste disponible génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche de connecteur. Toutefois, si un connecteur n'accepte aucune des opérations d'entité, celles-ci ne sont pas répertoriées dans la liste Operations.

  • Action : une action est une fonction de première classe mise à la disposition de l'intégration via l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Normalement, une action comporte des paramètres d'entrée et un paramètre de sortie. Toutefois, il est possible qu'un connecteur ne prenne en charge aucune action, auquel cas la liste Actions est vide.

Actions

Cette section répertorie toutes les actions compatibles avec le connecteur LDAP.

Action MoveToDN

Cette action déplace les objets d'un DN (nom distinctif) vers un autre.

Paramètres d'entrée de l'action MoveToDN

Nom du paramètre Type de données Obligatoire Description
DN Chaîne Oui Nom distinctif actuel de l'objet à déplacer sur le serveur LDAP Par exemple, CN=Google Cloud,OU=Bangalore,OU=India,OU=Domain_Users,DC=test-ldap,DC=com.
NewParentDN Chaîne Oui Nouveau nom distinctif parent de l'objet. Par exemple, OU=Mysore,OU=India,OU=Domain_Users,DC=test-ldap,DC=com.

Paramètres de sortie de l'action DownloadFile

Cette action renvoie l'état 200 (OK) avec un corps de réponse indiquant les résultats.

Pour comprendre comment configurer l'action MoveToDN, consultez Exemples d'actions.

Action GetAttributes

Cette action permet d'obtenir tous les noms et valeurs d'attribut d'un DN.

Paramètres d'entrée de l'action GetAttributes

Nom du paramètre Type de données Obligatoire Description
DN Chaîne Oui Nom distinctif de l'objet LDAP souhaité. Si aucune valeur n'est spécifiée, le BaseDN de la chaîne de connexion sera utilisé.

Paramètres de sortie de l'action GetAttributes

Cette action renvoie l'état 200 (OK) avec un corps de réponse indiquant les résultats.

Pour comprendre comment configurer l'action GetAttributes, consultez Exemples d'actions.

Action AddMembersToGroup

Cette action ajoute des utilisateurs à un groupe.

Paramètres d'entrée de l'action GetAttributes

Nom du paramètre Type de données Obligatoire Description
GroupId Chaîne Oui ID du groupe auquel vous souhaitez ajouter les utilisateurs.
UserDNs Chaîne Oui Les noms de domaine agrégés ou un tableau temporaire contenant les noms distinctifs des utilisateurs à ajouter au groupe. La valeur doit correspondre au nom distinctif de l'enregistrement de l'utilisateur.

Paramètres de sortie de l'action AddMembersToGroup

Cette action renvoie l'état 200 (OK) avec un corps de réponse indiquant les résultats.

Pour comprendre comment configurer l'action AddMembersToGroup, consultez Exemples d'actions.

Exemples d'actions

Cette section décrit comment effectuer certaines actions dans ce connecteur.

Exemple : Déplacer un objet d'un nom distinctif vers un autre

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action MoveToDN, puis cliquez sur OK.
  3. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ 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. Dans l'exemple ci-dessous, un objet est déplacé d'un nom distinctif vers un autre. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de votre tâche de connecteur aura une valeur semblable à celle-ci:

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

Exemple : obtenir les attributs d'un nom distinctif

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action GetAttributes, puis cliquez sur OK.
  3. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
    "DN": "CN=Bangalore user,OU=Bangalore,OU=India,OU=Domain_Users,DC=test-ldap,DC=com"
    }
  4. Cet exemple récupère l'attribut du DN spécifié. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de votre tâche de connecteur aura une valeur semblable à celle-ci:

    [{
        "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
      }]  
      

Exemple : Ajouter des utilisateurs à un groupe

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action AddMembersToGroup, puis cliquez sur OK.
  3. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ 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. Dans cet exemple, un nom distinctif d'utilisateur est ajouté au groupe dont l'ID est 1|CN=Cert Publishers,CN=Users,DC=test-ldap,DC=com. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de votre tâche de connecteur aura une valeur semblable à celle-ci:

    [{
      "Success": "True"
      }]

Exemples d'opérations sur les entités

Exemple – Répertorier les utilisateurs

Cet exemple répertorie tous les utilisateurs de l'entité User.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez User dans la liste Entity.
  3. Sélectionnez l'opération LIST, puis cliquez sur OK.
  4. Vous pouvez éventuellement filtrer l'ensemble de résultats. Pour filtrer l'ensemble de résultats, définissez une clause filterClause selon vos besoins dans la section Task Input (Entrée dans la tâche) de la tâche Connectors (Connecteurs).

    Par exemple, si vous définissez la clause de filtre sur Id='1|CN=admin,CN=Users,DC=test-ldap,DC=com', vous ne répertoriez que les enregistrements dont l'ID correspond à ce critère.

Exemple – Obtenir un enregistrement utilisateur

Cet exemple récupère des informations sur l'utilisateur à partir de l'entité User.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez User dans la liste Entity.
  3. Sélectionnez l'opération GET, puis cliquez sur OK.
  4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur EntityId (ID d'entité), puis saisissez 1|CN=admin,CN=Users,DC=test-ldap,DC=com dans le champ Default Value (Valeur par défaut).

    Ici, 1|CN=admin,CN=Users,DC=test-ldap,DC=com est l'une des valeurs de clé primaire de l'entité User.

Exemple : Créer un enregistrement utilisateur

Cet exemple crée un enregistrement utilisateur dans l'entité User.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez User dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
    "RDN": "CN=MPATAI",
    "ObjectClass": "top;person;organizationalPerson;user"
    }

    Si l'intégration réussit, le champ connectorOutputPayload de votre tâche de connecteur aura une valeur semblable à celle-ci:

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

Exemple – Mettre à jour une demande

Cet exemple met à jour l'enregistrement de l'utilisateur spécifié dans l'entité User.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez User dans la liste Entity.
  3. Sélectionnez l'opération Update, puis cliquez sur OK.
  4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
            "PostalCode": "560040"
          }
          
  5. Cliquez sur entityId, puis saisissez 1|CN=admin,CN=Users,DC=test-ldap,DC=com dans le champ Valeur par défaut.

    Au lieu de spécifier entityId, vous pouvez également définir filterClause sur 1|CN=admin,CN=Users,DC=test-ldap,DC=com.

    Si l'intégration réussit, le champ connectorOutputPayload de votre tâche de connecteur aura une valeur semblable à celle-ci:

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

Exemple : Supprimer un enregistrement utilisateur

Cet exemple supprime un enregistrement utilisateur de l'entité User.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez User dans la liste Entity.
  3. Sélectionnez l'opération Delete, puis cliquez sur OK.
  4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur entityId, puis saisissez 1|CN=admin,CN=Users,DC=test-ldap,DC=com dans le champ Default Value (Valeur par défaut).
  5. Si l'entité User comporte des clés primaires composites, vous pouvez définir filterClause au lieu de spécifier entityId. Exemple : Id='1|CN=admin,CN=Users,DC=test-ldap,DC=com' and DN='CN=admin,CN=Users,DC=test-ldap,DC=com'

Utiliser Terraform pour créer des connexions

Vous pouvez utiliser la ressource Terraform pour créer une connexion.

Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez la page Commandes Terraform de base.

Pour afficher un exemple de modèle Terraform pour la création de connexions, consultez cet exemple de modèle.

Lorsque vous créez cette connexion à l'aide de Terraform, vous devez définir les variables suivantes dans votre fichier de configuration Terraform:

Nom du paramètre Type de données Obligatoire Description
base_dn STRING Vrai Partie de base du nom distinctif, utilisée pour limiter les résultats à des sous-arborescences spécifiques.
auth_mechanism ENUM Vrai Mécanisme d'authentification à utiliser lors de la connexion au serveur LDAP Valeurs acceptées: SIMPLE, DIGESTMD5, NEGOTIATE
follow_referrals VALEUR BOOLÉENNE Faux Indique si le serveur LDAP doit suivre les références LDAP renvoyées par le serveur LDAP.
friendly_guid VALEUR BOOLÉENNE Faux Indique s'il faut renvoyer les valeurs d'attribut GUID dans un format lisible par l'humain.
friendly_sid VALEUR BOOLÉENNE Faux Indique si les valeurs d'attribut SID doivent être renvoyées dans un format lisible par l'humain.
version LDAP ENUM Vrai Version LDAP utilisée pour se connecter au serveur et communiquer avec celui-ci. Les valeurs acceptées sont: 2, 3
champ d'application ENUM Vrai Permet de limiter la portée de la recherche à l'ensemble de la sous-arborescence (BaseDN et tous ses descendants), à un seul niveau (BaseDN et ses descendants directs) ou à l'objet de base (BaseDN uniquement). Les valeurs acceptées sont: WHOLESUBTREE, SINGLELEVEL et BASEOBJECT.

Utiliser la connexion LDAP dans une intégration

Une fois la connexion créée, elle devient disponible à la fois dans Apigee Integration et Application Integration. Vous pouvez utiliser la connexion dans une intégration via la tâche Connecteurs.

  • Pour comprendre comment créer et utiliser la tâche "Connecteurs" dans Apigee Integration, consultez la section Tâche Connecteurs.
  • Pour découvrir comment créer et utiliser la tâche "Connecteurs" dans Application Integration, consultez la section Tâche Connecteurs.

Obtenir de l'aide auprès de la communauté Google Cloud

Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.

Étapes suivantes