1. Docs
  2. API Reference
  3. InviteInfoResponseDto

InviteInfoResponseDto

Example

JSON
{
  "email": "string",
  "intent": "activate",
  "organization_name": "string",
  "node_name": "string",
  "role_name": "string",
  "effective_from": "2026-04-20T12:00:00.000Z",
  "effective_to": "2026-04-20T12:00:00.000Z",
  "inviter_name": "string",
  "proof_methods": [
    "password"
  ],
  "first_name": "string",
  "last_name": "string",
  "app_name": "string",
  "inviter_email": "string",
  "sso_available": false
}

Properties

14 properties 7 required

email string Required
intent enum Required

What this invite does, and which form to render. `activate` creates a net-new identity: collect first name, last name, and a new password. `add_to_app` adds an existing identity to this Environment: collect the existing password (checked, never changed), or accept with the invitee's bearer token. `grant` asks someone already in this Environment to join another organization: accepting is their consent, proven by password or by the bearer token, as `proof_methods` allows. `password_reset` rotates the password on an existing identity: collect only the new password.

Enumactivateadd_to_appgrantpassword_reset
organization_name string Optional

The organization the invitation joins, or null.

nullable
node_name string Optional

The office or team beneath the organization the role is held at; null at the organization itself.

nullable
role_name string Optional

The role the invitation grants; null for a membership with no role.

nullable
effective_from string Optional

When the role starts to count.

format: date-timenullable
effective_to string Optional

When the role stops counting.

format: date-timenullable
inviter_name string Optional

The sender's name: the organization's administrator, or the platform user who sent it.

nullable
proof_methods array of enum Required

How the invitee may prove they control the invited identity: `password` (the existing one, sent as `password`) and `session` (the invitee's identity access token, sent as `Authorization: Bearer`). Empty for `password_reset`. Password is left out when the identity has none, has a second factor enrolled, or joins an organization that does not allow password sign-in.

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.

Canopy