Cette page a été traduite par l'API Cloud Translation.

Créer un connecteur d'identité

Par défaut, Google Cloud Search ne reconnaît que les identités Google stockées dans l'annuaire Google Cloud (utilisateurs et groupes). Les connecteurs d'identité permettent de synchroniser les identités de votre entreprise avec les identités Google utilisées par Google Cloud Search.

Google propose les options suivantes pour développer des connecteurs d'identité:

Le SDK Identity Connector. Cette option est destinée aux développeurs qui programment en langage Java. Le SDK Identity Connector est un wrapper pour l'API REST qui vous permet de créer rapidement des connecteurs. Pour créer un connecteur d'identité à l'aide du SDK, consultez Créer un connecteur d'identité à l'aide du SDK Identity Connector.
Une API REST de bas niveau et des bibliothèques d'API. Ces options sont destinées aux développeurs qui ne programment peut-être pas en Java, ou dont le codebase est mieux adapté à une API REST ou à une bibliothèque. Pour créer un connecteur d'identité à l'aide de l'API REST, consultez la page API Directory: comptes utilisateur pour en savoir plus sur le mappage des utilisateurs et la documentation Cloud Identity pour en savoir plus sur le mappage de groupes.

Créer un connecteur d'identité à l'aide du SDK Identity Connector

Un connecteur d'identité standard effectue les tâches suivantes:

Configurez le connecteur.
Récupérez tous les utilisateurs du système d'identité de votre entreprise et envoyez-les à Google pour synchronisation avec les identités Google.
Récupérez tous les groupes du système d'identité de votre entreprise et envoyez-les à Google pour les synchroniser avec les identités Google.

Configurer des dépendances

Vous devez inclure certaines dépendances dans votre fichier de compilation pour utiliser le SDK. Cliquez sur un onglet ci-dessous pour afficher les dépendances de votre environnement de compilation:

Maven

<dependency>
<groupId>com.google.enterprise.cloudsearch</groupId>
<artifactId>google-cloudsearch-identity-connector-sdk</artifactId>
<version>v1-0.0.3</version>
</dependency>

Gradle

 compile group: 'com.google.enterprise.cloudsearch',
         name: 'google-cloudsearch-identity-connector-sdk',
         version: 'v1-0.0.3'

Créer la configuration de votre connecteur

Chaque connecteur dispose d'un fichier de configuration contenant ses paramètres, tels que l'ID de votre dépôt. Les paramètres sont définis sous forme de paires clé-valeur (par exemple, api.sourceId=1234567890abcdef).

Le SDK Google Cloud Search contient plusieurs paramètres de configuration fournis par Google qui sont utilisés par tous les connecteurs. Vous devez déclarer les paramètres suivants, fournis par Google, dans votre fichier de configuration:

Pour un connecteur de contenu, vous devez déclarer api.sourceId et api.serviceAccountPrivateKeyFile, car ces paramètres identifient l'emplacement du dépôt et de la clé privée nécessaires pour y accéder.

Pour un connecteur d'identité, vous devez déclarer api.identitySourceId, car ce paramètre identifie l'emplacement de votre source d'identité externe. Si vous synchronisez les utilisateurs, vous devez également déclarer api.customerId comme ID unique pour le compte Google Workspace de votre entreprise.

À moins que vous ne souhaitiez remplacer les valeurs par défaut d'autres paramètres fournis par Google, vous n'avez pas besoin de les déclarer dans votre fichier de configuration. Pour en savoir plus sur les paramètres de configuration fournis par Google, concernant par exemple la génération de certains ID et de certaines clés, consultez l'article Paramètres de configuration fournis par Google.

Vous pouvez également définir des paramètres spécifiques au dépôt à utiliser dans votre fichier de configuration.

Transmettre le fichier de configuration au connecteur

Définissez la propriété système config pour transmettre le fichier de configuration à votre connecteur. Vous pouvez définir cette propriété à l'aide de l'argument -D lors du démarrage du connecteur. Par exemple, la commande suivante démarre le connecteur avec le fichier de configuration MyConfig.properties:

java -classpath myconnector.jar;... -Dconfig=MyConfig.properties MyConnector

