Exportation de tous les utilisateurs

Avant d'importer vos profils dans votre nouvelle instance, vous devez les exporter de l'instance d'origine du service.

Si vous exportez de nombreux utilisateurs (16 000 ou plus), vous pouvez utiliser le noeud final d'API export/all.

1. Exportez tous les utilisateurs de votre instance originale du service.

   curl -X POST 'https://<region>.appid.cloud.ibm.com/management/v4/<tenantID>/cloud_directory/export/all' \
      --header 'Content-Type: application/json' \
      --header 'Authorization: Bearer <IAMToken>' \
      --data-raw '{"encryptionSecret" : "<encryptionSecret>",  
   "emailAddress" : "jdoe@example.com"}'
   

2. Obtenez le statut de votre demande, si nécessaire.

   curl -X GET 'https://<region>.appid.cloud.ibm.com/management/v4/<tenantID>/cloud_directory/export/status?id=<id>' --header 'Accept: application/json' \
      --header 'Content-Type: application/json' \
      --header 'Authorization: Bearer <IAMToken>'
   

3. Lorsque l'exportation est prête ou si la demande échoue, un courrier électronique est envoyé à l'adresse électronique indiquée. Pour télécharger l'exportation, utilisez l'API export/download.

   curl -X GET 'https://<region>.appid.cloud.ibm.com/management/v4/<tenantID>/cloud_directory/export/download?id=<id>' \
      --header 'Content-Type: application/json' \
      --header 'Authorization: Bearer <IAMToken>'
   

   Un fichier d'exportation est créé uniquement lorsque la demande d'exportation aboutit. Si la demande échoue, pour réduire le risque de vulnérabilité, les données collectées sont supprimées. L'exportation est automatiquement supprimée après 7 jours ou le nombre de jours que vous spécifiez dans le corps de la demande (compris entre 1 et 30 jours). Vous pouvez choisir de supprimer manuellement l'exportation en envoyant une demande à l'API delete.

   Description des paramètres qui doivent être fournis dans la requête export/all

   Paramètres	Description
   encryptionSecret	Chaîne personnalisée utilisée pour chiffrer et déchiffrer le mot de passe haché d'un utilisateur. Conservez la valeur confidentielle de chiffrement si vous en avez besoin pour utiliser l'API import/all. IBM ne stocke pas le secret. Par conséquent, si le secret est perdu, vous ne pouvez pas accéder aux données exportées.
   emailAddress	Adresse électronique à laquelle un courrier électronique est envoyé lorsque l'exportation est prête ou si la demande échoue.
   expires	Entier que vous pouvez définir (1 ≤ valeur ≤ 30) pour spécifier le nombre de jours après lequel l'exportation doit être supprimée. La valeur par défaut est 7.
   tenantID	ID du titulaire du service qui se trouve dans vos données d'identification du service. Vous pouvez trouver ou créer vos identifiants de service dans le tableau de bord App ID.

Exporter des utilisateurs par lots

Le point final d'exportation est réservé aux exportations mineures d'environ moins de 16 000 utilisateurs. Pour exporter tous vos utilisateurs Cloud Directory associés à un ID locataire spécifique, utilisez le noeud final d'API export/all.

1. Exportez les utilisateurs depuis votre instance de service d'origine.

   curl -X GET 'https://<region>.appid.cloud.ibm.com/management/v4/<tenantID>/cloud_directory/export?encryption_secret=mySecret' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer <IAMToken>'
   

   Description des paramètres à fournir dans la demande d'exportation

   Paramètres	Description
   encryptionSecret	Chaîne personnalisée utilisée pour chiffrer et déchiffrer le mot de passe haché d'un utilisateur.
   tenantID	ID du titulaire du service qui se trouve dans vos données d'identification du service. Vos données d'identification du service sont disponibles dans le tableau de bord App ID.

   Seuls vos utilisateurs Cloud Directory et leurs profils sont renvoyés. Les utilisateurs d'autres fournisseurs d'identité ne le sont pas.

