How to export Portal Delegated User Registry user information

From IBM® API Connect Version 5.0.8.7 onwards, if your Developer Portal uses Portal Delegated User Registry, you can export the user information that is stored in the Developer Portal local database.

Before you begin

You must have administrator access to complete this task.

Note: The ability to migrate Portal Delegated User Information is available only from IBM API Connect Version 5.0.8.7 onwards. If your deployment is at an earlier version, you must upgrade to Version 5.0.8.7 or later before migrating. See Upgrading your API Connect cloud for information about upgrading in Version 5.

About this task

When Portal Delegated User Registry (PDUR) is selected for a Catalog, the user management is delegated from the management server to the Developer Portal. In this instance, if you want to migrate users from an IBM API Connect Version 5 Developer Portal, to an IBM API Connect Version 2018 Developer Portal, you must export the user information that is stored in the Developer Portal local database. This information can then be used by the migration tooling to migrate the PDUR user registry.

The following two methods can be used for exporting the PDUR user information:

You can use the Developer Portal UI to export the PDUR user information on a per site basis into a .json user-mapping file. If you have more than one site, before the user information can be used by the migration tooling you must manually combine the .json files into one compressed pdurexport.tgz file.
You can use a Developer Portal CLI command to export the PDUR user information for all of the sites on a Developer Portal server into a pdurexport.tgz file. This compressed file will contain all of the .json user-mapping files for that server.

Each .json file contains a list of all of the PDUR user information that's stored in the Developer Portal local database. The user information for all of the user registration methods that are used in the specific Developer Portal are included in the same file. For example, local user registry, LDAP user registry, third-party authentication, OpenID Connect, and any custom user registration method.

Note: User-mapping files must not be edited, or the migration may not complete successfully.

Procedure

The following instructions show you how to export the PDUR user information on a per site basis by using the Developer Portal UI.
1. In the Developer Portal UI, click People > Export.
  The Export configuration window is displayed.
2. Complete the Filename to save as field (you can accept the default file name if preferred).
3. Optional: If you have a large number of user accounts, you can click Advanced Settings and update the export settings that are suitable for your server configuration.
4. Click Download File and download the .json file to your preferred location.
5. Optional: If you have more than one site, you must export the PDUR user information for each site, and then compress all of the .json files into one pdurexport.tgz file.
The following instructions show you how to export the Portal Delegated User Registry user information for all of the sites on a Developer Portal server by using the CLI.
1. Log in to the Developer Portal CLI.
2. Run the following command:
```
pdur_user_export
```
  The status of the export is displayed, for example:
```
admin@apimxxx123:~$ pdur_user_export
portal123.company.com/api-provider/production: Exporting pdur users
portal123.company.com/api-provider/preprod: Exporting pdur users
portal123.company.com/api-provider/uat: Exporting pdur users
portal123.company.com/api-provider/development: Skipping as not a pdur enabled site
portal123.company.com/api-provider/sandbox: Skipping as not a pdur enabled site
~/pdurexport ~
5c20b903e4b0485cbbd81775.5c20bf43e4b0485cbbd81795.json
5c20b903e4b0485cbbd81775.5c2cddbae4b0485cbbd818a0.json
5c20b903e4b0485cbbd81775.5c335211e4b0485cbbd8196e.json
~
Output can be found in /home/admin/pdurexport.tgz
```
  Note that if a site doesn't contain any PDUR data, that site is skipped. The naming convention used for the individual user-mapping files is provider_org_id.catalog_id.json. So the above example output shows that there was one provider organization on the server, and that organization had five Developer Portal sites, three of which contained PDUR user information.
  The PDUR user information for all of the sites on the server is exported into a pdurexport.tgz file.

What to do next

You can use the tooling in V2018 to migrate your PDUR user information. For more information about migration, see Migrating a Version 5 deployment to Version 2018 and Migrating your Developer Portal from Version 5 to Version 2018.