Si cet argument est manquant, le SDK tente d'accéder à un fichier de configuration par défaut nommé connector-config.properties.

Créer un connecteur d'identité de synchronisation complète à l'aide d'un modèle de classe

Le SDK Identity Connector contient une classe de modèle FullSyncIdentityConnector qui vous permet de synchroniser tous les utilisateurs et groupes du dépôt d'identités avec les identités Google. Cette section explique comment utiliser le modèle FullSyncIdentityConnector pour effectuer une synchronisation complète des utilisateurs et des groupes à partir d'un dépôt d'identités autre que Google.

Cette section fait référence aux extraits de code de l'exemple IdentityConnecorSample.java. Cet exemple lit les identités des utilisateurs et des groupes à partir de deux fichiers CSV et les synchronise avec les identités Google.

Implémenter le point d'entrée du connecteur

Le point d'entrée d'un connecteur est la méthode main(). La tâche principale de cette méthode consiste à créer une instance de la classe Application et à appeler sa méthode start() pour exécuter le connecteur.

Avant d'appeler application.start(), utilisez la classe IdentityApplication.Builder pour instancier le modèle FullSyncIdentityConnector. FullSyncIdentityConnector accepte un objet Repository dont vous allez implémenter les méthodes. L'extrait de code suivant montre comment implémenter la méthode main():

IdentityConnectorSample.java

Afficher sur GitHub

/**
 * This sample connector uses the Cloud Search SDK template class for a full
 * sync connector. In the full sync case, the repository is responsible
 * for providing a snapshot of the complete identity mappings and
 * group rosters. This is then reconciled against the current set
 * of mappings and groups in Cloud Directory.
 *
 * @param args program command line arguments
 * @throws InterruptedException thrown if an abort is issued during initialization
 */
public static void main(String[] args) throws InterruptedException {
  Repository repository = new CsvRepository();
  IdentityConnector connector = new FullSyncIdentityConnector(repository);
  IdentityApplication application = new IdentityApplication.Builder(connector, args).build();
  application.start();
}

En arrière-plan, le SDK appelle la méthode initConfig() après que la méthode main() du connecteur a appelé Application.build. La méthode initConfig() effectue les tâches suivantes:

Appelle la méthode Configuation.isInitialized() pour s'assurer que l'objet Configuration n'a pas été initialisé.
Initialise un objet Configuration avec les paires clé/valeur fournies par Google. Chaque paire clé-valeur est stockée dans un objet ConfigValue au sein de l'objet Configuration.

Implémenter l'interface `Repository`

L'objet Repository a pour unique objectif d'effectuer la synchronisation des identités de dépôt avec celles de Google. Lorsque vous utilisez un modèle, il vous suffit de remplacer certaines méthodes dans l'interface Repository pour créer un connecteur d'identité. Pour FullTraversalConnector, vous devrez probablement remplacer les méthodes suivantes:

La méthode init(). Pour configurer et initialiser un dépôt d'identités, remplacez la méthode "init()".
La méthode listUsers(). Pour synchroniser tous les utilisateurs du dépôt d'identités avec les utilisateurs Google, remplacez la méthode listUsers().
La méthode listGroups(). Pour synchroniser tous les groupes du dépôt d'identités avec Google Groupes, remplacez la méthode listGroups().
(Facultatif) La méthode close(). Si vous devez effectuer un nettoyage du dépôt, remplacez la méthode close(). Cette méthode est appelée une fois lors de l'arrêt du connecteur.

Obtenir des paramètres de configuration personnalisés

Lorsque vous gérez la configuration de votre connecteur, vous devez récupérer les éventuels paramètres personnalisés contenus dans l'objet Configuration. Cette tâche est généralement effectuée dans la méthode init() d'une classe Repository.

La classe Configuration comporte plusieurs méthodes permettant d'obtenir différents types de données à partir d'une configuration. Chaque méthode renvoie un objet ConfigValue. Vous allez ensuite utiliser la méthode get() de l'objet ConfigValue pour récupérer la valeur réelle. L'extrait de code suivant montre comment récupérer les valeurs userMappingCsvPath et groupMappingCsvPath à partir d'un objet Configuration:

IdentityConnectorSample.java