Importation de tous les utilisateurs

Maintenant que vous disposez d'une liste d'utilisateurs Cloud Directory exportés, vous pouvez les importer dans la nouvelle instance. Vous pouvez utiliser le point de terminaison import-all de l'API pour importer un nombre important d'utilisateurs (16 000 ou plus) en une seule demande.

1. Importez la liste des utilisateurs exportés que vous avez téléchargés.

   curl -X POST 'https://<region>.appid.cloud.ibm.com/management/v4/<tenantID>/cloud_directory/import/all' \
   --header 'Content-Type: multipart/form-data' \
   --header 'Authorization: Bearer <IAMToken>' \
   --form 'file=@<User/desktop/myfolder/user_list.json>' \
   --form 'encryptionSecret=mySecret' \
   --form 'emailAddress=jdoe@example.com'
   

2. Obtenez le statut de votre demande, si nécessaire.

   curl -X GET 'https://<region>.appid.cloud.ibm.com/management/v4/<tenantID>/cloud_directory/import/status?id=<id>' \
   --header 'Accept: application/json' \
   --header 'Content-Type: application/json' \
   --header 'Authorization: Bearer <IAMToken>'
   

   Description des paramètres qui doivent être fournis dans la demande d'importation/d'aliénation

   Paramètres	Description
   encryptionSecret	Chaîne personnalisée utilisée pour chiffrer et déchiffrer le mot de passe haché d'un utilisateur. Le secret de chiffrement est le même que celui que vous avez associé à l'API export/all. IBM ne stocke pas le secret. Par conséquent, si le secret est perdu, vous ne pouvez pas accéder aux données exportées.
   emailAddress	Adresse électronique à laquelle un courrier électronique est envoyé lorsque l'exportation est prête ou si la demande échoue.
   tenantID	ID du titulaire du service qui se trouve dans vos données d'identification du service. Vous pouvez trouver ou créer vos identifiants de service dans le tableau de bord App ID.
   file	Sortie du noeud final export/download.

Importation d'utilisateurs par lots

Vous pouvez utiliser le noeud final d'API d'importation pour importer de petits groupes d'utilisateurs. Vous pouvez ajouter jusqu'à 50 utilisateurs par demande avec le noeud final d'API d'importation. Pour ajouter tous vos utilisateurs via une seule demande, utilisez le noeud final d'API import/all.

1. Si vos utilisateurs ont des rôles qui leur ont été affectés, veillez à créer les rôles et les portées dans votre nouvelle instance d'App ID.

   Les rôles et les portées doivent être créés exactement comme dans l'instance précédente avec la même orthographe.

2. Les utilisateurs sont importés avec un nouvel identificateur Cloud Directory. Si votre application référence l'identificateur Cloud Directory d'une manière ou d'une autre, vous pouvez choisir de créer un attribut personnalisé et d'ajuster votre application pour appeler cet attribut au lieu de passer directement par l'identificateur.

3. Importez les utilisateurs dans votre nouvelle instance du service.

   curl -X POST 'https://<region>.appid.cloud.ibm.com/management/v4/<tenantID>/cloud_directory/import?encryption_secret=mySecret'
   --header 'Content-Type: application/json'
   --header 'Accept: application/json'
   --header 'Authorization: Bearer <IAMToken>'
   -d '{"users": [
      {
         "scimUser": {
            "originalId": "3f3f6779-7978-4383-926f-a43aef3b724b",
            "name": {
            "givenName": "John",
            "familyName": "Doe",
            "formatted": "John Doe"
            },
            "displayName": "John Doe",
            "emails": [
            {
               "value": "user@example.com",
               "primary": true
            }
            ],
            "status": "PENDING"
         },
         "displayName": "Jane-Doe",
         "emails": [
            {
            "value": "jdoe@example.com",
            "primary": true
            }
         ],
         "status": "PENDING"
      },
      "passwordHash": "<passwordHashHere>",
      "passwordHashAlg": <passwordHashAlgorithm>,
      "profile": {
         "attributes": {}
      },
      "roles": []
      }
   ]}'
   

