Skip to main content

Invite

Invite represents a given User that is pending registration that has been invited by an Administrator.

type Invite {
  id: ID!
  email: String!
  role: USER_ROLE!
  createdBy: User!
  createdAt: Time!
}

Fields​

Invite.id ● ID! non-null scalar​

id is the identifier for the Invite.

Invite.email ● String! non-null scalar​

email is the email address that will be assigned and used for the invited User.

Invite.role ● USER_ROLE! non-null enum​

role is the USER_ROLE that the User will be assigned upon account creation.

Invite.createdBy ● User! non-null object​

createdBy is the User that created the Invite.

Invite.createdAt ● Time! non-null scalar​

createdAt is the time that the Invite was created on.

Member Of​

InviteUsersPayload object