Organizations

Queue emailed onboarding links for many IdP users

Classifies each requested user (up to 500) and queues an onboarding-link email for the sendable ones; a worker mints, emails and records each link shortly after, re-checking right before minting that the user has not enrolled meanwhile. Skipped users are reported with their reason: not_provisioned, no_recovery_email, already_enrolled, enrollment_unknown (identity could not be asked; skipped to fail closed), recently_sent (a link went out less than 7 days ago, unless resend_recent) or invalid_email. Returns 202 because queued users have not been emailed yet. Requires an organization administrator.

post/organizations/{organizationId}/idp-users/onboarding-links

Request

  • Base URL: https://api.xfa.tech
  • URL: https://api.xfa.tech/organizations/{organizationId}/idp-users/onboarding-links
  • Auth: HTTP bearer

Path parameters

organizationIdstring required

ID of Organization

Request body

emailsstring[] required
resend_recentboolean

Also queue users whose link was sent less than 7 days ago. Without it the worker also skips a user whose link went out less than 5 minutes before it runs (a duplicate send).

Response

Users classified; sendable ones queued

queuedinteger required

Users queued for an emailed onboarding link

Changes

No recorded changes to this operation across all 1 revision of this API.