API

The Authup API provides a powerful and flexible interface to integrate authentication and authorization capabilities into applications.
This section of the Developer Guide offers an overview of the API's structure, its key workflows, and best practices for using it effectively.

Swagger

The full API reference is available via the built-in Swagger documentation.
Once the backend is running, the Swagger interface can be accessed at: http://<BACKEND_URL>/docs (e.g. http://localhost:3001/docs)

What You'll Learn

This section is structured as follows:

• OAuth2: A guide on how to implement OAuth2 flows for secure authentication and authorization.
• Examples: Practical examples of interacting with the API (e.g. users, roles, permissions) resources.
• Error Handling: Learn how to manage and interpret API errors to handle failures gracefully.