Introduction To Our APIs

Wristband is an API-first authentication platform. Our hosted pages and dashboards are built entirely on our public APIs, so anything you can do in the dashboard can also be done programmatically. Likewise, you can replace any hosted authentication flow with your own custom UI while still using our APIs to handle authentication.

Wristband's APIs are grouped into three categories:

  • Authentication APIs
  • Resource Management APIs
  • Workflow APIs

Depending on your use case, you may not need to interface with APIs from every group. The sections below provide a high-level overview of each API category and explain when to use them.

Authentication APIs

Authentication APIs

The Authentication APIs facilitate secure user login, adhering to OpenID Connect and OAuth 2.1 protocols. Use these APIs to implement your Login, Callback, and Logout Endpoints. If you're using one of our SDKs, the SDK methods will handle calling these APIs for you, so you won't need to interface with these APIs directly.

Resource Management APIs

Resource Management APIs

The Resource Management APIs enable you to work with Wristband entities, such as users, tenants, and roles, as well as update configurations and security policies. Use them to integrate Wristband resources into your application or to provision entities programmatically.

Workflow APIs

Workflow APIs

The Workflow APIs handle the backend logic for Wristband-hosted authentication flows, such as login, signup, user invite, password reset, etc. If you use Wristband’s dashboard and hosted pages, these APIs are called automatically. However, if you want to build your own UIs, you’ll call them directly to perform the necessary workflow operations.