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
      • 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
    • 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
  • Authgear ONCE
    • What is Authgear ONCE
    • Install Authgear ONCE on a VM
    • Install Authgear ONCE on Vultr
  • 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
  • 1. openid
  • 2. offline_access
  • 3. https://authgear.com/scopes/full-userinfo

Was this helpful?

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

Supported Scopes

Details about the OAuth 2.0 Scopes Authgear supports

PreviousUserInfoNextUser Import API

Last updated 1 year ago

Was this helpful?

Scope is a security mechanism that controls the level of access a client application can have to a user's data. Scope is part of the and the value of scope is a parameter that contains a list of one or more scopes. Each scope is separated from the other using a single white space.

The following example shows the structure of the Authgear authorization endpoint with openid and offline_access scopes:

GET https://your-project.authgear.cloud/oauth2/authorize?
    client_id=<CLIENT_ID>&
    scope=openid+offline_access&
    redirect_url=<REDIRECT_URI>

In this post, we'll discuss all the OIDC scopes Authgear supports and the level of access each scope grants a client application.

1. openid

This is the minimum scope required to use Authgear as an OIDC or 0Auth 2.0 provider. Usually, you'll use the openid scope alone or with other additional scopes based on the kind of data your client application will access from Authgear on behalf of a user.

The openid scope grants the following access to your client application:

  • Open ID Connect: required to access the Authgear authorization page, get the authorization code, and exchange the authorization code for an access token.

  • UserInfo Endpoint: You can access a user's profile details such as email, phone number, picture, gender and more using the access token gotten from an authorization request that has the openid scope in a separate HTTP request to the endpoint.

The following is a sample of the HTTP response from the token endpoint for an authorization request that has only the openid scope:

{
  "access_token": "<ACCESS_TOKEN_VALUE>",
  "expires_in": 1800,
  "id_token": "<ID_TOKEN_VALUE>",
  "token_type": "Bearer"
}

2. offline_access

The offline_access scope is required to get a refresh token from Authgear's token endpoint. If a client application that does not include the offline_access scope in its authorization request exchanges an authorization code for an access token, the refresh_token field will be omitted.

The refresh token is a key that your client application can send back to the Authgear server for a new access token after the old access token expires. Hence it allows your application to obtain a new access token without the user repeating the entire OAuth 2.0 authorization flow.

The following example shows the response from the token endpoint for an authorization request with the offline_access scope:

{
  "access_token": "<ACCESS_TOKEN_VALUE>",
  "expires_in": 1800,
  "id_token": "<ID_TOKEN_VALUE>",
  "refresh_token": "<REFRESH TOKEN_VALUE>",
  "token_type": "Bearer"
}

3. https://authgear.com/scopes/full-userinfo

Including the https://authgear.com/scopes/full-userinfo scope in an authorization request will enable Authgear to include some of the details that are usually returned by the UserInfo endpoint in the ID token for the current session. Details such as the email address, phone number, and account verification status are included.

The value for id_token is an encoded string, you'll need to decode this value to view the actual user profile information.

Although the id_token field is present in the token endpoint response for authorization requests that does NOT include the https://authgear.com/scopes/full-userinfo scope, decoding the id_token in such responses will not include user profile information.

The following example shows the decoded content of an id_token for an authorization request with the https://authgear.com/scopes/full-userinfo scope present:

{
  "aud": [
    "<CLIENT_ID>"
  ],
  "auth_time": 1714667006,
  "email": "johndoe@example.com",
  "email_verified": false,
  "exp": 1714667852,
  "https://authgear.com/claims/user/can_reauthenticate": true,
  "https://authgear.com/claims/user/is_anonymous": false,
  "https://authgear.com/claims/user/is_verified": false,
  "https://authgear.com/claims/user/roles": [],
  "iat": 1714667552,
  "iss": "https://authgeartest.online",
  "sid": "<SID_VALUE>",
  "sub": "<SUB_VALUE>"
}

Here's an example of the decoded content of an id_token for an authentication request that does NOT include the https://authgear.com/scopes/full-userinfo scope:

{
  "aud": [
    "<CLIENT_ID>"
  ],
  "auth_time": 1714667006,
  "exp": 1714668328,
  "https://authgear.com/claims/user/can_reauthenticate": true,
  "https://authgear.com/claims/user/is_anonymous": false,
  "https://authgear.com/claims/user/is_verified": false,
  "https://authgear.com/claims/user/roles": [],
  "iat": 1714668028,
  "iss": "https://authgeartest.online",
  "sid": "<SID_VALUE>",
  "sub": "<SUB_VALUE>"
}

Notice that the email and email_verified fields are not included in the second example.

OAuth 2.0 specification
UserInfo