APIs
Authgear exposes APIs for developers to manage their applications programmatically
Last updated
Authgear exposes APIs for developers to manage their applications programmatically
Last updated
Besides the Client SDKs, Authgear exposes the following APIs for simple integration with your applications for authentication and user management.
All of these are on the endpoint of your app. The default endpoint is at https://[myapp].authgear.cloud unless you set up a custom domain. [myapp] is your project name.
Unless otherwise specified, all paths mentioned here are relative to the endpoint of your app.
Authgear provides the following groups of APIs:
OAuth 2.0 and OpenID Connect: for connecting with OIDC Clients
Admin API: for your servers to manage users via a GraphQL endpoint.
User Import API: this is an API that supports the bulk import of users from another system to an Authgear project.
User Export API: an API that allows you to export user data from an Authgear project into a file in CSV or ndjson format.
Authentication Flow (Auth Flow) API: for developing a customized Web or Mobile Native Auth UI instead of the default user interface provided by Authgear.
Resolver Endpoint: for API Gateway or Servers to check the validity of access tokens or cookies in the request header.
Here are all of the special paths with each group of the API above.
For more information about the OIDC API endpoint, please refer to the following sections or any of the Regular Web App Getting Started guides.
The related URLs are:
/.well-known/openid-configuration
This endpoint serves as a JSON document containing the OpenID Connect configuration of your app. That includes the authorization endpoint, the token endpoint, and the JWKs endpoint. Here is an example of how it looks.
/.well-known/oauth-authorization-server
This endpoint serves a JSON document containing the authorization server metadata of your app. That includes the authorization endpoint, the token endpoint, and the JWKs endpoint. Here is an example of how it looks.
/oauth2/userinfo
The UserInfo Endpoint is an OAuth 2.0 Protected Resource that returns Claims about the authenticated end user. When the client presents with a valid Access Token, the endpoint responds with the claims packaged in a JSON object. The claims are also the attributes of the User Profile.
For more details about the Admin API, please refer to the following documentation:
The path for the Admin API is:
/_api/admin/graphql
To learn more about using the User Import API, see the following documentation page:
The path for the User Import API:
/_api/admin/users/import
Use this endpoint to import users.
/_api/admin/users/import/{ID}
Use this endpoint to query the status of an existing user import task.
See the following documentation for a detailed on how to use the User Export API:
Paths for the User Export API:
/_api/admin/users/export
Use the above endpoint to start the process of exporting users.
/_api/admin/users/export/{Task ID}
Use the above endpoint to check when an existing export process is complete and retrieve the download URL for the export file.
You can find a detailed overview of the Authentication Flow API in the following documentation:
The path for the Authentication Flow API is:
/api/v1/authentication_flows
The resolver endpoint is at the following URL:
/_resolver/resolve
The endpoint serves as a resolver to check the access token or cookie in the request headers. Forward incoming HTTP requests to this endpoint and the resolver will add the x-authgear- headers to the response.
See the list of x-authgear- headers in the specs here.
See implementation examples here.
Should you choose to use Resolver Endpoints instead of JWT tokens to validate each API request, check out the following tutorial to learn how to go about that:
Here are two other URLs
/
This endpoint is the entry point of the Web UI. You can visit it if you want to try your configuration (only for custom domains). However, this is NOT the authorization endpoint. You must use our SDK to initiate an authentication.
/settings
This URL points to the default User settings UI provided by Authgear.