Skip to content

API Reference Overview

Welcome to the OxideAuth API Reference. OxideAuth provides a comprehensive RESTful API to manage authentication, accounts, roles, services, and utility endpoints for your decentralized applications.

The API relies on standard JSON for request bodies and responses.

Postman Collection

To easily test and explore the OxideAuth endpoints, you can download our complete Postman Collection which contains all the endpoints, example request bodies, and configured variables.

Download Postman Collection

Once downloaded, open Postman and click Import to bring the collection into your workspace.

Base URL

All endpoints are relative to your deployment's base URL. In our examples, we refer to the base URL as {{host}}.

Authentication

Most endpoints require authentication via an Access Token. When an endpoint specifies Authentication: bearer, you should include the token in the Authorization header:

Authorization: Bearer YOUR_ACCESS_TOKEN

Sections

  • Auth: Manage user authentication, login, registration, password resets, and token refreshes.
  • Accounts: Perform CRUD operations on user accounts, assign roles, and manage verification states.
  • Services: Create, retrieve, update, and delete registered services or applications linked to OxideAuth.
  • Roles: Manage granular permissions and role definitions across your ecosystem.
  • Utils: Utility endpoints, such as health checks, fetching service metrics, and system status.