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)
      • Reauthentication
      • Passwordless Login for Apple App Store Review
      • Change Forgot/Reset Password settings
      • Adjust Phone Number Validation
      • Set Password Expiry
      • Use the OAuth 2.0 State Parameter
      • Setup local development environment for Cookie-based authentication
      • Use Social/Enterprise Login Providers Without AuthUI
    • 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
    • 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
      • Integrate Authgear with Firebase
    • 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
    • Migration
      • Bulk migration
      • Rolling migration
      • Zero-downtime migration
    • Directly accessing Authgear Endpoint
    • Troubleshoot
      • How to Fix SubtleCrypto: digest() undefined Error in Authgear SDK
      • How to Fix CORS Error
  • Design
    • 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
    • Languages and Localization
    • Custom Email and SMS Templates
  • Concepts
    • Identity Fundamentals
    • Authgear use cases
    • User, Identity and Authenticator
  • Security
    • Brute-force Protection
    • Bot Protection
    • Non-HTTP scheme redirect URI
    • Password Strength
  • Authgear ONCE
    • What is Authgear ONCE
    • Install Authgear ONCE on a VM
    • Install Authgear ONCE on Vultr
    • Install Authgear ONCE on Amazon Web Services (AWS)
  • 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
  • Standard Attributes
  • Custom Attributes

Was this helpful?

Edit on GitHub
Export as PDF
  1. Reference
  2. APIs
  3. OAuth 2.0 and OpenID Connect (OIDC)

UserInfo

Complete list of information in the UserInfo endpoint response.

PreviousOAuth 2.0 and OpenID Connect (OIDC)NextSupported Scopes

Last updated 1 year ago

Was this helpful?

Authgear provides a UserInfo endpoint that your client application can send requests to for information about the current authenticated user. The current user is the owner of the access token included in your request to the UserInfo endpoint.

The following is the path for the UserInfo endpoint:

/oauth2/userinfo

An example of a full URL for this endpoint looks like this: https://your-project.authgear.cloud/oauth2/userinfo. Replace the "your-project.authgear.cloud" part with the correct hostname for your Authgear project.

You can also find the full URL for the UserInfo endpoint for your Authgear OIDC Client Application under Application > [your application] in Authgear Portal.

The following code shows an example of the structure and some information that's usually in the JSON response of the UserInfo endpoint.

{
    "custom_attributes": {},
    "email": "user@gmail.com",
    "email_verified": true,
    "family_name": "John",
    "gender": "male",
    "given_name": "Doe",
    "phone_number": "0805551112";
    "phone_number_verified": true;
    "https://authgear.com/claims/user/can_reauthenticate": true,
    "https://authgear.com/claims/user/is_anonymous": false,
    "https://authgear.com/claims/user/is_verified": true,
    "sub": "e3079029-f123-4a56-78b9-c0de12f3a4af",
    "updated_at": 1694947082,
    "x_web3": {
        "accounts": []
    }
}

The endpoint can return both standard attributes defined by Authgear and custom attributes defined by you for your application.

The following section explains each standard attribute and examples of some custom attributes you can define.

Standard Attributes

  • email: the email address associated with the current user account.

  • email_verified: contains a boolean value that represents the current status of the user's email verification.

  • family_name: family name of the current user.

  • given_name: givenname of the current user.

  • gender: holds the value set for the current users' gender (male, female, or some other string).

  • https://authgear.com/claims/user/can_reauthenticate: this field contains a boolean value that is true if this user can perform reauthentication and false if they can't.

  • https://authgear.com/claims/user/is_anonymous: returns true if the current user is an anonymous user.

  • https://authgear.com/claims/user/is_verified: this field contains a boolean value that's true if the current user has verified their email and false if they have not.

  • phone_number: a phone number associated with the current user's account.

  • phone_number_verified: returns true if the associated phone number is verified and false if it's not.

  • picture: contains the URL to the user's profile photo.

  • updated_at: returns the date and time for the last time the user's profile was updated.

  • custom_attributes: this field contains an object that has all the custom attributes you defined.

Note: The above list is not an exhaustive list of all the fields that the UserInfo endpoint can return. Also, fields that are not defined for the current user will be excluded from the response. For example, if a user does not have any phone number associated with their account, the phone_number field will not be included in the JSON response.

Custom Attributes

Your custom attributes are included inside an object in the custom_attributes field in the JSON response as described in the previous section.

You can set custom attributes from User Profile > Custom Attributes in the Authgear Portal.

If we add a new customer attribute for passport_number, the response from the UserInfo endpoint will look like this:

{
    "custom_attributes": {
        "passport_number": "A123456"
    },
    "email": "user@gmail.com",
    "email_verified": true,
    "family_name": "John",
    "gender": "male",
    "given_name": "Doe"
}

If you're using any of the Authgear SDKs, you can request the data from the UserInfo endpoint just by calling a method. For example, in the JavaScript Authgear SDK, the fetchUserInfo() method returns information about the current user. You can learn more about other SDKs .

sub: sub is short for "subject" and it is a standard field in O. The value is the user's unique ID generated by Authgear. You can use this user ID to generate a which you can then use in Admin API to query a user or perform mutations.

x_web3: this field contains an object that has details related to support.

here
user node ID
Authgear's web3