This is the documentation for the authentication API calls provided by the Eniris backend. Eniris uses these calls internally, but they may also be used by third parties who wish to integrate with any of our other APIs.

The authentication API uses 4 types of tokens:

Access tokens: An access token is a short-lived EdDSA JWT-token associated with a user, which can be used by any API client as a proof of identify for any Eniris API (api.eniris.be, neodata-ingress.eniris.be,...). A refresh token can be used to obtain an access token. An access token remains valid for precisely 5 minutes.
Refresh tokens: A refresh token is a long-lived opaque token associated with a user, which can be used to issue new refresh tokens and to create access tokens. A refresh token can either be obtained by completing a login flow (via the login call and 2FA it configured), or by renewing a valid refresh token (via the refreshtoken call). The logout call allows to invalidate a refresh token so that it may no longer be used. A refresh token remains valid for precisely 14 24-hour days.
Partial auth. tokens: A partial auth token is a short-lived opaque token associated with a user, which is obtained after login, if the user has 2FA configured. When 2FA is successful, the partial auth token is invalidated and a refresh, sudo and access token are returned. Furthermore, a partial auth token remains valid no longer than 15 minutes.
Sudo tokens: A sudo token is a short-lived EdDSA JWT token associated with a user, which can be used by any API client as a proof of identify and as a proof of presence. It is used for performing security sensitive operations such as managing 2FA, password or email changes.

To use any of our APIs, an access token must be obtained via a login flow. Documentation for the other API's is available via the following pages:

Eniris Metadata & Telemetry Query API

Eniris also provides a Python package which implements the authentication flow and facilitates communication with the API.

Response Body

200

Response Body

200