Skip to content
Brezel Docs

Authentication

OAuth

Section titled “OAuth”

The Brezel API supports OAuth 2.0 for authentication.

API Keys

Section titled “API Keys”

The second way next to OAuth to authenticate to the Brezel API is by using API keys. API keys are bound to particular users who have created them in [User] » API Keys.

Using API keys requires the api_keys ability in one of the user’s roles. Without it, users cannot create or reactivate keys, and requests with their keys are rejected with 401. They can still list, deactivate and delete their own keys through the API.

Root users see the API keys of all users, including the owner and whether the owner may use them. The key value itself is only shown to its owner.

How to make requests in detail is also automatically documented in your Brezel system under the API Keys section.

Example Request

Section titled “Example Request”
GET https://api.brezel.io/mysystem/modules/users/resources
X-API-Key: Yu7XZij5nMoX5rfkD58CfaevmlM8iV64