Skip to content

srqai/authlete-typescript-sdk

BranchesTags

Repository files navigation

authlete-typescript-sdk

Developer-friendly & type-safe Typescript SDK specifically catered to leverage authlete-typescript-sdk API.



Important

This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Authlete API: Authlete API Explorer

Welcome to the Authlete API documentation. Authlete is an API-first service where every aspect of the platform is configurable via API. This explorer provides a convenient way to authenticate and interact with the API, allowing you to see Authlete in action quickly.

At a high level, the Authlete API is grouped into two categories:

  • Management APIs: Enable you to manage services and clients
  • Runtime APIs: Allow you to build your own Authorization Servers or Verifiable Credential (VC) issuers

All API endpoints are secured using access tokens issued by Authlete's Identity Provider (IdP). If you already have an Authlete account, simply use the Get Token option on the Authentication page to log in and obtain an access token for API usage. If you don't have an account yet, sign up at https://console.authlete.com/register to get started.

API Servers: Authlete is a global service with clusters available in multiple regions across the world. Currently, our service is available in the following regions:

  • US Cluster
  • Japan Cluster
  • Europe Cluster
  • Brazil Cluster

Our customers can host their data in the region that best meets their requirements.

Authentication: The API Explorer requires an access token to call the API. You can create the access token from the Authlete Management Console and set it in the HTTP Bearer section of Authentication page. Alternatively, if you have an Authlete account, the API Explorer can log you in with your Authlete account and automatically acquire the required access token.

Important Note: When the API Explorer acquires the token after login, the access tokens will have the same permissions as the user who logs in as part of this flow.

Tutorials: If you have successfully tested the API from the API Console and want to take the next step of integrating the API into your application, or if you want to see a sample using Authlete APIs, follow the links below. These resources will help you understand key concepts and how to integrate Authlete API into your applications.

Contact Us: If you have any questions or need assistance, our team is here to help. Visit our Contact Page at https://www.authlete.com/contact/

Table of Contents

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add authlete-typescript-sdk

PNPM

pnpm add authlete-typescript-sdk

Bun

bun add authlete-typescript-sdk

Yarn

yarn add authlete-typescript-sdk zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

Note

This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Authlete } from "authlete-typescript-sdk";

const authlete = new Authlete({
  security: {
    authlete: process.env["AUTHLETE_AUTHLETE"] ?? "",
  },
});

async function run() {
  const result = await authlete.serviceManagement.serviceGetApi({
    serviceId: "<id>",
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

Name Type Scheme Environment Variable
authlete oauth2 OAuth2 token AUTHLETE_AUTHLETE
bearer http HTTP Bearer AUTHLETE_BEARER

You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

import { Authlete } from "authlete-typescript-sdk";

const authlete = new Authlete({
  security: {
    authlete: process.env["AUTHLETE_AUTHLETE"] ?? "",
  },
});

async function run() {
  const result = await authlete.serviceManagement.serviceGetApi({
    serviceId: "<id>",
  });

  console.log(result);
}

run();

Available Resources and Operations

Available methods

authorizationEndpoint

ciba

clientManagement

deviceFlow

dynamicClientRegistration

federationEndpoint

grantManagementEndpoint

  • grantMApi - Process Grant Management Request

hardwareSecurityKey

introspectionEndpoint

joseObject

jwkSetEndpoint

pushedAuthorizationEndpoint

revocationEndpoint

serviceManagement

tokenEndpoint

tokenOperations

userInfoEndpoint

utilityEndpoints

verifiableCredentialIssuer

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Authlete } from "authlete-typescript-sdk";

const authlete = new Authlete({
  security: {
    authlete: process.env["AUTHLETE_AUTHLETE"] ?? "",
  },
});

async function run() {
  const result = await authlete.serviceManagement.serviceGetApi({
    serviceId: "<id>",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Authlete } from "authlete-typescript-sdk";

const authlete = new Authlete({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  security: {
    authlete: process.env["AUTHLETE_AUTHLETE"] ?? "",
  },
});

async function run() {
  const result = await authlete.serviceManagement.serviceGetApi({
    serviceId: "<id>",
  });

  console.log(result);
}

run();

Error Handling

AuthleteError is the base class for all HTTP error responses. It has the following properties:

Property Type Description
error.message string Error message
error.statusCode number HTTP response status code eg 404
error.headers Headers HTTP response headers
error.body string HTTP body. Can be empty string if no body is returned.
error.rawResponse Response Raw HTTP response
error.data$ Optional. Some errors may contain structured data. See Error Classes.

Example

import { Authlete } from "authlete-typescript-sdk";
import * as errors from "authlete-typescript-sdk/models/errors";

const authlete = new Authlete({
  security: {
    authlete: process.env["AUTHLETE_AUTHLETE"] ?? "",
  },
});

async function run() {
  try {
    const result = await authlete.utilityEndpoints.infoApi();

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.AuthleteError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.BadRequestError) {
        console.log(error.data$.resultCode); // string
        console.log(error.data$.resultMessage); // string
      }
    }
  }
}

run();

Error Classes

Primary error:

Less common errors (8)

Network errors:

Inherit from AuthleteError:

  • BadRequestError: Bad request - Invalid input. Status code 400. Applicable to 1 of 115 methods.*
  • APIInfo4002Error: Unauthorized - Authentication required. Applicable to 1 of 115 methods.*
  • ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

# Server Description
0 https://us.authlete.com 🇺🇸 US Cluster
1 https://jp.authlete.com 🇯🇵 Japan Cluster
2 https://eu.authlete.com 🇪🇺 Europe Cluster
3 https://br.authlete.com 🇧🇷 Brazil Cluster

Example

import { Authlete } from "authlete-typescript-sdk";

const authlete = new Authlete({
  serverIdx: 3,
  security: {
    authlete: process.env["AUTHLETE_AUTHLETE"] ?? "",
  },
});

async function run() {
  const result = await authlete.serviceManagement.serviceGetApi({
    serviceId: "<id>",
  });

  console.log(result);
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Authlete } from "authlete-typescript-sdk";

const authlete = new Authlete({
  serverURL: "https://br.authlete.com",
  security: {
    authlete: process.env["AUTHLETE_AUTHLETE"] ?? "",
  },
});

async function run() {
  const result = await authlete.serviceManagement.serviceGetApi({
    serviceId: "<id>",
  });

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { Authlete } from "authlete-typescript-sdk";
import { HTTPClient } from "authlete-typescript-sdk/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Authlete({ httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

Warning

Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Authlete } from "authlete-typescript-sdk";

const sdk = new Authlete({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable AUTHLETE_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

About

No description, website, or topics provided.

Resources

Readme

Contributing

Contributing
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases 9

typescript - v0.0.8 - 2025-08-14 16:39:01 Latest
Aug 14, 2025
+ 8 releases

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages