| API Stability |
Long-Term
|
The pendingUsers() GraphQL query will return the pending users.
For more information on user authorization, see the Manage users & permissions documentation page.
Syntax
Below is the syntax for the pendingUsers() query field:
graphql
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
| Parameter | Type | Required | Default | Stability | Description |
|---|---|---|---|---|---|
| Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column. | |||||
| Table last updated: Mar 26, 2025 | |||||
createdAt | long | yes | Long-Term | The time the pending user was created. | |
id | string | yes | Long-Term | The identifier or token for the pending user. | |
idp | boolean | yes | Long-Term | Whether IdP is enabled for the organization. | |
invitedByEmail | string | yes | Long-Term | The email address of the user that invited the pending user. | |
invitedByName | string | yes | Long-Term | The name of the user that invited the pending user. | |
newUserEmail | string | yes | Long-Term | The email of the pending user. | |
orgName | string | yes | Long-Term | The name of the organization for the pending user. | |
pendingUserState | PendingUserState | yes | Long-Term | The current organization state for the user. See PendingUserState. | |