匯出所有使用者

您需要先從服務的原始實例匯出設定檔，然後才能將設定檔匯入至新實例。

如果您要匯出許多使用者 (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	可在您的服務認證中找到服務承租戶 ID。 您可以在 App ID 面板中找到或建立服務憑證。

分批匯出使用者

匯出端點預留給約少於 16,000 位使用者的次要匯出。 若要匯出與特定租戶 ID 相關聯的所有「雲端目錄」使用者，請使用 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	可在您的服務認證中找到服務承租戶 ID。 您可以在 App ID 儀表板中找到您的服務認證。

   只會傳回您的「雲端目錄」使用者及其設定檔。 不會傳回其他身分提供者的使用者。

匯入所有使用者

既然您具有已匯出「雲端目錄」使用者的清單，則可以將它們匯入至新實例。 您可以使用匯入全部 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>'
   

   import/all請求中需要提供的參數說明

   參數	說明
   encryptionSecret	用來加密及解密使用者雜湊式密碼的自訂字串。 加密密鑰是您連接至 export/all API 的相同密鑰。 IBM 不會儲存密鑰，因此如果密鑰遺失，則您無法存取匯出的資料。
   emailAddress	當匯出備妥或要求失敗時，電子郵件傳送至的電子郵件位址。
   tenantID	可在您的服務認證中找到服務承租戶 ID。 您可以在 App ID 面板中找到或建立服務憑證。
   file	來自 export/download 端點的輸出。

分批匯入使用者

您可以使用匯入 API 端點一次匯入幾個使用者。 使用匯入 API 端點，每個要求最多只能新增 50 個使用者。 若要透過單一要求新增所有使用者，請使用 import/all API 端點。

1. 如果您的使用者已 獲指派角色，請務必在新的 App ID實例中建立角色和範圍。

   角色和範圍的建立必須與前一個實例中具有相同拼字的角色和範圍完全相同。

2. 使用新的「雲端目錄」ID 匯入使用者。 如果您的應用程式以任何方式參照 Cloud Directory ID，您可以選擇建立自訂屬性，並調整應用程式以直接呼叫屬性而非 ID。

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 使用的移轉 Script，當您使用匯出或匯入 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 實例的承租戶 ID。
   destinationTenantId	您計劃將使用者匯入其中之 App ID 實例的承租戶 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