Authelia

Authelia API

The full first-party Authelia HTTP API — the portal, authorization, authentication, second factor, user information, session elevation, password reset/change and OpenID Connect 1.0 surfaces. Described by Authelia's own OpenAPI 3.2.0 contract (42 paths, 78 operations, 100 schemas), published in the Authelia repository at api/openapi.yml and served by each deployment. Authelia is self-hosted, so the base URL is the operator's own deployment host; auth.example.com is the default Authelia's own contract template uses.

GitHub OpenAPI

Operations 76

GET /api/configuration Application Configuration #
GET /api/configuration/password-policy Password Policy Configuration #
HEAD /api/health Application Health #
GET /api/health Application Health #
GET /api/state User Application State #
GET /api/authz/auth-request Authorization Verification (AuthRequest) #
HEAD /api/authz/auth-request Authorization Verification (AuthRequest) #
GET /api/authz/ext-authz Authorization Verification (ExtAuthz) #
HEAD /api/authz/ext-authz Authorization Verification (ExtAuthz) #
OPTIONS /api/authz/ext-authz Authorization Verification (ExtAuthz) #
POST /api/authz/ext-authz Authorization Verification (ExtAuthz) #
PUT /api/authz/ext-authz Authorization Verification (ExtAuthz) #
PATCH /api/authz/ext-authz Authorization Verification (ExtAuthz) #
DELETE /api/authz/ext-authz Authorization Verification (ExtAuthz) #
GET /api/authz/forward-auth Authorization Verification (ForwardAuth) #
HEAD /api/authz/forward-auth Authorization Verification (ForwardAuth) #
GET /api/verify Authorization Verification (Legacy) #
HEAD /api/verify Authorization Verification (Legacy) #
OPTIONS /api/verify Authorization Verification (Legacy) #
POST /api/verify Authorization Verification (Legacy) #
PUT /api/verify Authorization Verification (Legacy) #
PATCH /api/verify Authorization Verification (Legacy) #
DELETE /api/verify Authorization Verification (Legacy) #
POST /api/firstfactor Login #
POST /api/firstfactor/reauthenticate Reauthenticate #
GET /api/firstfactor/passkey First Factor Authentication - Passkey #
POST /api/firstfactor/passkey First Factor Authentication - Passkey #
POST /api/checks/safe-redirection Check whether URI is safe to redirect to. #
POST /api/logout Logout #
POST /api/change-password Password Change #
POST /api/reset-password/identity/start Identity Verification Token Creation #
POST /api/reset-password/identity/finish Identity Verification Token Validation #
POST /api/reset-password Password Reset #
DELETE /api/reset-password Password Reset #
GET /api/user/info User Configuration #
POST /api/user/info User Configuration #
POST /api/user/info/2fa_method User Configuration #
GET /api/user/session/elevation User Session Elevation #
POST /api/user/session/elevation User Session Elevation #
PUT /api/user/session/elevation User Session Elevation #
DELETE /api/user/session/elevation/{id} User Session Elevation #
GET /api/secondfactor/totp/register TOTP Configuration Register #
PUT /api/secondfactor/totp/register TOTP Configuration Register #
POST /api/secondfactor/totp/register TOTP Configuration Register #
DELETE /api/secondfactor/totp/register TOTP Configuration Register #
GET /api/secondfactor/totp TOTP Configuration #
POST /api/secondfactor/totp Second Factor Authentication - TOTP #
DELETE /api/secondfactor/totp Second Factor Authentication - TOTP #
GET /api/secondfactor/webauthn Second Factor Authentication - WebAuthn #
POST /api/secondfactor/webauthn Second Factor Authentication - WebAuthn #
GET /api/secondfactor/webauthn/credentials WebAuthn Credentials #
PUT /api/secondfactor/webauthn/credential/register WebAuthn Credential Registration (Attestation) #
POST /api/secondfactor/webauthn/credential/register WebAuthn Credential Registration (Attestation) #
DELETE /api/secondfactor/webauthn/credential/register WebAuthn Credential Registration (Attestation) #
PUT /api/secondfactor/webauthn/credential/{credentialID} WebAuthn Credential #
DELETE /api/secondfactor/webauthn/credential/{credentialID} WebAuthn Credential #
GET /api/secondfactor/duo Second Factor Authentication - Duo Mobile Push #
POST /api/secondfactor/duo Second Factor Authentication - Duo Mobile Push #
GET /api/secondfactor/duo_devices Second Factor Authentication - Duo Mobile Push #
POST /api/secondfactor/duo_device Second Factor Authentication - Duo Mobile Push #
POST /api/secondfactor/password Second Factor Authentication - Password #
GET /.well-known/openid-configuration OpenID Connect Discovery 1.0 Document #
GET /.well-known/oauth-authorization-server OAuth 2.0 Authorization Server Metadata #
GET /jwks.json OpenID Connect 1.0 JSON Web Key Set Document #
GET /api/oidc/authorization OpenID Connect 1.0 Authorization Endpoint #
POST /api/oidc/authorization OpenID Connect 1.0 Authorization Endpoint #
POST /api/oidc/device-authorization RFC8628 OAuth 2.0 Device Authorization Grant Endpoint #
PUT /api/oidc/device-authorization RFC8628 OAuth 2.0 Device Authorization Grant Endpoint #
POST /api/oidc/pushed-authorization-request OAuth 2.0 Pushed Authorization Endpoint #
POST /api/oidc/token OpenID Connect 1.0 Token Endpoint #
POST /api/oidc/revocation OAuth 2.0 Token Revocation Endpoint #
POST /api/oidc/introspection OAuth 2.0 Token Introspection Endpoint #
GET /api/oidc/userinfo OpenID Connect 1.0 UserInfo Endpoint #
POST /api/oidc/userinfo OpenID Connect 1.0 UserInfo Endpoint #
GET /api/oidc/consent OpenID Connect 1.0 Consent Information #
POST /api/oidc/consent OpenID Connect 1.0 Consent Response #

