1. Docs
  2. API Reference
  3. IdentityInviteResponseDto

The IdentityInviteResponseDto object

Example

{
  "id": "string",
  "email": "string",
  "intent": "activate",
  "first_name": "string",
  "last_name": "string",
  "name": "string",
  "role_id": "string",
  "node_id": "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"
}

Properties

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

    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.

  • first_namestring*
  • last_namestring*
  • namestring*
  • role_idstring
  • node_idstring
  • has_initial_assignmentboolean*
  • statusenum: "pending" | "accepted" | "revoked" | "expired"*
  • expires_atstring (date-time)*
  • invited_bystring*
  • created_atstring (date-time)*