すべてのユーザーのエクスポート

新しいインスタンスにプロファイルをインポートする前に、それらのプロファイルを元のサービス・インスタンスからエクスポートする必要があります。

多数のユーザー (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. エクスポートの準備ができたら、または要求が失敗すると、指定された E メール・アドレスに E メールが送信されます。 エクスポートをダウンロードするには、 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 に要求を送信することにより、エクスポートを手動で削除することを選択できます。

   export/allリクエストで提供する必要があるパラメータの説明

   パラメーター	説明
   encryptionSecret	ハッシュ処理されたユーザーのパスワードの暗号化と復号のために使用するカスタム・ストリング。 import/all API を使用するために必要な暗号化秘密鍵を保持します。 IBM はシークレットを保管しないため、シークレットが失われた場合は、エクスポートされたデータにアクセスできません。
   emailAddress	エクスポートの準備ができたとき、または要求が失敗した場合に E メールが送信される先の E メール・アドレス。
   expires	エクスポートを削除しなければならなくなるまでの日数を指定するために設定できる整数 (1 ≤ value ≤ 30)。 デフォルト値は7。
   tenantID	サービスのテナント ID はサービス資格情報の中にあります。 サービス認証情報は、 App ID ダッシュボードで検索または作成できます。

ユーザーの一括エクスポート

エクスポートエンドポイントは、約16,000ユーザー未満のマイナーエクスポートのために予約されています。 特定のテナント ID に関連付けられているすべての 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	サービスのテナント ID はサービス資格情報の中にあります。 サービス資格情報は、App ID ダッシュボードで確認できます。

   Cloud Directory のユーザーとそれらのユーザーのプロファイルのみが返されます。 他の ID プロバイダーのユーザーは返されません。

すべてのユーザーのインポート

エクスポートした Cloud Directory のユーザーのリストが作成されたら、それらを新しいインスタンスにインポートできます。 import-all APIエンドポイントを使用すると、1回のリクエストで相当数のユーザー（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	エクスポートの準備ができたとき、または要求が失敗した場合に E メールが送信される先の E メール・アドレス。
   tenantID	サービスのテナント ID はサービス資格情報の中にあります。 サービス認証情報は、 App ID ダッシュボードで検索または作成できます。
   file	export/download エンドポイントからの出力。

ユーザーの一括インポート

インポート API エンドポイントを使用して、小規模なユーザー・グループをインポートできます。 インポート API エンドポイントでは、要求ごとに最大 50 人のユーザーのみを追加できます。 単一の要求ですべてのユーザーを追加するには、 import/all API エンドポイントを使用します。

1. ユーザーに役割が割り当てられている場合は、App ID の新しいインスタンス内に役割とスコープを必ず作成してください。

   役割とスコープは、以前のインスタンス内にあるものと同じつづりを使用して、完全に一致するように作成する必要があります。

2. ユーザーは、新しい Cloud Directory 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 には、エクスポートまたはインポートの API エンドポイントを使用する際にマイグレーション・プロセスの高速化に役立つ、CLI で使用可能なマイグレーション・スクリプトが用意されています。 あるいは、マイグレーション・プロセスをさらに効率的にするために、 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