导出所有用户

在将概要文件导入到新实例之前，需要从服务的原始实例中导出这些概要文件。

如果要导出许多用户 (16,000 或更多)，那么可以使用 export/all API 端点。

1. 从服务的原始实例中导出所有用户。

   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. 根据需要获取请求的状态。

   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. 当导出就绪或请求失败时，将向提供的电子邮件地址发送电子邮件。 要下载导出，请使用 export/download API。

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

   仅当导出请求成功时，才会创建导出文件。 如果请求失败，为降低漏洞风险，将删除所收集的数据。 导出将在 7 天后或您在请求主体中指定的天数 (在 1-30 天的范围内) 自动删除。 您可以选择通过向 delete API 发送请求来手动删除导出。

   导出/全部请求中需要提供的参数说明

   参数	描述
   encryptionSecret	用于加密和解密用户散列密码的定制字符串。 根据需要保留加密密钥以使用 import/all API。 IBM 不会存储私钥，因此如果私钥丢失，那么您无法访问导出的数据。
   emailAddress	导出就绪或请求失败时要向其发送电子邮件的电子邮件地址。
   expires	可以设置的整数 (1 ≤ 值 ≤ 30)，用于指定必须删除导出的天数。 默认值为 7。
   tenantID	可以在服务凭证中找到的服务租户标识。 您可以在 App ID 控制面板中查找或创建服务证书。

批量导出用户

导出端点是为大约少于 16 000 个用户的小规模导出保留的。 要导出与特定租户标识关联的所有 Cloud Directory 用户，请使用 export/all API 端点。

1. 从服务的原始实例中导出用户。

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

   出口请求中需要提供的参数说明

   参数	描述
   encryptionSecret	用于加密和解密用户散列密码的定制字符串。
   tenantID	可以在服务凭证中找到的服务租户标识。 您可以在 App ID 仪表板中找到服务凭证。

   仅会返回 Cloud Directory 用户及其概要文件。 不会返回其他身份提供者的用户。

正在导入所有用户

现在，您已拥有导出的 Cloud Directory 用户列表，可以将这些用户导入到新实例中。 您可以使用 import-all API 端点，通过单次请求导入大量用户（16,000 或更多）。

1. 导入您下载的已导出用户的列表。

   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. 根据需要获取请求的状态。

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

   导入/导出所有数据请求中需要提供的参数说明

   参数	描述
   encryptionSecret	用于加密和解密用户散列密码的定制字符串。 加密密钥与您附加到 export/all API 的密钥相同。 IBM 不会存储私钥，因此如果私钥丢失，那么您无法访问导出的数据。
   emailAddress	导出就绪或请求失败时要向其发送电子邮件的电子邮件地址。
   tenantID	可以在服务凭证中找到的服务租户标识。 您可以在 App ID 控制面板中查找或创建服务证书。
   file	export/download 端点的输出。

分批导入用户

您可以使用导入 API 端点来导入小组用户。 通过导入 API 端点，每个请求最多只能添加 50 个用户。 要通过单个请求添加所有用户，请使用 import/all API 端点。

1. 如果为用户分配了 角色，请确保在 App ID的新实例中创建角色和作用域。

   必须创建的角色和作用域与先前实例中具有相同拼写的角色和作用域完全相同。

2. 将使用新的 Cloud Directory 标识导入用户。 如果应用程序以任何方式引用 Cloud Directory 标识，那么您可以选择创建定制属性并调整应用程序以直接调用该属性而不是该标识。

3. 将用户导入到服务的新实例。

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

小规模出口和进口的迁移脚本

App ID 提供了一个迁移脚本，您可以通过 CLI 使用该脚本来帮助在使用导出或导入 API 端点时加快迁移过程。 或者，要使迁移过程更高效，可以使用 export/all 和 import/all API 端点。

1. 克隆 存储库。

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

2. 在终端中，切换到在其中克隆了存储库的文件夹。

3. 运行以下命令。

   npm install
   

4. 使用您的参数运行以下命令：

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

   参数描述

   参数	描述
   sourceTenantId	计划从中导出用户的 App ID 实例的租户标识。
   destinationTenantId	计划将用户导入其中的 App ID 实例的租户标识。
   region	了解有关 可用区域 的更多信息。
   IAM token	有关获取 IAM 令牌的帮助，请查看 文档。

   示例命令：

   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