ApiIdentityInviteResponseDto

Example

JSON

{
  "id": "string",
  "email": "string",
  "intent": "activate",
  "first_name": "string",
  "last_name": "string",
  "name": "string",
  "role_id": "string",
  "node_id": "string",
  "environment_id": "string",
  "environment_name": "string",
  "has_initial_assignment": false,
  "status": "pending",
  "expires_at": "2026-04-20T12:00:00.000Z",
  "invited_by": "string",
  "created_at": "2026-04-20T12:00:00.000Z",
  "accept_url": "string"
}

Properties

16 properties 12 required

id string Required

email string Required

intent enum Required

Final intent stamped on the invite at create time. `activate` is the auto-derived default for net-new identities; `add_to_app` is auto-derived when the email matches an existing account-level identity that has no membership in this App; `password_reset` is admin-explicit. `onboard` may appear on rows created before the rename.

Enumactivateadd_to_apppassword_resetonboard

first_name string Required

last_name string Required

name string Required

role_id string Optional

nullable

node_id string Optional

nullable

environment_id string Optional

Environment the invite targets, or null for a directory-only (account-tier) invite created with the Environment field left empty.

nullable

environment_name string Optional

Display name of the target Environment, or null for a directory-only invite.

nullable

has_initial_assignment boolean Required

status enum Required

Enumpendingacceptedrevokedexpired

expires_at string Required

format: date-time

invited_by string Required

created_at string Required

format: date-time

accept_url string Required

Tokenized URL the invitee would land on. Returned so callers that pass send_email=false can deliver it themselves.

Was this page helpful?

Tell us how we can improve this guide.