Skip to main content

InviteUserInput

Input for inviting a user to an organization

input InviteUserInput {
  email: String!
  firstName: String
  lastName: String
  redirectUrl: String
  role: String
}

Fields​

InviteUserInput.email ● String! non-null scalar​

Email address of the user to invite

InviteUserInput.firstName ● String scalar​

First name of the user (optional, used in invitation email)

InviteUserInput.lastName ● String scalar​

Last name of the user (optional, used in invitation email)

InviteUserInput.redirectUrl ● String scalar​

URL to redirect to after invitation acceptance (optional). Should include the organization path, e.g., "http://localhost:5173/organizations/{orgId}"

InviteUserInput.role ● String scalar​

Bare role name to grant the invitee on acceptance (optional; custom-roles feature). When omitted, the invitee gets the default viewer role. The inviting user must be authorized to assign this role (server-side anti-escalation); the acting user id is sourced from the authenticated session, never from client input.

Member Of​

inviteOrganizationUser mutation