Schemas

The following reference material documents some of the schemas we publish.

JSON Schema#

Authelia publishes several JSON Schema documents. These files are published in the following URL format (with the URL also being the schema ID):

https://www.authelia.com/schemas/<version>/json-schema/<name>.json

These schemas can be added to the top of a YAML file using the following format:

# yaml-language-server: $schema=https://www.authelia.com/schemas/<version>/json-schema/<name>.json

example: 'this is just an example'

Where:

1. The <version> placeholder is in the format v<major>.<minor> i.e. for version 4.38.1 the <version> is replaced by v4.38.
2. The <name> placeholder replaced by the name of the individual JSON Schema below.
3. The following special meta versions exist:
   1. The latest version refers to the latest released version of Authelia.
   2. The next version refers to the latest commit to the master branch.

Configuration#

Schema Name: configuration

The JSON Schema document for the main configuration file.

Users Database#

Schema Name: user-database

The JSON Schema document for the users database configuration file.

TOTP Export#

Schema Name: exports.totp

The JSON Schema document for the TOTP export file.

WebAuthn Export#

Schema Name: exports.webauthn

The JSON Schema document for the WebAuthn export file.

Identifiers Export#

Schema Name: exports.identifiers

The JSON Schema document for the Identifiers export file.