Exportación de todos los usuarios

Antes de importar sus perfiles a la nueva instancia, tiene que exportarlos desde la instancia original del servicio.

Si está exportando muchos usuarios (16.000 o más), puede utilizar el punto final de la API de export/all.

1. Exporte todos los usuarios de su instancia original del servicio.

   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. Obtenga el estado de su solicitud, según sea necesario.

   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. Cuando la exportación está lista o si la solicitud falla, se envía un correo electrónico a la dirección de correo electrónico proporcionada. Para descargar la exportación, utilice la 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>'
   

   Sólo se crea un archivo de exportación cuando la solicitud de exportación es satisfactoria. Si la solicitud falla, para reducir el riesgo de vulnerabilidad, se suprimen los datos recopilados. La exportación se suprime automáticamente después de 7 días o el número de días que especifique en el cuerpo de la solicitud (en el rango de 1 a 30 días). Puede optar por suprimir manualmente la exportación enviando una solicitud a la API delete.

   Descripciones de los parámetros que deben proporcionarse en la solicitud export/all

   Parámetros	Descripción
   encryptionSecret	Una serie personalizada que se utiliza para cifrar y descifrar la contraseña oculta de un usuario. Conserve el secreto de cifrado según sea necesario para utilizar la API import/all. IBM no almacena el secreto, por lo que si se pierde el secreto, no puede acceder a los datos exportados.
   emailAddress	Una dirección de correo electrónico a la que se envía un correo electrónico cuando la exportación está lista o si la solicitud falla.
   expires	Un entero que puede establecer (1 ≤ valor ≤ 30) para especificar el número de días después de los cuales se debe suprimir la exportación. El valor por defecto es 7.
   tenantID	El ID de arrendatario de servicio se puede encontrar en las credenciales de servicio. Puede encontrar o crear sus credenciales de servicio en el panel App ID.

Exportar usuarios por lotes

El punto final de exportación está reservado para exportaciones menores de aproximadamente menos de 16.000 usuarios. Para exportar todos los usuarios de Cloud Directory que están asociados con un ID de arrendatario específico, utilice el punto final de API export/all.

1. Exporte los usuarios desde la instancia original del servicio.

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

   Descripciones de los parámetros que deben facilitarse en la solicitud de exportación

   Parámetros	Descripción
   encryptionSecret	Una serie personalizada que se utiliza para cifrar y descifrar la contraseña oculta de un usuario.
   tenantID	El ID de arrendatario de servicio se puede encontrar en las credenciales de servicio. Encontrará las credenciales de servicio en el panel de control de App ID.

   Solo se devuelven los usuarios del directorio en la nube y sus perfiles. Los usuarios de otros proveedores de identidad no.

Importación de todos los usuarios

Ahora que tiene una lista de usuarios de Cloud Directory exportados, puede importarlos en la instancia nueva. Puede utilizar el punto final de la API import-all para importar un número considerable de usuarios (16.000 o más) con una sola solicitud.

1. Importe la lista de usuarios exportados que ha descargado.

   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. Obtenga el estado de su solicitud, según sea necesario.

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

   Descripciones de los parámetros que deben proporcionarse en la solicitud de importación/todos

   Parámetros	Descripción
   encryptionSecret	Una serie personalizada que se utiliza para cifrar y descifrar la contraseña oculta de un usuario. El secreto de cifrado es el mismo secreto que ha adjuntado a la API export/all. IBM no almacena el secreto, por lo que si se pierde el secreto, no puede acceder a los datos exportados.
   emailAddress	Una dirección de correo electrónico a la que se envía un correo electrónico cuando la exportación está lista o si la solicitud falla.
   tenantID	El ID de arrendatario de servicio se puede encontrar en las credenciales de servicio. Puede encontrar o crear sus credenciales de servicio en el panel App ID.
   file	La salida del punto final export/download.

Importar usuarios por lotes

Puede utilizar el punto final de la API de importación para importar grupos pequeños de usuarios. Puede añadir hasta 50 usuarios por solicitud con el punto final de la API de importación. Para añadir todos los usuarios a través de una sola solicitud, utilice el punto final de API import/all.

1. Si los usuarios tienen roles asignados, asegúrese de crear los roles y los ámbitos en su instancia nueva de App ID.

   Los roles y los ámbitos se tienen que crear exactamente tal como estaban en la instancia anterior con la misma ortografía.

2. Los usuarios se importan con un nuevo identificador de Cloud Directory. Si la app hace referencia al identificador de Cloud Directory de alguna manera, puede optar por crear un atributo personalizado y ajustar la aplicación para que llame al atributo en lugar del identificador directamente.

3. Importe los usuarios a la nueva instancia de servicio.

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

Script de migración para exportaciones e importaciones menores

App ID proporciona un script de migración que puede utilizar a través de la CLI que puede ayudar a acelerar el proceso de migración cuando utiliza los puntos finales de API de exportación o importación. De forma alternativa, para que el proceso de migración sea aún más eficiente, puede utilizar los puntos finales de API export/all e import/all.

1. Clone el repositorio.

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

2. En el terminal, vaya a la carpeta a la que ha clonado el repositorio.

3. Ejecute el mandato siguiente.

   npm install
   

4. Con los parámetros, ejecute el mandato siguiente.

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

   Descripciones de los parámetros

   Parámetro	Descripción
   sourceTenantId	El ID de arrendatario de la instancia de App ID desde la que va a exportar usuarios.
   destinationTenantId	El ID de arrendatario de la instancia de App ID desde la que va a importar usuarios.
   region	Obtenga más información sobre las regiones disponibles.
   IAM token	Para obtener ayuda sobre cómo obtener una señal de IAM, consulte los documentos.

   Mandato de ejemplo:

   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