ForwardAuth API

Note

See the OpenApi Schema file for detailed description of available API endpoints and formats

GET /authorize

Authorize requests.

This endpoint is called by Traefik to check if a request is authorized to access.

Status Codes

  • 200 OK – Access granted according to configuration in ForwardAuth and Auth0.

  • 401 Unauthorized – Access denied according to configuration in ForwardAuth and Auth0.

  • 307 Temporary Redirect – Redirect for authentication with Auth0

Request Headers

  • Accept – Requested content type

  • x-requested-with – Indicating ajax call

  • x-forwarded-host – Requested host (Required)

  • x-forwarded-proto – Requested protocol (Required)

  • x-forwarded-uri – Requested uri (Required)

  • x-forwarded-method – Requested method (Required)

GET /events

Get Events

Retrieve application events, contains information about events that has happened and how many of them.

Query Parameters

  • page (integer) – Page to retrieve, default page 0

  • size (integer) – Size of page, default size 20

Status Codes

  • 200 OK – Successfully retrieved a page of events.

  • 404 Not Found – Page of events does not exist.

GET /

Starting point of the application

The starting point of the application with hypermedia links is available to available parts of the application depenedning of the authorization level of the user.

Status Codes
GET /signin
Query Parameters

  • code (string) –

  • error (string) –

  • error_description (string) –

  • state (string) –

  • nonce (string) – (Required)

Status Codes
Request Headers

  • headers – (Required)

  • x-forwarded-host – (Required)

GET /signout
Query Parameters

  • accessToken (string) – (Required)

Status Codes
Request Headers

  • headers – (Required)

  • x-forwarded-host – (Required)

GET /userinfo

Get userinfo

Get userinfo of authenticated user.

Status Codes
Request Headers

  • accessToken – Access token for current user (Required)