First API Call 🚀

This page is for Authlete 3.0. For 2.x, see Getting Started (2.x).

1. Create an Authlete Account

To use Authlete, you need an account. Once registered, you can configure all features through the management console. Visit the Authlete website and click Free Trial in the upper-right corner.

Authlete website homepage with Free Trial button prominently displayed in the upper-right corner

Choose your preferred registration method. You can use social login (Google or GitHub) or sign up with your email address.

After verifying your social login or email address, complete the profile page by entering your first name, last name, and organization name (and Password if using email registration). Review Authlete’s Privacy Policy and Terms of Service, then click Register to agree and complete your signup.

2. Create a Service

Immediately after signing up, you will be directed to the Services page. This page displays all services under your organization (which was created during the signup process). A Service represents the backend of your Authorization Server. It contains all the configurations required to operate a production-grade authorization server, including OAuth/OIDC settings, token management, and security policies. Click Create Service to add a new Authlete service to your organization.

Services page showing a list of existing services under the organization with a blue Create Service button in the upper right

Select your preferred API Cluster location (e.g., US). All service data will be stored in this selected cluster. Choose the cluster based on your data residency and environment isolation requirements.
Enter a Service Name (e.g., Sample Service).
Click Create to complete the setup.

Create service form with dropdown menu to select API cluster location such as US, input field for service name, and a blue Create button

Now you have completed to create a new Service.

3. Create a Service Access Token

You will need a Service Access Token to authenticate your Authlete API calls. Click Service Settings for your newly created service.

Service overview page with Service Settings option displayed for the newly created service

Note down the Service Identifier value (e.g., 3615784225), which is required when making requests in many Authlete APIs.
Click Create Token to create a new Service Access Token.

Service settings page displaying the Service Identifier value and a blue Create Token button to generate a new Service Access Token

Enter a token Name (e.g., oauth-server-token).
Specify the Expiration Date.
Select the appropriate Permissions (e.g., Authorization Server preset).
Click Create Token.

Add a Service Access Token dialog showing Token Name field with oauth-server-token, Expiration Date field with date picker, Permission Presets section with Authorization Server option highlighted in orange, Custom Token Permissions checkboxes below, and a blue Create Token button at the bottom

The new Service Access Token will appear in the list.

Click the Copy or Show icon to retrieve the token value, as it is required for most Authlete API requests. Please note that this value is only displayed once upon creation.
Click Back to Service Overview to return to the main Service page.

Service Access Token list showing the newly created token with Copy and Show buttons next to it, and a Back to Service Overview link to return to the main service page

Now you are ready to test the Authlete API!

4. Call the Authlete API

Let’s make your first API request to Authlete’s /service/configuration API, which acts as the backend for the OIDC discovery endpoint, generating OpenID provider metadata so that the endpoint can return in response to requests from clients (OIDC relying parties). Below are examples using curl and the API Explorer. Please replace the placeholder values with your actual environment details.

Item	Value
API Cluster Hostname	`https://us.authlete.com`
Service Access Token	`qwEF2t8gxW9MerraRyVtscDTKVPa66kjBBPUpBduvXw`
Service ID	`3615784225`

Using curl

Run the following command in your terminal to send an HTTP GET request:

curl -X GET "https://us.authlete.com/api/3615784225/service/configuration" \
 -H "Authorization: Bearer qwEF2t8gxW9MerraRyVtscDTKVPa66kjBBPUpBduvXw"

curl.exe -X GET "https://us.authlete.com/api/3615784225/service/configuration" `
 -H "Authorization: Bearer qwEF2t8gxW9MerraRyVtscDTKVPa66kjBBPUpBduvXw" | ConvertFrom-Json

If successful, the API will return OpenID Provider Metadata similar to this:

{
  "issuer": "https://authlete.com",
    [...]
  "scopes_supported": [
    "address",
    "email",
    "openid",
    "offline_access",
    "phone",
    "profile",
    "grant_management_query",
    "grant_management_revoke"
  ],
  "response_types_supported": [
    "none",
    "code",
    "id_token",
    "code id_token"
  ],
[...]
}

Using API Explorer

Open the /service/configuration API reference page and click the Try it button.

API Explorer interface for the /service/configuration endpoint with Try it button ready to be clicked to test the API

Choose the API Cluster Hostname.
Enter the Service Access Token.
Enter the Service ID.
Click Send.

API Explorer form with input fields for Service ID and Service Access Token, and a blue Send button to execute the API request

The API response will be displayed in the Response section.

API response displayed in the Response section of the API Explorer showing JSON data with service configuration details including issuer, supported scopes, and response types

Next Steps

Now that your Authlete account is set up and your service is configured, it’s time to explore further:

OAuth 2.0 Basics - API Tutorials: Learn how Authlete works under the hood by calling the APIs directly using curl and other tools.
Using Demo Authorization Server: Deploy an open-source authorization server frontend that integrates with Authlete APIs to test live OAuth/OIDC flows.

Extra: OAuth/OIDC Processing

Let’s explore Authlete’s OAuth/OIDC protocol processing by testing a sample authorization request.

Create a Client

A Client represents an application that interacts with the Authorization Server to request tokens, or with the Resource Server to access protected resources. Clients are managed within the context of a specific Authlete Service. On the Service page, click the Create Client button at the top-right of the screen.

Service page with Create Client button located in the upper-right corner of the screen ready to be clicked

Enter a Client Name and click Create.

Create client dialog form with input field for Client Name and a blue Create button to add the new client

Once created, the client details will be displayed. Make a note of the Client ID and Client Secret if needed. In the Redirect URIs section, click Add to register your application’s redirect URIs.

Client details page showing Client ID and Client Secret values, with a Redirect URIs section and an Add button to register application redirect URIs

For example, enter https://client.example.org/cb/example.com and click Save Changes.

Redirect URI input form with example value https://client.example.org/cb/example.com and a blue Save Changes button to confirm the entry

Call “Process Authorization Request” API

Navigate to the Try /auth/authorization API tool.

Choose the API Cluster Hostname.
Enter the Service Access Token.
Enter the Service ID.
Enter the authorization request content below into the parameters field. Please note that you must replace the example client_id value (2329821874) with the one you created in the previous step.
Click Send.

Parameter	Value
parameters	`redirect_uri=https://client.example.org/cb/example.com&client_id=2329821874&response_type=code`

API Explorer showing the /auth/authorization endpoint with parameters entered

You will see the API response in the Response section.

API Explorer showing the /auth/authorization endpoint with parameters entered and the JSON response displayed in the Response section showing authorization request results

Introduction to Authlete

Quickstarts

Concepts

Developer Resources

Tools

1. Create an Authlete Account

2. Create a Service

3. Create a Service Access Token

4. Call the Authlete API

Using curl

Using API Explorer

Next Steps

Extra: OAuth/OIDC Processing

Create a Client

Call “Process Authorization Request” API

​1. Create an Authlete Account

​2. Create a Service

​3. Create a Service Access Token

​4. Call the Authlete API

​Using curl

​Using API Explorer

​Next Steps

​Extra: OAuth/OIDC Processing

​Create a Client

​Call “Process Authorization Request” API

1. Create an Authlete Account

2. Create a Service

3. Create a Service Access Token

4. Call the Authlete API

Using curl

Using API Explorer

Next Steps

Extra: OAuth/OIDC Processing

Create a Client

Call “Process Authorization Request” API