Documentation

📖
Documentation
https://www.authelia.com/reference/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/authelia/refs/heads/main/openapi/authelia-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/authelia/authelia

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/authelia/refs/heads/main/overlays/authelia-api-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/authelia-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

authelia-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Authelia API
  description: 'Authelia is an open-source authentication and authorization server and portal fulfilling the identity and
    access management (IAM) role of information security in providing multi-factor authentication and single sign-on (SSO)
    for your applications via a web portal. Authelia is an OpenID Connect 1.0 Provider which is OpenID Certified™ allowing
    comprehensive integrations, and acts as a companion for common reverse proxies.

    '
  contact:
    name: Support
    url: https://www.authelia.com/contact/
    email: team@authelia.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: 1.0.0
servers:
- url: https://{authelia_host}
  description: 'Authelia deployment root URL. Authelia is self-hosted: substitute the host of your own deployment.'
  variables:
    authelia_host:
      default: auth.example.com
      description: Hostname of your Authelia instance. auth.example.com is the default used by Authelia's own published contract
        template.
tags:
- name: State
  description: Configuration, health and state endpoints
- name: Authentication
  description: Authentication endpoints
- name: Authorization
  description: Authorization endpoints
- name: Utilities
  description: General utilities used in several operations
- name: User Information
  description: User configuration endpoints
- name: User Elevation
  description: User session elevation endpoints
- name: Password Reset
  description: Password reset endpoints
- name: Password Change
  description: Password change endpoint
- name: First Factor
  description: First Factor Authentication
  externalDocs:
    url: https://www.authelia.com/configuration/first-factor/introduction/
- name: Second Factor
  description: TOTP, WebAuthn and Duo endpoints
  externalDocs:
    url: https://www.authelia.com/configuration/second-factor/introduction/
- name: OAuth 2.0
  description: OAuth 2.0 Endpoints
  externalDocs:
    url: https://www.authelia.com/integration/openid-connect/introduction/
