Authgear
Start BuildingHomePortalCommunity
  • Authgear Overview
  • Get Started
    • Start Building
    • 5-Minute Guide
    • Single-Page App
      • JavaScript (Web)
      • React
      • Angular
      • Vue
    • Native/Mobile App
      • iOS SDK
      • Android SDK
        • Android Kotlin coroutine support
        • Android OKHttp Interceptor Extension (Optional)
      • Flutter SDK
      • React Native SDK
      • Ionic SDK
      • Xamarin SDK
      • Using Authgear without SDK (Client side)
    • Regular Web App
      • Express
      • Next.js
      • Python Flask App
      • Java Spring Boot
      • ASP.NET Core MVC
      • Laravel
      • PHP
    • Backend/API Integration
      • Validate JWT in your application server
      • Forward Authentication to Authgear Resolver Endpoint
    • AI Coding tools
      • Cursor/Windsurf
  • How-To Guides
    • Authenticate
      • Add Passkeys Login
      • Add WhatsApp OTP Login
      • Add Email Magic Link Login
      • Add Biometric Login
      • Add Anonymous Users
      • Add authentication to any web page
      • Enable Two-Factor Authentication (2FA)
      • How to Use the OAuth 2.0 State Parameter
      • Reauthentication
      • How to Use Social/Enterprise Login Providers Without AuthUI
      • Passwordless Login for Apple App Store Review
      • Setup local development environment for Cookie-based authentication
      • Forgot/Reset Password settings
      • Phone number validation
      • Set Password Expiry
    • Single Sign-on
      • App2App Login
      • Pre-authenticated URLs
      • SSO between Mobile Apps / Websites
      • Force Authgear to Show Login Page
      • Single Sign-On with OIDC
      • Single Sign-On with SAML
        • Use Authgear as SAML Identity Provider for Salesforce
        • Use Authgear as SAML Identity Provider for Dropbox
        • SAML Attribute Mapping
    • Social Login / Enterprise Login Providers
      • Social Login Providers
        • Connect Apps to Apple
        • Connect Apps to Google
        • Connect Apps to Facebook
        • Connect Apps to GitHub
        • Connect Apps to LinkedIn
        • Connect Apps to WeChat
      • Enterprise Login Providers
        • Connect Apps to Azure Active Directory
        • Connect Apps to Microsoft AD FS
        • Connect Apps to Azure AD B2C
      • Force Social/Enterprise Login Providers to Show Login Screen
    • Built-in UI
      • Branding in Auth UI
      • User Settings
      • Privacy Policy & Terms of Service Links
      • Customer Support Link
      • Custom Text
    • Custom UI
      • Authentication Flow API
      • Implement Authentication Flow API using Express
      • Implement Authentication Flow API using PHP
      • Add Custom Login/Signup UI to Native Apps
      • Manually Link OAuth Provider using Account Management API
      • Implement a custom account recovery UI using Authentication Flow API
    • Integrate
      • Add custom fields to a JWT Access Token
      • User Analytics by Google Tag Manager
      • Track User Before and After Signup
      • Custom domain
      • Custom Email Provider
      • Custom SMS Provider
        • Twilio
        • Webhook/Custom Script
    • Monitor
      • Audit Log For Users Activities
      • Audit Log for Admin API and Portal
      • Analytics
    • User Management
      • Account Deletion
      • Import Users using User Import API
      • Export Users using the User Export API
      • Manage Users Roles and Groups
      • How to Handle Password While Creating Accounts for Users
    • User Profiles
      • What is User Profile
      • Access User Profiles
      • Update User Profiles
      • Profile Custom Attributes
      • Update user profile on sign-up using Hooks
    • Events and Hooks
      • Event List
      • Webhooks
      • JavaScript / TypeScript Hooks
      • Only Allow Signups from Inside the Corporate Network using Hooks
    • Mobile Apps
      • Use SDK to make authorized API calls to backend
      • Force authentication on app launch
      • Customize the Login Pop-up / Disable the login alert box
    • Languages and Localization
    • Custom Email and SMS Templates
    • Directly accessing Authgear Endpoint
    • Migration
      • Bulk migration
      • Rolling migration
      • Zero-downtime migration
    • Troubleshoot
      • How to Fix SubtleCrypto: digest() undefined Error in Authgear SDK
      • How to Fix CORS Error
  • Concepts
    • Identity Fundamentals
    • Authgear use cases
    • User, Identity and Authenticator
  • Security
    • Brute-force Protection
    • Bot Protection
    • Non-HTTP scheme redirect URI
    • Password Strength
  • Reference
    • APIs
      • Admin API
        • Authentication and Security
        • API Schema
        • Admin API Examples
        • Using global node IDs
        • Retrieving users using Admin API
        • User Management Examples
          • Search for users
          • Update user's standard attributes
          • Update user's picture
          • Generate OTP code
      • Authentication Flow API
      • OAuth 2.0 and OpenID Connect (OIDC)
        • UserInfo
        • Supported Scopes
      • User Import API
      • User Export API
    • Tokens
      • JWT Access Token
      • Refresh Token
    • Glossary
    • Billing FAQ
    • Rate Limits
      • Account Lockout
  • Client App SDKs
    • Javascript SDK Reference
    • iOS SDK Reference
    • Android SDK Reference
    • Flutter SDK Reference
    • Xamarin SDK Reference
  • Deploy on your Cloud
    • Running locally with Docker
    • Deploy with Helm chart
    • Authenticating HTTP request with Nginx
    • Configurations
      • Environment Variables
      • authgear.yaml
      • authgear.secrets.yaml
    • Reference Architecture Diagrams
      • Google Cloud Reference Architecture
      • Azure Reference Architecture
      • AWS Reference Architecture
      • Throughput Scaling Reference
