InviteInfoResponseDto

Example

JSON

{
  "email": "string",
  "intent": "activate",
  "first_name": "string",
  "last_name": "string",
  "app_name": "string",
  "inviter_email": "string",
  "sso_available": false
}

Properties

7 properties 6 required

email string Required

intent enum Required

What this invite does, and which form the SPA should render. `activate` creates a net-new identity — collect first name, last name, and a new password. `add_to_app` adds an existing identity to a new App — show 'sign in to confirm' UX and collect the user's existing password (verified server-side; not rotated). `password_reset` rotates the password on an existing identity — collect only the new password.

Enumactivateadd_to_apppassword_reset

first_name string Required

last_name string Required

app_name string Required

Display name of the App the recipient is being invited to. Used by the SPA to render welcome copy without a separate lookup.

inviter_email string Required

Email of the admin who issued the invite. Optional in the response — null when the inviter has been deleted.

nullable

sso_available boolean Optional

Admin invites only: true when the invite's Account has an active admin SSO connection covering the invitee's email domain. The SPA then accepts the invite password-less and sends the admin to SSO sign-in.

Was this page helpful?

Tell us how we can improve this guide.