- name: OpenID Connect 1.0
  description: OpenID Connect 1.0 Endpoints
  externalDocs:
    url: https://www.authelia.com/integration/openid-connect/introduction/
paths:
  /api/configuration:
    get:
      operationId: getConfiguration
      tags:
      - State
      summary: Application Configuration
      description: 'The configuration endpoint provides detailed information including available second factor methods, if
        any second factor policies exist and the TOTP period configuration.

        '
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.configuration.ConfigurationBody'
        '403':
          description: Forbidden
      security:
      - authelia_auth: []
  /api/configuration/password-policy:
    get:
      operationId: getPasswordPolicyConfiguration
      tags:
      - State
      summary: Password Policy Configuration
      description: 'The password policy configuration endpoint provides a password policy for resetting passwords.

        '
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.configuration.PasswordPolicyConfigurationBody'
  /api/health:
    head:
      operationId: headHealth
      tags:
      - State
      summary: Application Health
      description: The health check endpoint provides information about the health of Authelia.
      responses:
        '200':
          description: Successful Operation
    get:
      operationId: getHealth
      tags:
      - State
      summary: Application Health
      description: The health check endpoint provides information about the health of Authelia.
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/middlewares.Response.OK'
  /api/state:
    get:
      operationId: getState
      tags:
      - State
      summary: User Application State
      description: 'The state endpoint provides detailed information including the user, current authenticate level and Authelia''s
        configured default redirection URL.

        '
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handlers.StateResponse'
  /api/authz/auth-request:
    get:
      operationId: getAuthzAuthRequest
      tags:
      - Authorization
      summary: Authorization Verification (AuthRequest)
      description: 'The AuthRequest authorization verification endpoint provides the ability to verify if a user has the necessary
        permissions to access a specified resource with the HAPROXY, NGINX, or NGINX-based proxies.

        '
      parameters:
      - $ref: '#/components/parameters/originalMethodParam'
      - $ref: '#/components/parameters/originalURLParam'
      responses:
        '200':
          description: Successful Operation
          headers:
            remote-user:
              description: Username
              schema:
                type: string
                examples:
                - john
            remote-name:
              description: Name
              schema:
                type: string
                examples:
                - John Doe
            remote-email:
              description: Email
              schema:
                type: string
                examples:
                - john.doe@authelia.com
            remote-groups:
              description: Comma separated list of Groups
              schema:
                type: string
                examples:
                - admin,devs
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
          headers:
            location:
              description: Redirect Location for user authorization
              example: https://auth.example.com/?rd=https%3A%2F%2Fapp.example.com&rm=GET
              schema:
                type: string
                format: uri
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
      security:
      - authelia_auth: []
    head:
      operationId: headAuthzAuthRequest
      tags:
      - Authorization
      summary: Authorization Verification (AuthRequest)
      description: 'The AuthRequest authorization verification endpoint provides the ability to verify if a user has the necessary
        permissions to access a specified resource with the HAPROXY, NGINX, or NGINX-based proxies.

        '
      parameters:
      - $ref: '#/components/parameters/originalMethodParam'
      - $ref: '#/components/parameters/originalURLParam'
      responses:
        '200':
          description: Successful Operation
          headers:
            remote-user:
              description: Username
              schema:
                type: string
                examples:
                - john
            remote-name:
              description: Name
              schema:
                type: string
                examples:
                - John Doe
            remote-email:
              description: Email
              schema:
                type: string
                examples:
                - john.doe@authelia.com
            remote-groups:
              description: Comma separated list of Groups
              schema:
                type: string
                examples:
                - admin,devs
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
          headers:
            location:
              description: Redirect Location for user authorization
              example: https://auth.example.com/?rd=https%3A%2F%2Fapp.example.com&rm=GET
              schema:
                type: string
                format: uri
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
      security:
      - authelia_auth: []
  /api/authz/ext-authz:
    get:
      operationId: getAuthzExtAuthz
      tags:
      - Authorization
      summary: Authorization Verification (ExtAuthz)
      description: 'The ExtAuthz authorization verification endpoint provides the ability to verify if a user has the necessary
        permissions to access a specified resource with the Envoy proxy.


        Any arbitrary sub-path of this endpoint is also routed to the same handler, i.e. `/api/authz/ext-authz/{path}`, as
        Envoy forwards the original request path to this endpoint.

        '
      parameters:
      - $ref: '#/components/parameters/forwardedMethodParam'
      - $ref: '#/components/parameters/forwardedProtoParam'
      - $ref: '#/components/parameters/forwardedHostParam'
      - $ref: '#/components/parameters/forwardedURIParam'
      - $ref: '#/components/parameters/forwardedForParam'
      - $ref: '#/components/parameters/autheliaURLParam'
      responses:
        '200':
          description: Successful Operation
          headers:
            remote-user:
              description: Username
              schema:
                type: string
                examples:
                - john
            remote-name:
              description: Name
              schema:
                type: string
                examples:
                - John Doe
            remote-email:
              description: Email
              schema:
                type: string
                examples:
                - john.doe@authelia.com
            remote-groups:
              description: Comma separated list of Groups
              schema:
                type: string
                examples:
                - admin,devs
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '302':
          description: Found
          headers:
            location:
              description: Redirect Location for user authorization
              example: https://auth.example.com/?rd=https%3A%2F%2Fapp.example.com&rm=GET
              schema:
                type: string
                format: uri
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '303':
          description: See Other
          headers:
            location:
              description: Redirect Location for user authorization
              example: https://auth.example.com/?rd=https%3A%2F%2Fapp.example.com&rm=GET
              schema:
                type: string
                format: uri
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      security:
      - authelia_auth: []
    head:
      operationId: headAuthzExtAuthz
      tags:
      - Authorization
      summary: Authorization Verification (ExtAuthz)
      description: 'The ExtAuthz authorization verification endpoint provides the ability to verify if a user has the necessary
        permissions to access a specified resource with the Envoy proxy.


        Any arbitrary sub-path of this endpoint is also routed to the same handler, i.e. `/api/authz/ext-authz/{path}`, as
        Envoy forwards the original request path to this endpoint.

        '
      parameters:
      - $ref: '#/components/parameters/forwardedMethodParam'
      - $ref: '#/components/parameters/forwardedProtoParam'
      - $ref: '#/components/parameters/forwardedHostParam'
      - $ref: '#/components/parameters/forwardedURIParam'
      - $ref: '#/components/parameters/forwardedForParam'
      - $ref: '#/components/parameters/autheliaURLParam'
      responses:
        '200':
          description: Successful Operation
          headers:
            remote-user:
              description: Username
              schema:
                type: string
                examples:
                - john
            remote-name:
              description: Name
              schema:
                type: string
                examples:
                - John Doe
            remote-email:
              description: Email
              schema:
                type: string
                examples:
                - john.doe@authelia.com
            remote-groups:
              description: Comma separated list of Groups
              schema:
                type: string
                examples:
                - admin,devs
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '302':
          description: Found
          headers:
            location:
              description: Redirect Location for user authorization
              example: https://auth.example.com/?rd=https%3A%2F%2Fapp.example.com&rm=GET
              schema:
                type: string
                format: uri
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '303':
          description: See Other
          headers:
            location:
              description: Redirect Location for user authorization
              example: https://auth.example.com/?rd=https%3A%2F%2Fapp.example.com&rm=GET
              schema:
                type: string
                format: uri
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      security:
      - authelia_auth: []
    options:
      operationId: optionsAuthzExtAuthz
      tags:
      - Authorization
      summary: Authorization Verification (ExtAuthz)
      description: 'The ExtAuthz authorization verification endpoint provides the ability to verify if a user has the necessary
        permissions to access a specified resource with the Envoy proxy.


        Any arbitrary sub-path of this endpoint is also routed to the same handler, i.e. `/api/authz/ext-authz/{path}`, as
        Envoy forwards the original request path to this endpoint.

        '
      parameters:
      - $ref: '#/components/parameters/forwardedMethodParam'
      - $ref: '#/components/parameters/forwardedProtoParam'
      - $ref: '#/components/parameters/forwardedHostParam'
      - $ref: '#/components/parameters/forwardedURIParam'
      - $ref: '#/components/parameters/forwardedForParam'
      - $ref: '#/components/parameters/autheliaURLParam'
      responses:
        '200':
          description: Successful Operation
          headers:
            remote-user:
              description: Username
              schema:
                type: string
                examples:
                - john
            remote-name:
              description: Name
              schema:
                type: string
                examples:
                - John Doe
            remote-email:
              description: Email
              schema:
                type: string
                examples:
                - john.doe@authelia.com
            remote-groups:
              description: Comma separated list of Groups
              schema:
                type: string
                examples:
                - admin,devs
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '302':
          description: Found
          headers:
            location:
              description: Redirect Location for user authorization
              example: https://auth.example.com/?rd=https%3A%2F%2Fapp.example.com&rm=GET
              schema:
                type: string
                format: uri
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '303':
          description: See Other
          headers:
            location:
              description: Redirect Location for user authorization
              example: https://auth.example.com/?rd=https%3A%2F%2Fapp.example.com&rm=GET
              schema:
                type: string
                format: uri
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      security:
      - authelia_auth: []
    post:
      operationId: postAuthzExtAuthz
      tags:
      - Authorization
      summary: Authorization Verification (ExtAuthz)
      description: 'The ExtAuthz authorization verification endpoint provides the ability to verify if a user has the necessary
        permissions to access a specified resource with the Envoy proxy.


        Any arbitrary sub-path of this endpoint is also routed to the same handler, i.e. `/api/authz/ext-authz/{path}`, as
        Envoy forwards the original request path to this endpoint.

        '
      parameters:
      - $ref: '#/components/parameters/forwardedMethodParam'
      - $ref: '#/components/parameters/forwardedProtoParam'
      - $ref: '#/components/parameters/forwardedHostParam'
      - $ref: '#/components/parameters/forwardedURIParam'
      - $ref: '#/components/parameters/forwardedForParam'
      - $ref: '#/components/parameters/autheliaURLParam'
      responses:
        '200':
          description: Successful Operation
          headers:
            remote-user:
              description: Username
              schema:
                type: string
                examples:
                - john
            remote-name:
              description: Name
              schema:
                type: string
                examples:
                - John Doe
            remote-email:
              description: Email
              schema:
                type: string
                examples:
                - john.doe@authelia.com
            remote-groups:
              description: Comma separated list of Groups
              schema:
                type: string
                examples:
                - admin,devs
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '302':
          description: Found
          headers:
            location:
              description: Redirect Location for user authorization
              example: https://auth.example.com/?rd=https%3A%2F%2Fapp.example.com&rm=GET
              schema:
                type: string
                format: uri
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '303':
          description: See Other
          headers:
            location:
              description: Redirect Location for user authorization
              example: https://auth.example.com/?rd=https%3A%2F%2Fapp.example.com&rm=GET
              schema:
                type: string
                format: uri
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      security:
      - authelia_auth: []
    put:
      operationId: putAuthzExtAuthz
      tags:
      - Authorization
      summary: Authorization Verification (ExtAuthz)
      description: 'The ExtAuthz authorization verification endpoint provides the ability to verify if a user has the necessary
        permissions to access a specified resource with the Envoy proxy.


        Any arbitrary sub-path of this endpoint is also routed to the same handler, i.e. `/api/authz/ext-authz/{path}`, as
        Envoy forwards the original request path to this endpoint.

        '
      parameters:
      - $ref: '#/components/parameters/forwardedMethodParam'
      - $ref: '#/components/parameters/forwardedProtoParam'
      - $ref: '#/components/parameters/forwardedHostParam'
      - $ref: '#/components/parameters/forwardedURIParam'
      - $ref: '#/components/parameters/forwardedForParam'
      - $ref: '#/components/parameters/autheliaURLParam'
      responses:
        '200':
          description: Successful Operation
          headers:
            remote-user:
              description: Username
              schema:
                type: string
                examples:
                - john
            remote-name:
              description: Name
              schema:
                type: string
                examples:
                - John Doe
            remote-email:
              description: Email
              schema:
                type: string
                examples:
                - john.doe@authelia.com
            remote-groups:
              description: Comma separated list of Groups
              schema:
                type: string
                examples:
                - admin,devs
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '302':
          description: Found
          headers:
            location:
              description: Redirect Location for user authorization
              example: https://auth.example.com/?rd=https%3A%2F%2Fapp.example.com&rm=GET
              schema:
                type: string
                format: uri
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '303':
          description: See Other
          headers:
            location:
              description: Redirect Location for user authorization
              example: https://auth.example.com/?rd=https%3A%2F%2Fapp.example.com&rm=GET
              schema:
                type: string
                format: uri
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      security:
      - authelia_auth: []
    patch:
      operationId: patchAuthzExtAuthz
      tags:
      - Authorization
      summary: Authorization Verification (ExtAuthz)
      description: 'The ExtAuthz authorization verification endpoint provides the ability to verify if a user has the necessary
        permissions to access a specified resource with the Envoy proxy.


        Any arbitrary sub-path of this endpoint is also routed to the same handler, i.e. `/api/authz/ext-authz/{path}`, as
        Envoy forwards the original request path to this endpoint.

        '
      parameters:
      - $ref: '#/components/parameters/forwardedMethodParam'
      - $ref: '#/components/parameters/forwardedProtoParam'
      - $ref: '#/components/parameters/forwardedHostParam'
      - $ref: '#/components/parameters/forwardedURIParam'
      - $ref: '#/components/parameters/forwardedForParam'
      - $ref: '#/components/parameters/autheliaURLParam'
      responses:
        '200':
          description: Successful Operation
          headers:
            remote-user:
              description: Username
              schema:
                type: string
                examples:
                - john
            remote-name:
              description: Name
              schema:
                type: string
                examples:
                - John Doe
            remote-email:
              description: Email
              schema:
                type: string
                examples:
                - john.doe@authelia.com
            remote-groups:
              description: Comma separated list of Groups
              schema:
                type: string
                examples:
                - admin,devs
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '302':
          description: Found
          headers:
            location:
              description: Redirect Location for user authorization
              example: https://auth.example.com/?rd=https%3A%2F%2Fapp.example.com&rm=GET
              schema:
                type: string
                format: uri
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '303':
          description: See Other
          headers:
            location:
              description: Redirect Location for user authorization
              example: https://auth.example.com/?rd=https%3A%2F%2Fapp.example.com&rm=GET
              schema:
                type: string
                format: uri
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      security:
      - authelia_auth: []
    delete:
      operationId: deleteAuthzExtAuthz
      tags:
      - Authorization
      summary: Authorization Verification (ExtAuthz)
      description: 'The ExtAuthz authorization verification endpoint provides the ability to verify if a user has the necessary
        permissions to access a specified resource with the Envoy proxy.


        Any arbitrary sub-path of this endpoint is also routed to the same handler, i.e. `/api/authz/ext-authz/{path}`, as
        Envoy forwards the original request path to this endpoint.

        '
      parameters:
      - $ref: '#/components/parameters/forwardedMethodParam'
      - $ref: '#/components/parameters/forwardedProtoParam'
      - $ref: '#/components/parameters/forwardedHostParam'
      - $ref: '#/components/parameters/forwardedURIParam'
      - $ref: '#/components/parameters/forwardedForParam'
      - $ref: '#/components/parameters/autheliaURLParam'
      responses:
        '200':
          description: Successful Operation
          headers:
            remote-user:
              description: Username
              schema:
                type: string
                examples:
                - john
            remote-name:
              description: Name
              schema:
                type: string
                examples:
                - John Doe
            remote-email:
              description: Email
              schema:
                type: string
                examples:
                - john.doe@authelia.com
            remote-groups:
              description: Comma separated list of Groups
              schema:
                type: string
                examples:
                - admin,devs
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '302':
          description: Found
          headers:
            location:
              description: Redirect Location for user authorization
              example: https://auth.example.com/?rd=https%3A%2F%2Fapp.example.com&rm=GET
              schema:
                type: string
                format: uri
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '303':
          description: See Other
          headers:
            location:
              description: Redirect Location for user authorization
              example: https://auth.example.com/?rd=https%3A%2F%2Fapp.example.com&rm=GET
              schema:
                type: string
                format: uri
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      security:
      - authelia_auth: []
    trace:
      operationId: traceAuthzExtAuthz
      tags:
      - Authorization
      summary: Authorization Verification (ExtAuthz)
      description: 'The ExtAuthz authorization verification endpoint provides the ability to verify if a user has the necessary
        permissions to access a specified resource with the Envoy proxy.


        Any arbitrary sub-path of this endpoint is also routed to the same handler, i.e. `/api/authz/ext-authz/{path}`, as
        Envoy forwards the original request path to this endpoint.

        '
      parameters:
      - $ref: '#/components/parameters/forwardedMethodParam'
      - $ref: '#/components/parameters/forwardedProtoParam'
      - $ref: '#/components/parameters/forwardedHostParam'
      - $ref: '#/components/parameters/forwardedURIParam'
      - $ref: '#/components/parameters/forwardedForParam'
      - $ref: '#/components/parameters/autheliaURLParam'
      responses:
        '200':
          description: Successful Operation
          headers:
            remote-user:
              description: Username
              schema:
                type: string
                examples:
                - john
            remote-name:
              description: Name
              schema:
                type: string
                examples:
                - John Doe
            remote-email:
              description: Email
              schema:
                type: string
                examples:
                - john.doe@authelia.com
            remote-groups:
              description: Comma separated list of Groups
              schema:
                type: string
                examples:
                - admin,devs
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '302':
          description: Found
          headers:
            location:
              description: Redirect Location for user authorization
              example: https://auth.example.com/?rd=https%3A%2F%2Fapp.example.com&rm=GET
              schema:
                type: string
                format: uri
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '303':
          description: See Other
          headers:
            location:
              description: Redirect Location for user authorization
              example: https://auth.example.com/?rd=https%3A%2F%2Fapp.example.com&rm=GET
              schema:
                type: string
                format: uri
            set-cookie:
              description: Sets a new cookie value
              schema:
                type: string
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
      security:
      - authelia_auth: []
  /api/authz/forward-auth:
    get:
      operationId: getAuthzForwardAuth
      tags:
      - Authorization
      summary: Authorization Verification (ForwardAuth)
      description: 'The ForwardAuth authorization verification endpoint provides the ability to verify if a user has the necessary
        permissions to access a specified resource with the Traefik, Caddy, or Skipper proxies.

        '
      parameters:
      - $ref: '#/components/parameters/forwardedMethodParam'
      - $ref: '#/components/parameters/forwardedProtoParam'
      - $ref: '#/components/parameters/forwardedHostParam'
      - $ref: '#/components/parameters/forwardedURIParam'
      - $ref: '#/components/parameters/forwardedForParam'
      responses:
        '200':
          description: Successful Operation
          headers:
            remote-user:
              description: Username
              schema:
                type: string
                examples:
                - john
            remote-name:
              description: Name
              schema:
                type: string
                examples:
                - John Doe
            remote-email:
              description: Email
              sche

# --- truncated at 32 KB (270 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/authelia/refs/heads/main/openapi/authelia-api-openapi.yml