Powered by GitBook
On this page
  • Difference Between Users query and the getUser/getUsers queries
  • 1. getUsersByStandardAttribute
  • 2. getUserByLoginID
  • 3. getUserByOAuth

Was this helpful?

Edit on GitHub
  1. Reference
  2. APIs
  3. Admin API

Retrieving users using Admin API

Overview and examples for the getUser/getUsers queries

PreviousUsing global node IDsNextUser Management Examples

Last updated 8 months ago

Was this helpful?

The getUser and getUsers queries are a collection of queries for getting details about a single user or multiple users using specific attributes as the search key and in real-time.

Queries in the collection vary by the type of attribute they support as a search key. The queries are:

  • getUsersByStandardAttribute(attributeName: String!, attributeValue: String!)

  • getUserByLoginID(loginIDKey: String!, loginIDValue: String!)

  • getUserByOAuth(oauthProviderAlias: String!, oauthProviderUserID: String!)

Difference Between Users query and the getUser/getUsers queries

The users query is another type of query used to retrieve users. In the following section, we'll discuss the difference between the getUser/getUsers queries and the users query.

  • Immediately Consistent: the getUser and getUsers queries search the database directly for users while the users query depends on a search index. As a result, the users query may not return details about a recently edited user, while getUser and getUsers queries are immediately consistent.

  • Exact Match: the getUser and getUsers queries only return a result that is an exact match. While calling the users query may return users when there is a partial match of a user's email, phone number, or name.

  • Specific attribute: with the getUser and getUsers queries, you need to specify to retrieve the user by their email, username, or phone number. While the users query uses a single searchKeyword field.

Use the users query to search for users without the search term being an exact match. For example, using "John" to search for a user with the full name "John Doe".

Use the getUser and getUsers queries to retrieve the user data after a recent write operation. Note that you can not use any of the getUser and getUsers queries to search for users by their names or any additional attributes outside the supported ones mentioned on this page.

The following section contains details and examples for each query in the getUser and getUsers queries:

1. getUsersByStandardAttribute

The getUsersByStandardAttribute query provides a way to retrieve users using a predefined standard attribute as the search key. The following are the standard attributes (attributeName) that you can use:

  • email

  • preferred_username

  • phone_number

You can use the getUsersByStandardAttribute query to get details for a user that registered with a loginID or OAuth connection. For example, you can use the email field in the standard attribute as a search key to find a user who linked an email address from an OAuth connection or registered using the email and password login method.

Schema:

getUsersByStandardAttribute(
attributeName: String!
attributeValue: String!
): [User!]!

Inputs:

  • attributeName: The name of the standard attribute that will be used as the search key. The value can only be: email, preferred_username, or phone_number.

  • attributeValue: The actual value for the user's standard attribute that you're using (attributeName) as the search key. For example, the full email address of the user if you are using email as the value for attributeName.

Example:

