Preview

UserInvitationInput is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

UserInvitationInput

Invitee details supplied when inviting users or accepting an invitation. inviteUsers sends email, firstName, lastName, role, and externalIdentifier. title, locale, and password are sent only when accepting an invitation.

This page contains

    Fields

    firstName String

    Given name of the invitee.

    lastName String

    Family name of the invitee.

    title String

    Job title of the invitee. Sent only when accepting an invitation.

    locale Locale

    Locale for the invitee. Sent only when accepting an invitation.

    email EmailAddress

    Email address of the invitee.

    role String

    Role assigned to the invitee.

    password String

    Password for the invitee. Sent only when accepting an invitation.

    externalIdentifier String

    External identifier for the invitee. Used when usesExternalIds is true.