preregister_users#

nominal.experimental.migration.preregister_users(client: NominalClient, emails: Sequence[str]) → Mapping[str, User]#

Preregister users for stack migrations before their first login.

This is intended for migration workflows that need destination-tenant user RIDs ahead of login so migrated resources can preserve created_by attribution.

Parameters:

  • client – Destination tenant client. The caller must be an org admin in that tenant.

  • emails – Email addresses to preregister. Accepts at most 1000 emails per request.

Returns:

A mapping from email address to newly created user details. Emails that already belong to existing accounts are omitted from the response.

Raises:

NominalError – If the preregistration request fails, including when the caller is not an org admin or more than 1000 emails are given.