invite_user

Invite a user to the tenant by email. Requires Owner role. role must be one of: owner, editor, viewer (default: viewer). Returns: invite_id (str) — UUID of the new invitation; email (str) — invitee’s email address; role (str) — assigned role; status (str) — always ‘pending’ until the invitee accepts. Requires Pro plan.

Parameters

Name	Type	Required	Default	Description
email	str	Yes	—
role	str	No	'viewer'

Returns

Returns a structured object. Top-level fields:

• invite_id (string)
• email (string)
• role (string)
• status (string)

See the response example below for the full payload shape.

Example

Tool Call

{
  "name": "invite_user",
  "arguments": {
    "email": "carol@example.com",
    "role": "viewer"
  }
}

Response

{
  "invite_id": "55555555-5555-5555-5555-555555555555",
  "email": "carol@example.com",
  "role": "viewer",
  "status": "pending"
}

Notes

• Module: Admin
• Requires authentication via API token or Auth0 JWT.