Script de migration pour les exportations et importations mineures

App ID fournit un script de migration que vous pouvez utiliser via l'interface CLI pour accélérer le processus de migration lorsque vous utilisez les noeuds finaux de l'API d'exportation ou d'importation. Sinon, pour rendre le processus de migration encore plus efficace, vous pouvez utiliser les noeuds finaux d'API export/all et import/all.

1. Clonez le référentiel.

git clone https://github.com/ibm-cloud-security/appid-sample-code-snippets/tree/master/export-import-cloud-directory-users.git

2. Dans le terminal, accédez au dossier dans lequel vous avez cloné le référentiel.

3. Exécutez la commande suivante.

   npm install
   

4. Exécutez la commande suivante avec vos paramètres.

   users_export_import 'sourceTenantId' 'destinationTenantId' 'region' 'iamToken'
   

   Description des paramètres

   Paramètre	Description
   sourceTenantId	ID titulaire de l'instance d'App ID à partir de laquelle vous prévoyez d'exporter des utilisateurs.
   destinationTenantId	ID titulaire de l'instance d'App ID vers laquelle vous prévoyez d'importer des utilisateurs.
   region	Reportez-vous à cette section sur les régions disponibles.
   IAM token	Pour obtenir de l'aide sur l'obtention d'un jeton IAM, consultez les documentations.

   Exemple de commande :

   users_export_import e00a0366-53c5-4fcf-8fef-ab3e66b2ced8 73321c2b-d35a-497a-9845-15c580fdf58c ng eyJraWQiOiIyMDE3MTAyNS0xNjoyNzoxMCIsImFsZyI6IlJTMjU2In0.eyJpYW1faWQiOiJJQk1pZC0zMTAwMDBUNkZTIiwiaWQiOiJJQk1pZC0zMTAwMDBUNkZTIiwicmVhbG1pZCI6IklCTWlkIiwiaWRlbnRpZmllciI6IjMxMDAwIFQ2RlMiPCJnaXZlbl9uYW1lIjoiUm90ZW0iLCJmYW1pbHlfbmFtZSI6IkJyb3NoIiwibmFtZSI6IlJvdGVtIEJyb3NoIiwiZW1haWwiOiJyb3RlbWJyQGlsLmlibS5jb20iLCJzdWIiOiJyb3RlbWJyQGlsLmlibS5jb20iLCJhY2NvdW50Ijp7ImJzcyI6ImQ3OWM5YTk5NjJkYzc2Y2JkMDZlYTVhNzhjMjY0YzE5In0sImlhdCI6MTUzNrE3Mjg4NCwiZXhwIjoxNTM3MTc2NDg0LCJpc3MiOiJodHRwczovL2lhbS5zdGFnZTEuYmx1ZW1peC5uZXQvaWRlbnRpdHkiLCJncmFudF90eXBlIjoidXJuOmlibTpwYXJhbXM6b2F1dGg6Z3JhbnQtdHlwZTpwYXNzY29kZSIsInNjb3BlIjoiaWJtIG9wZW5pZCIsImNsaWVudF9pZCI6ImJ4IiwiYWNyIjoxLCJhbXIiOlsicHdkIl19.c4vLPzhvvNZLjaLy7znDa37qV4o-yuGmSKmJoQKrEQNZU8IC0NIjxwSo7W9kb0pDi3Yf_03_9ufTTGNfjtltzNWycSXjkNgoL-b9_nU61oHdgn0stY1KmNicqyBWfgUU--4xa904QN_QjRHBaUBeJf3XWEphPIMoF7mZeOxEZLnCMcQXSz9pImCMiP4SNT38cHLiI90Yx01rM7hpteepWULh5MYh-B2V03Gkgxfqvv951HF1LDg6eT4Q9in11laTQKtKuomripUju_4GIIjORVYw9NaAVKIJ9lKrPX0SKPhStsa59qGsC_7Uersms5EY1W1VbZVqOZPJbtp6tVf-Lw