1. Docs
  2. API Reference
  3. InviteInfoResponseDto

The InviteInfoResponseDto object

Example

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

Properties

  • emailstring*
  • intentenum: "activate" | "add_to_app" | "password_reset"*

    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.

  • first_namestring*
  • last_namestring*
  • app_namestring*

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

  • inviter_emailstring*

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