The pendingUsers() GraphQL query will return the pending user.

For more information on user authorization, see the Managing Users & Permissions documentation page.

Syntax

Below is the syntax for the pendingUsers() query field: 

pendingUsers(search: string): [PendingUser!]!

Given Datatypes

For the given datatype, PendingUser, there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: PendingUser

ParameterTypeRequired[a]DefaultDescription
idstringyes The identifier or token for the pending user.
idpbooleanyes Whether IDP is enabled for the organization.
createdAtlongyes The time the pending user was created.
invitedByEmailstringyes The email address of the user that invited the pending user.
invitedByNamestringyes The name of the user that invited the pending user.
orgNamestringyes The name of the organization the the pending user is about to join.
newUserEmailstringyes The email of the pending user.
pendingUserStatePendingUserStateyes The current organization state for the user (see PendingUserState Table).

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.