1. Docs
  2. API Reference
  3. IdentityInviteResponseDto

IdentityInviteResponseDto

Example

JSON
{
  "id": "string",
  "email": "string",
  "intent": "activate",
  "first_name": "string",
  "last_name": "string",
  "name": "string",
  "role_id": "string",
  "node_id": "string",
  "node_name": "string",
  "organization_node_id": "string",
  "effective_from": "2026-04-20T12:00:00.000Z",
  "effective_to": "2026-04-20T12:00:00.000Z",
  "has_initial_assignment": false,
  "status": "pending",
  "expires_at": "2026-04-20T12:00:00.000Z",
  "invited_by": "string",
  "invited_by_identity_id": "string",
  "created_at": "2026-04-20T12:00:00.000Z"
}

Properties

18 properties 11 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
node_name string Optional

The name of the node at `node_id`, when it has one.

nullable
organization_node_id string Optional

The organization the invitation joins, when `node_id` is an organization node or sits beneath one.

nullable
effective_from string Optional

When the role it grants starts to count.

format: date-timenullable
effective_to string Optional

When the role it grants stops counting.

format: date-timenullable
has_initial_assignment boolean Required
status enum Required
Enumpendingacceptedrevokedexpired
expires_at string Required
format: date-time
invited_by string Required
invited_by_identity_id string Optional

The customer's own administrator who sent it with their identity token; `invited_by` names a platform user instead.

nullable
created_at string Required
format: date-time
Was this page helpful?

Tell us how we can improve this guide.

Canopy