Afficher sur GitHub

/**
 * Initializes the repository once the SDK is initialized.
 *
 * @param context Injected context, contains convenienve methods
 *                for building users & groups
 * @throws IOException if unable to initialize.
 */
@Override
public void init(RepositoryContext context) throws IOException {
  log.info("Initializing repository");
  this.context = context;
  userMappingCsvPath = Configuration.getString(
      "sample.usersFile", "users.csv").get().trim();
  groupMappingCsvPath = Configuration.getString(
      "sample.groupsFile", "groups.csv").get().trim();
}

Pour obtenir et analyser un paramètre contenant plusieurs valeurs, utilisez l'un des analyseurs de type de la classe Configuration afin d'analyser les données en fragments distincts. L'extrait de code suivant, issu du connecteur du tutoriel, utilise la méthode getMultiValue pour obtenir la liste des noms de dépôts GitHub:

GithubRepository.java

Afficher sur GitHub

ConfigValue<List<String>> repos = Configuration.getMultiValue(
    "github.repos",
    Collections.emptyList(),
    Configuration.STRING_PARSER);

Obtenir le mappage pour tous les utilisateurs

Ignorez listUsers() pour récupérer le mappage de tous les utilisateurs à partir de votre dépôt d'identités. La méthode listUsers() accepte un point de contrôle représentant la dernière identité à synchroniser. Le point de contrôle peut être utilisé pour reprendre la synchronisation si le processus est interrompu. Pour chaque utilisateur de votre dépôt, vous accomplirez les tâches suivantes dans la méthode listUsers():

obtenir un mappage composé de l'identité Google et de l'identité externe associée ;
Empaqueter ces deux éléments dans un itérateur renvoyé par la méthode listUsers()

Obtenir un mappage utilisateur

L'extrait de code suivant montre comment récupérer les mappages d'identité stockés dans un fichier CSV:

IdentityConnectorSample.java

Afficher sur GitHub

/**
 * Retrieves all user identity mappings for the identity source. For the
 * full sync connector, the repository must provide a complete snapshot
 * of the mappings. This is reconciled against the current mappings
 * in Cloud Directory. All identity mappings returned here are
 * set in Cloud Directory. Any previously mapped users that are omitted
 * are unmapped.
 *
 * The connector does not create new users. All users are assumed to
 * exist in Cloud Directory.
 *
 * @param checkpoint Saved state if paging over large result sets. Not used
 *                   for this sample.
 * @return Iterator of user identity mappings
 * @throws IOException if unable to read user identity mappings
 */
@Override
public CheckpointCloseableIterable<IdentityUser> listUsers(byte[] checkpoint)
    throws IOException {
  List<IdentityUser> users = new ArrayList<>();
  try (Reader in = new FileReader(userMappingCsvPath)) {
    // Read user mappings from CSV file
    CSVParser parser = CSVFormat.RFC4180
        .withIgnoreSurroundingSpaces()
        .withIgnoreEmptyLines()
        .withCommentMarker('#')
        .parse(in);
    for (CSVRecord record : parser.getRecords()) {
      // Each record is in form: "primary_email", "external_id"
      String primaryEmailAddress = record.get(0);
      String externalId = record.get(1);
      if (primaryEmailAddress.isEmpty() || externalId.isEmpty()) {
        // Skip any malformed mappings
        continue;
      }
      log.info(() -> String.format("Adding user %s/%s",
          primaryEmailAddress, externalId));

      // Add the identity mapping
      IdentityUser user = context.buildIdentityUser(
          primaryEmailAddress, externalId);
      users.add(user);
    }
  }
  // ...
}

Empaqueter un mappage utilisateur dans un itérateur

La méthode listUsers() renvoie un Iterator (plus précisément un CheckpointCloseableIterable) d'objets IdentityUser. Vous pouvez utiliser la classe CheckpointClosableIterableImpl.Builder pour construire et renvoyer un itérateur. L'extrait de code suivant montre comment empaqueter chaque mappage dans l'itérateur de compilation de liste à partir de cette liste:

IdentityConnectorSample.java

Afficher sur GitHub

