This endpoint is used to update the externalSystemsMapping array in the NI user record. This endpoint will only be able to access the external system that they have access to. Calls to this endpoint will be handled by checking the client setting to the external system ID, and then checking the user record, only allowing access to that entry.

📘

Note: The migration_type field in the response indicates the migration status of the user record from the external system, either through a JIT migration or through a manual or scripted input of the external ID):

  • migrated: The user's record was created by migrating from the home system.
  • sustained: The user's record existed in the local IDP, no changes were made to the user record when the external ID was added during migration.
  • updated: The user's record existed in the local IDP, user record values (other than external ID) were updated with with the external system ID was migrated in.
Language
Credentials
Bearer
URL
Click Try It! to start a request and see the response here!