query {
  getUsersByStandardAttribute(attributeName: "email", attributeValue: "user@example.com") {
    id,
    standardAttributes
  }
}
{
  "data": {
    "getUsersByStandardAttribute": [
      {
        "id": "VXNlciklODRkMzdjZi1hZDQ5LTRiZDItOTMzZJ2tOGY1YThlYjc34RE",
        "standardAttributes": {
          "email": "user@example.com",
          "email_verified": true,
          "family_name": "Aboyi",
          "given_name": "John",
          "name": "John Doe",
          "nickname": "Pius",
          "picture": "https://platform-lookaside.fbsbx.com/.../",
          "updated_at": 1724858514
        }
      }
    ]
  }
}

2. getUserByLoginID

Use the getUserByLoginID query to retrieve details about a user using their loginID as the search key. The following are the types of loginID supported:

  • email

  • username

  • phone

Schema:

getUserByLoginID(
  loginIDValue: String!
  loginIDKey: String!
): User

Inputs:

  • loginIDKey: the value of this field should be the type of loginID associated with the user's account ( email, phone or username).

  • loginIDValue: enter the exact value of the identity associated with the user's account. For example, the user's full email address if their identity is email. For phone, use the full phone number including the "+" sign and country code, e.g. +441234567890.

Example:

The following example shows a getUserByLoginID query and a response when a user is found.

query {
  getUserByLoginID(loginIDKey: "email", loginIDValue: "user@example.com") {
    id,
    standardAttributes
  }
}
{
  "data": {
    "getUserByLoginID": {
      "id": "VXNlciklODRkMzdjZi1hZDQ5LTRiZDItOTMzZJ2tOGY1YThlYjc34RE",
      "standardAttributes": {
        "email": "user@example.com",
        "email_verified": true,
        "family_name": "Doe",
        "given_name": "John",
        "updated_at": 1724854753
      }
    }
  }
}

3. getUserByOAuth

The getUserByOAuth query allows you to retrieve details about a user that linked an identity using a social/enterprise provider. For example, you can use the getUserByOAuth query to search for a user that linked their account to Facebook using the User ID (sub) issued by Facebook OAuth provider as the search key.

Schema:

getUserByOAuth(
  oauthProviderAlias: String!
  oauthProviderUserID: String!
): User

Inputs:

  • oauthProviderAlias: This is an identifier for each OAuth provider that can be set in Authgear portal via Authentication > Social / Enterprise Login. The default for value is google, facebook, github, apple for respective social login providers.

Example

query {
  getUserByOAuth(oauthProviderAlias: "facebook", oauthProviderUserID: "1234567812730389") {
    id,
    oauthConnections {
      claims
    }
  }
}
{
  "data": {
    "getUserByOAuth": {
      "id": "VXNlciklODRkMzdjZi1hZDQ5LTRiZDItOTMzZJ2tOGY1YThlYjc34RE",
      "oauthConnections": [
        {
          "claims": {
            "email": "user@example.com",
            "family_name": "Doe",
            "given_name": "John",
            "https://authgear.com/claims/oauth/profile": {
              "email": "user@example.com",
              "first_name": "John",
              "id": "1234567812730389",
              "last_name": "Doe",
              "name": "John Doe",
              "name_format": "{first} {last}",
              "picture": {
                "data": {
                  "height": 50,
                  "is_silhouette": false,
                  "url": "https://platform-lookaside.fbsbx.com/..../",
                  "width": 50
                }
              },
              "short_name": "John"
            },
            "https://authgear.com/claims/oauth/provider_alias": "facebook",
            "https://authgear.com/claims/oauth/provider_type": "facebook",
            "https://authgear.com/claims/oauth/subject_id": "1234567812730389",
            "name": "John Doe",
            "nickname": "John",
            "picture": "https://platform-lookaside.fbsbx.com/../"
          }
        }
      ]
    }
  }
}

Note: An email address linked to a user's account via social/enterprise login (OAuth) provider only can not be used as a search key in the getUserByLoginID query. Use instead to search for email addresses linked via OAuth provider only.

oauthProviderUserID: The value for this field should be the sub (User ID) returned by the OAuth provider. You can see the value of a user's oauthProviderUserID in their oauthConnections.claims under the id field. See the official documentation for each OAuth provider to learn more about their sub. shows an example of sub from Facebook.

Admin API
This page
getUsersByStandardAttribute