CheckpointCloseableIterable<IdentityUser> iterator =
  new CheckpointCloseableIterableImpl.Builder<IdentityUser>(users)
      .setHasMore(false)
      .setCheckpoint((byte[])null)
      .build();

Obtenir un groupe

Ignorez listGroups() pour récupérer tous les groupes et leurs membres à partir de votre dépôt d'identités. La méthode listGroups() accepte un point de contrôle représentant la dernière identité à synchroniser. Le point de contrôle peut être utilisé pour reprendre la synchronisation si le processus est interrompu. Pour chaque utilisateur de votre dépôt, vous accomplirez les tâches suivantes dans la méthode listGroups():

Obtenez le groupe et ses membres.
Empaqueter chaque groupe et ses membres dans un itérateur renvoyé par la méthode listGroups()

Obtenir l'identité du groupe

L'extrait de code suivant montre comment récupérer les groupes et les membres stockés dans un fichier CSV:

IdentityConnectorSample.java

Afficher sur GitHub

/**
 * Retrieves all group rosters for the identity source. For the
 * full sync connector, the repository must provide a complete snapshot
 * of the rosters. This is reconciled against the current rosters
 * in Cloud Directory. All groups and members  returned here are
 * set in Cloud Directory. Any previously created groups or members
 * that are omitted are removed.
 *
 * @param checkpoint Saved state if paging over large result sets. Not used
 *                   for this sample.
 * @return Iterator of group rosters
 * @throws IOException if unable to read groups
 */    @Override
public CheckpointCloseableIterable<IdentityGroup> listGroups(byte[] checkpoint)
    throws IOException {
  List<IdentityGroup> groups = new ArrayList<>();
  try (Reader in = new FileReader(groupMappingCsvPath)) {
    // Read group rosters from CSV
    CSVParser parser = CSVFormat.RFC4180
        .withIgnoreSurroundingSpaces()
        .withIgnoreEmptyLines()
        .withCommentMarker('#')
        .parse(in);
    for (CSVRecord record : parser.getRecords()) {
      // Each record is in form: "group_id", "member"[, ..., "memberN"]
      String groupName = record.get(0);
      log.info(() -> String.format("Adding group %s", groupName));
      // Parse the remaining columns as group memberships
      Supplier<Set<Membership>> members = new MembershipsSupplier(record);
      IdentityGroup group = context.buildIdentityGroup(groupName, members);
      groups.add(group);
    }
  }
  // ...

}

Empaqueter le groupe et ses membres dans un itérateur

La méthode listGroups() renvoie un Iterator (plus précisément un CheckpointCloseableIterable) d'objets IdentityGroup. Vous pouvez utiliser la classe CheckpointClosableIterableImpl.Builder pour construire et renvoyer un itérateur. L'extrait de code suivant montre comment empaqueter chaque groupe et ses membres dans une liste, puis créer l'itérateur à partir de cette liste:

IdentityConnectorSample.java

Afficher sur GitHub

CheckpointCloseableIterable<IdentityGroup> iterator =
   new CheckpointCloseableIterableImpl.Builder<IdentityGroup>(groups)
      .setHasMore(false)
      .setCheckpoint((byte[])null)
      .build();

Étapes suivantes

Voici quelques étapes que vous pouvez également suivre :

(Facultatif) Implémentez la méthode close() pour libérer les ressources avant l'arrêt.
(Facultatif) Créez un connecteur de contenu à l'aide du SDK Content Connector.

Créer un connecteur d'identité

Créer un connecteur d'identité à l'aide du SDK Identity Connector

Configurer des dépendances

Maven

Gradle

Créer la configuration de votre connecteur

Transmettre le fichier de configuration au connecteur

Créer un connecteur d'identité de synchronisation complète à l'aide d'un modèle de classe

Implémenter le point d'entrée du connecteur

Implémenter l'interface Repository

Obtenir des paramètres de configuration personnalisés

Obtenir le mappage pour tous les utilisateurs

Obtenir un mappage utilisateur

Empaqueter un mappage utilisateur dans un itérateur

Obtenir un groupe

Obtenir l'identité du groupe

Empaqueter le groupe et ses membres dans un itérateur

Étapes suivantes

Implémenter l'interface `Repository`