모든 사용자 내보내기

프로파일을 새 인스턴스로 가져오려면 먼저 서비스의 원래 인스턴스에서 해당 프로파일을 내보내야 합니다.

많은 사용자 (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와 연관된 모든 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 사용자 목록이 있으므로 사용자를 새 인스턴스로 가져올 수 있습니다. 가져오기-모두 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	서비스 인증 정보에서 찾을 수 있는 서비스 테넌트 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를 통해 사용할 수 있는 마이그레이션 스크립트를 제공합니다. 또는 반출/모두 및 반입/모두 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