Alle Benutzer exportieren

Bevor Sie Ihre Profile in Ihre neue Instanz importieren können, müssen Sie sie aus Ihrer ursprünglichen Instanz exportieren.

Wenn Sie viele Benutzer (16.000 oder mehr) exportieren, können Sie den export/all-API-Endpunkt verwenden.

1. Exportieren Sie alle Benutzer aus Ihrer ursprünglichen Instanz des Dienstes.

   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. Rufen Sie den Status Ihrer Anforderung nach Bedarf ab.

   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. Wenn der Export bereit ist oder die Anforderung fehlschlägt, wird eine E-Mail an die angegebene E-Mail-Adresse gesendet. Verwenden Sie zum Herunterladen des Exports die 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>'
   

   Eine Exportdatei wird nur erstellt, wenn die Exportanforderung erfolgreich ist. Wenn die Anforderung fehlschlägt, werden die erfassten Daten gelöscht, um Ihr Schwachstellenrisiko zu reduzieren. Der Export wird automatisch nach 7 Tagen oder nach der Anzahl der Tage gelöscht, die Sie im Hauptteil der Anforderung angeben (im Bereich von 1 bis 30 Tagen). Sie können den Export manuell löschen, indem Sie eine Anforderung an die API delete senden.

   Beschreibungen der Parameter, die in der export/all-Anfrage angegeben werden müssen

   Parameter	Beschreibung
   encryptionSecret	Eine angepasste Zeichenfolge, die zur Ver- und Entschlüsselung eines hashverschlüsselten Benutzerkennworts verwendet wird. Behalten Sie den geheimen Verschlüsselungsschlüssel bei Bedarf bei, um die API import/all zu verwenden. IBM speichert den geheimen Schlüssel nicht. Wenn der geheime Schlüssel also verloren geht, können Sie nicht auf die exportierten Daten zugreifen.
   emailAddress	Eine E-Mail-Adresse, an die eine E-Mail gesendet wird, wenn der Export bereit ist oder die Anforderung fehlschlägt.
   expires	Eine ganze Zahl, die Sie festlegen können (1 ≤ Wert ≤ 30), um die Anzahl der Tage anzugeben, nach denen der Export gelöscht werden muss. Der Standardwert beträgt 7.
   tenantID	Die Service-Tenant-ID ist in Ihren Serviceberechtigungsnachweisen enthalten. Sie können Ihre Dienstanmeldedaten im App ID Dashboard finden oder erstellen.

Exportieren von Benutzern in Stapeln

Der Export-Endpunkt ist für kleinere Exporte von weniger als 16.000 Benutzern reserviert. Zum Exportieren aller Cloud Directory-Benutzer, die einer bestimmten Tenant-ID zugeordnet sind, verwenden Sie den API-Endpunkt export/all.

1. Exportieren Sie die Benutzer aus Ihrer ursprünglichen Instanz des Service.

   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>'
   

   Beschreibungen der Parameter, die in der Exportanfrage angegeben werden müssen

   Parameter	Beschreibung
   encryptionSecret	Eine angepasste Zeichenfolge, die zur Ver- und Entschlüsselung eines hashverschlüsselten Benutzerkennworts verwendet wird.
   tenantID	Die Service-Tenant-ID ist in Ihren Serviceberechtigungsnachweisen enthalten. Sie finden Ihre Serviceberechtigungsnachweise im App ID-Dashboard.

   Nur Ihre Cloud Directory-Benutzer und deren Profile werden zurückgegeben. Für die Benutzer anderer Identitätsprovider gilt dies nicht.

Alle Benutzer importieren

Nachdem Sie nun eine Liste der exportierten Cloud-Directory-Benutzer haben, können Sie sie in die neue Instanz importieren. Sie können den API-Endpunkt import-all verwenden, um eine große Anzahl von Benutzern (16.000 oder mehr) mit einer einzigen Anfrage zu importieren.

1. Importieren Sie die Liste der exportierten Benutzer, die Sie heruntergeladen haben.

   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. Rufen Sie den Status Ihrer Anforderung nach Bedarf ab.

   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>'
   

   Beschreibungen der Parameter, die in der Import/All-Anfrage angegeben werden müssen

   Parameter	Beschreibung
   encryptionSecret	Eine angepasste Zeichenfolge, die zur Ver- und Entschlüsselung eines hashverschlüsselten Benutzerkennworts verwendet wird. Der geheime Verschlüsselungsschlüssel ist derselbe geheime Schlüssel, den Sie der API export/all zugeordnet haben. IBM speichert den geheimen Schlüssel nicht. Wenn der geheime Schlüssel also verloren geht, können Sie nicht auf die exportierten Daten zugreifen.
   emailAddress	Eine E-Mail-Adresse, an die eine E-Mail gesendet wird, wenn der Export bereit ist oder die Anforderung fehlschlägt.
   tenantID	Die Service-Tenant-ID ist in Ihren Serviceberechtigungsnachweisen enthalten. Sie können Ihre Dienstanmeldedaten im App ID Dashboard finden oder erstellen.
   file	Die Ausgabe vom Endpunkt export/download.

Importieren von Benutzern in Stapeln

Sie können den Import-API-Endpunkt verwenden, um einige Benutzer auf einmal zu importieren. Mit dem Import-API-Endpunkt können Sie bis zu 50 Benutzer pro Anforderung hinzufügen. Um alle Benutzer über eine einzige Anforderung hinzuzufügen, verwenden Sie den API-Endpunkt import/all.

1. Wenn Ihren Benutzern Rollen zugewiesen wurden, müssen Sie die Rollen und Bereiche in Ihrer neuen Instanz von App ID erstellen.

   Die Rollen und Bereiche müssen genau so und mit derselben Schreibweise wie in der vorherigen Instanz erstellt werden.

2. Benutzer werden mit einer neuen Cloud Directory-ID importiert. Wenn Ihre App in irgendeiner Weise auf die Cloud-Directory-ID verweist, können Sie ein angepasstes Attribut erstellen und Ihre Anwendung so anpassen, dass sie das Attribut und nicht direkt die ID aufruft.

3. Importieren Sie die Benutzer in Ihre neue Instanz des 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": []
      }
   ]}'
   

Migrationsskript für kleinere Exporte und Importe

App ID stellt ein Migrationsscript zur Verwendung in der Befehlszeilenschnittstelle bereit, mit dem Sie den Migrationsprozess beschleunigen können, wenn Sie die API-Endpunkte 'export' oder 'import' verwenden. Alternativ können Sie den Migrationsprozess noch effizienter gestalten, indem Sie die API-Endpunkte export/all und import/all verwenden.

1. Klonen Sie das Repository.

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

2. Wechseln Sie im Terminal zu dem Ordner, in den Sie das Repository geklont haben.

3. Führen Sie den folgenden Befehl aus.

   npm install
   

4. Führen Sie den folgenden Befehl mit Ihren Parametern aus.

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

   Parameterbeschreibungen

   Parameter	Beschreibung
   sourceTenantId	Die Tenant-ID der Instanz von App ID, aus der Sie Benutzer exportieren wollen.
   destinationTenantId	Die Tenant-ID der Instanz von App ID, in die Sie Benutzer exportieren wollen.
   region	Weitere Informationen zu den verfügbaren Regionen.
   IAM token	Hilfe bei der Beschaffung eines IAM-Tokens finden Sie in den Dokumentationen.

   Beispielbefehl:

   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