repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
timestamp[s] | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
flanksource/canary-checker | dd079f0880fa2214c1a84c3aeae6799d596c0259 | 2023-05-19T12:23:14 | config/schemas/health_exec.schema.json | 156 | 2024-05-28T05:48:37.367425Z | {
"$defs": {
"ExecCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"name": {
"type": "string"
},
"script": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
}
},
"required": [
"name",
"script"
],
"type": "object"
},
"Labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"Template": {
"additionalProperties": false,
"properties": {
"expr": {
"type": "string"
},
"javascript": {
"type": "string"
},
"jsonPath": {
"type": "string"
},
"template": {
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://github.com/flanksource/canary-checker/api/v1/exec-check",
"$ref": "#/$defs/ExecCheck",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
flanksource/canary-checker | a0bd684e8406fbd428a90eeac15365e4235b8063 | 2024-03-26T09:21:23 | config/schemas/component.schema.json | 156 | 2024-05-28T05:48:37.367425Z | {
"$defs": {
"AWSConnection": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"connection": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"region": {
"type": "string"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"sessionToken": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
}
},
"type": "object"
},
"AlertManagerCheck": {
"additionalProperties": false,
"properties": {
"alerts": {
"items": {
"type": "string"
},
"type": "array"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"exclude_filters": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"filters": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"icon": {
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"relationships": {
"$ref": "#/$defs/CheckRelationship"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"Artifact": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"Authentication": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/EnvVar"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"type": "object"
},
"AwsConfigCheck": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"aggregatorName": {
"type": "string"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"query": {
"type": "string"
},
"region": {
"type": "string"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"sessionToken": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"query"
],
"type": "object"
},
"AwsConfigRuleCheck": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"complianceTypes": {
"items": {
"type": "string"
},
"type": "array"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"ignoreRules": {
"items": {
"type": "string"
},
"type": "array"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"region": {
"type": "string"
},
"rules": {
"items": {
"type": "string"
},
"type": "array"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"sessionToken": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"AzureConnection": {
"additionalProperties": false,
"properties": {
"clientID": {
"$ref": "#/$defs/EnvVar"
},
"clientSecret": {
"$ref": "#/$defs/EnvVar"
},
"connection": {
"type": "string"
},
"tenantID": {
"type": "string"
}
},
"type": "object"
},
"AzureDevopsCheck": {
"additionalProperties": false,
"properties": {
"branch": {
"items": {
"type": "string"
},
"type": "array"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"organization": {
"type": "string"
},
"personalAccessToken": {
"$ref": "#/$defs/EnvVar"
},
"pipeline": {
"type": "string"
},
"project": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"thresholdMillis": {
"type": "integer"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"variables": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"name",
"organization",
"personalAccessToken",
"project",
"pipeline",
"variables",
"branch",
"thresholdMillis"
],
"type": "object"
},
"CanarySpec": {
"additionalProperties": false,
"properties": {
"alertmanager": {
"items": {
"$ref": "#/$defs/AlertManagerCheck"
},
"type": "array"
},
"awsConfig": {
"items": {
"$ref": "#/$defs/AwsConfigCheck"
},
"type": "array"
},
"awsConfigRule": {
"items": {
"$ref": "#/$defs/AwsConfigRuleCheck"
},
"type": "array"
},
"azureDevops": {
"items": {
"$ref": "#/$defs/AzureDevopsCheck"
},
"type": "array"
},
"catalog": {
"items": {
"$ref": "#/$defs/CatalogCheck"
},
"type": "array"
},
"cloudwatch": {
"items": {
"$ref": "#/$defs/CloudWatchCheck"
},
"type": "array"
},
"configDB": {
"items": {
"$ref": "#/$defs/ConfigDBCheck"
},
"type": "array"
},
"containerd": {
"items": {
"$ref": "#/$defs/ContainerdPullCheck"
},
"type": "array"
},
"containerdPush": {
"items": {
"$ref": "#/$defs/ContainerdPushCheck"
},
"type": "array"
},
"databaseBackup": {
"items": {
"$ref": "#/$defs/DatabaseBackupCheck"
},
"type": "array"
},
"dns": {
"items": {
"$ref": "#/$defs/DNSCheck"
},
"type": "array"
},
"docker": {
"items": {
"$ref": "#/$defs/DockerPullCheck"
},
"type": "array"
},
"dockerPush": {
"items": {
"$ref": "#/$defs/DockerPushCheck"
},
"type": "array"
},
"dynatrace": {
"items": {
"$ref": "#/$defs/DynatraceCheck"
},
"type": "array"
},
"ec2": {
"items": {
"$ref": "#/$defs/EC2Check"
},
"type": "array"
},
"elasticsearch": {
"items": {
"$ref": "#/$defs/ElasticsearchCheck"
},
"type": "array"
},
"env": {
"patternProperties": {
".*": {
"$ref": "#/$defs/VarSource"
}
},
"type": "object"
},
"exec": {
"items": {
"$ref": "#/$defs/ExecCheck"
},
"type": "array"
},
"folder": {
"items": {
"$ref": "#/$defs/FolderCheck"
},
"type": "array"
},
"gitProtocol": {
"items": {
"$ref": "#/$defs/GitProtocolCheck"
},
"type": "array"
},
"github": {
"items": {
"$ref": "#/$defs/GitHubCheck"
},
"type": "array"
},
"helm": {
"items": {
"$ref": "#/$defs/HelmCheck"
},
"type": "array"
},
"http": {
"items": {
"$ref": "#/$defs/HTTPCheck"
},
"type": "array"
},
"icmp": {
"items": {
"$ref": "#/$defs/ICMPCheck"
},
"type": "array"
},
"icon": {
"type": "string"
},
"interval": {
"type": "integer"
},
"jmeter": {
"items": {
"$ref": "#/$defs/JmeterCheck"
},
"type": "array"
},
"junit": {
"items": {
"$ref": "#/$defs/JunitCheck"
},
"type": "array"
},
"kubernetes": {
"items": {
"$ref": "#/$defs/KubernetesCheck"
},
"type": "array"
},
"ldap": {
"items": {
"$ref": "#/$defs/LDAPCheck"
},
"type": "array"
},
"mongodb": {
"items": {
"$ref": "#/$defs/MongoDBCheck"
},
"type": "array"
},
"mssql": {
"items": {
"$ref": "#/$defs/MssqlCheck"
},
"type": "array"
},
"mysql": {
"items": {
"$ref": "#/$defs/MysqlCheck"
},
"type": "array"
},
"namespace": {
"items": {
"$ref": "#/$defs/NamespaceCheck"
},
"type": "array"
},
"opensearch": {
"items": {
"$ref": "#/$defs/OpenSearchCheck"
},
"type": "array"
},
"owner": {
"type": "string"
},
"pod": {
"items": {
"$ref": "#/$defs/PodCheck"
},
"type": "array"
},
"postgres": {
"items": {
"$ref": "#/$defs/PostgresCheck"
},
"type": "array"
},
"prometheus": {
"items": {
"$ref": "#/$defs/PrometheusCheck"
},
"type": "array"
},
"redis": {
"items": {
"$ref": "#/$defs/RedisCheck"
},
"type": "array"
},
"replicas": {
"type": "integer"
},
"restic": {
"items": {
"$ref": "#/$defs/ResticCheck"
},
"type": "array"
},
"resultMode": {
"type": "string"
},
"s3": {
"items": {
"$ref": "#/$defs/S3Check"
},
"type": "array"
},
"schedule": {
"type": "string"
},
"severity": {
"type": "string"
},
"tcp": {
"items": {
"$ref": "#/$defs/TCPCheck"
},
"type": "array"
},
"webhook": {
"$ref": "#/$defs/WebhookCheck"
}
},
"type": "object"
},
"CatalogCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"selector": {
"$ref": "#/$defs/ResourceSelectors"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"selector"
],
"type": "object"
},
"CheckRelationship": {
"additionalProperties": false,
"properties": {
"components": {
"items": {
"$ref": "#/$defs/LookupSpec"
},
"type": "array"
},
"configs": {
"items": {
"$ref": "#/$defs/LookupSpec"
},
"type": "array"
}
},
"type": "object"
},
"CloudWatchCheck": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"actionPrefix": {
"type": "string"
},
"alarmPrefix": {
"type": "string"
},
"alarms": {
"items": {
"type": "string"
},
"type": "array"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"region": {
"type": "string"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"sessionToken": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"state": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Component": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta"
},
"spec": {
"$ref": "#/$defs/ComponentSpec"
},
"status": {
"$ref": "#/$defs/ComponentStatus"
}
},
"type": "object"
},
"ComponentCheck": {
"additionalProperties": false,
"properties": {
"inline": {
"$ref": "#/$defs/CanarySpec"
},
"selector": {
"$ref": "#/$defs/ResourceSelector"
}
},
"type": "object"
},
"ComponentChecks": {
"items": {
"$ref": "#/$defs/ComponentCheck"
},
"type": "array"
},
"ComponentSpec": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/ComponentChecks"
},
"components": {
"items": {
"$ref": "#/$defs/ComponentSpecObject"
},
"type": "array"
},
"configs": {
"$ref": "#/$defs/ConfigQueries"
},
"forEach": {
"$ref": "#/$defs/ForEach"
},
"hidden": {
"type": "boolean"
},
"icon": {
"type": "string"
},
"id": {
"$ref": "#/$defs/Template"
},
"labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"lifecycle": {
"type": "string"
},
"logs": {
"$ref": "#/$defs/LogSelectors"
},
"lookup": {
"$ref": "#/$defs/CanarySpec"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"order": {
"type": "integer"
},
"owner": {
"type": "string"
},
"parentLookup": {
"$ref": "#/$defs/ParentLookup"
},
"properties": {
"items": {
"$ref": "#/$defs/Property"
},
"type": "array"
},
"relationships": {
"items": {
"$ref": "#/$defs/RelationshipSpec"
},
"type": "array"
},
"selectors": {
"$ref": "#/$defs/ResourceSelectors"
},
"summary": {
"$ref": "#/$defs/Summary"
},
"tooltip": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"ComponentSpecObject": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/ComponentChecks"
},
"components": {
"items": {
"$ref": "#/$defs/ComponentSpecObject"
},
"type": "array"
},
"configs": {
"$ref": "#/$defs/ConfigQueries"
},
"forEach": {
"$ref": "#/$defs/ForEach"
},
"hidden": {
"type": "boolean"
},
"icon": {
"type": "string"
},
"id": {
"$ref": "#/$defs/Template"
},
"labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"lifecycle": {
"type": "string"
},
"logs": {
"$ref": "#/$defs/LogSelectors"
},
"lookup": {
"$ref": "#/$defs/CanarySpec"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"order": {
"type": "integer"
},
"owner": {
"type": "string"
},
"parentLookup": {
"$ref": "#/$defs/ParentLookup"
},
"properties": {
"items": {
"$ref": "#/$defs/Property"
},
"type": "array"
},
"relationships": {
"items": {
"$ref": "#/$defs/RelationshipSpec"
},
"type": "array"
},
"selectors": {
"$ref": "#/$defs/ResourceSelectors"
},
"summary": {
"$ref": "#/$defs/Summary"
},
"tooltip": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"ComponentStatus": {
"additionalProperties": false,
"properties": {
"status": {
"$ref": "#/$defs/ComponentStatus"
}
},
"type": "object"
},
"ConfigDBCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"query": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"query"
],
"type": "object"
},
"ConfigLookup": {
"additionalProperties": false,
"properties": {
"config": {
"$ref": "#/$defs/ConfigQuery"
},
"display": {
"$ref": "#/$defs/Display"
},
"field": {
"type": "string"
},
"id": {
"type": "string"
}
},
"type": "object"
},
"ConfigMapKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object"
},
"ConfigQueries": {
"items": {
"$ref": "#/$defs/ConfigQuery"
},
"type": "array"
},
"ConfigQuery": {
"additionalProperties": false,
"properties": {
"agent": {
"type": "string"
},
"cache": {
"type": "string"
},
"class": {
"type": "string"
},
"external_id": {
"type": "string"
},
"fieldSelector": {
"type": "string"
},
"id": {
"type": "string"
},
"labelSelector": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"statuses": {
"$ref": "#/$defs/Items"
},
"tags": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"type": {
"type": "string"
},
"types": {
"$ref": "#/$defs/Items"
}
},
"type": "object"
},
"ContainerdPullCheck": {
"additionalProperties": false,
"properties": {
"auth": {
"$ref": "#/$defs/Authentication"
},
"description": {
"type": "string"
},
"expectedDigest": {
"type": "string"
},
"expectedSize": {
"type": "integer"
},
"icon": {
"type": "string"
},
"image": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"image"
],
"type": "object"
},
"ContainerdPushCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"image": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"type": "string"
},
"transformDeleteStrategy": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"name",
"image"
],
"type": "object"
},
"DNSCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"exactreply": {
"items": {
"type": "string"
},
"type": "array"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"minrecords": {
"type": "integer"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"port": {
"type": "integer"
},
"query": {
"type": "string"
},
"querytype": {
"type": "string"
},
"server": {
"type": "string"
},
"thresholdMillis": {
"type": "integer"
},
"timeout": {
"type": "integer"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"DatabaseBackupCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"gcp": {
"$ref": "#/$defs/GCPDatabase"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"maxAge": {
"type": "string"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Display": {
"additionalProperties": false,
"properties": {
"expr": {
"type": "string"
},
"javascript": {
"type": "string"
},
"jsonPath": {
"type": "string"
},
"template": {
"type": "string"
}
},
"type": "object"
},
"DockerPullCheck": {
"additionalProperties": false,
"properties": {
"auth": {
"$ref": "#/$defs/Authentication"
},
"description": {
"type": "string"
},
"expectedDigest": {
"type": "string"
},
"expectedSize": {
"type": "integer"
},
"icon": {
"type": "string"
},
"image": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"image"
],
"type": "object"
},
"DockerPushCheck": {
"additionalProperties": false,
"properties": {
"auth": {
"$ref": "#/$defs/Authentication"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"image": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"image"
],
"type": "object"
},
"DynatraceCheck": {
"additionalProperties": false,
"properties": {
"apiKey": {
"$ref": "#/$defs/EnvVar"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"host": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"scheme": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"EC2Check": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"ami": {
"type": "string"
},
"canaryRef": {
"items": {
"$ref": "#/$defs/LocalObjectReference"
},
"type": "array"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"keepAlive": {
"type": "boolean"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"region": {
"type": "string"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"securityGroup": {
"type": "string"
},
"sessionToken": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"timeOut": {
"type": "integer"
},
"transformDeleteStrategy": {
"type": "string"
},
"userData": {
"type": "string"
},
"waitTime": {
"type": "integer"
}
},
"required": [
"name"
],
"type": "object"
},
"ElasticsearchCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"index": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"query": {
"type": "string"
},
"results": {
"type": "integer"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"EnvVar": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"valueFrom": {
"$ref": "#/$defs/EnvVarSource"
}
},
"type": "object"
},
"EnvVarSource": {
"additionalProperties": false,
"properties": {
"configMapKeyRef": {
"$ref": "#/$defs/ConfigMapKeySelector"
},
"helmRef": {
"$ref": "#/$defs/HelmRefKeySelector"
},
"secretKeyRef": {
"$ref": "#/$defs/SecretKeySelector"
},
"serviceAccount": {
"type": "string"
}
},
"type": "object"
},
"ExecCheck": {
"additionalProperties": false,
"properties": {
"artifacts": {
"items": {
"$ref": "#/$defs/Artifact"
},
"type": "array"
},
"checkout": {
"$ref": "#/$defs/GitCheckout"
},
"connections": {
"$ref": "#/$defs/ExecConnections"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"script": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"script"
],
"type": "object"
},
"ExecConnections": {
"additionalProperties": false,
"properties": {
"aws": {
"$ref": "#/$defs/AWSConnection"
},
"azure": {
"$ref": "#/$defs/AzureConnection"
},
"gcp": {
"$ref": "#/$defs/GCPConnection"
}
},
"type": "object"
},
"FieldsV1": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"FolderCheck": {
"additionalProperties": false,
"properties": {
"availableSize": {
"type": "string"
},
"awsConnection": {
"$ref": "#/$defs/S3Connection"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"filter": {
"$ref": "#/$defs/FolderFilter"
},
"gcpConnection": {
"$ref": "#/$defs/GCSConnection"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"maxAge": {
"type": "string"
},
"maxCount": {
"type": "integer"
},
"maxSize": {
"type": "string"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"minAge": {
"type": "string"
},
"minCount": {
"type": "integer"
},
"minSize": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"path": {
"type": "string"
},
"recursive": {
"type": "boolean"
},
"sftpConnection": {
"$ref": "#/$defs/SFTPConnection"
},
"smbConnection": {
"$ref": "#/$defs/SMBConnection"
},
"test": {
"$ref": "#/$defs/Template"
},
"totalSize": {
"type": "string"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"path"
],
"type": "object"
},
"FolderFilter": {
"additionalProperties": false,
"properties": {
"maxAge": {
"type": "string"
},
"maxSize": {
"type": "string"
},
"minAge": {
"type": "string"
},
"minSize": {
"type": "string"
},
"regex": {
"type": "string"
},
"since": {
"type": "string"
}
},
"type": "object"
},
"ForEach": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/ComponentChecks"
},
"components": {
"items": {
"$ref": "#/$defs/ComponentSpec"
},
"type": "array"
},
"configs": {
"items": {
"$ref": "#/$defs/ConfigQuery"
},
"type": "array"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"relationships": {
"items": {
"$ref": "#/$defs/RelationshipSpec"
},
"type": "array"
},
"selectors": {
"$ref": "#/$defs/ResourceSelectors"
}
},
"type": "object"
},
"GCPConnection": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"credentials": {
"$ref": "#/$defs/EnvVar"
},
"endpoint": {
"type": "string"
}
},
"type": "object"
},
"GCPDatabase": {
"additionalProperties": false,
"properties": {
"gcpConnection": {
"$ref": "#/$defs/GCPConnection"
},
"instance": {
"type": "string"
},
"project": {
"type": "string"
}
},
"required": [
"project",
"instance"
],
"type": "object"
},
"GCSConnection": {
"additionalProperties": false,
"properties": {
"bucket": {
"type": "string"
},
"connection": {
"type": "string"
},
"credentials": {
"$ref": "#/$defs/EnvVar"
},
"endpoint": {
"type": "string"
}
},
"type": "object"
},
"GitCheckout": {
"additionalProperties": false,
"properties": {
"certificate": {
"$ref": "#/$defs/EnvVar"
},
"connection": {
"type": "string"
},
"destination": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"type": "object"
},
"GitHubCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"githubToken": {
"$ref": "#/$defs/EnvVar"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"query": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"query"
],
"type": "object"
},
"GitProtocolCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"filename": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"repository": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name",
"repository",
"username",
"password"
],
"type": "object"
},
"HTTPCheck": {
"additionalProperties": false,
"properties": {
"body": {
"type": "string"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"endpoint": {
"type": "string"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"headers": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"maxSSLExpiry": {
"type": "integer"
},
"method": {
"type": "string"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"ntlm": {
"type": "boolean"
},
"ntlmv2": {
"type": "boolean"
},
"oauth2": {
"$ref": "#/$defs/Oauth2Config"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"responseCodes": {
"items": {
"type": "integer"
},
"type": "array"
},
"responseContent": {
"type": "string"
},
"responseJSONContent": {
"$ref": "#/$defs/JSONCheck"
},
"templateBody": {
"type": "boolean"
},
"test": {
"$ref": "#/$defs/Template"
},
"thresholdMillis": {
"type": "integer"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"HelmCheck": {
"additionalProperties": false,
"properties": {
"auth": {
"$ref": "#/$defs/Authentication"
},
"cafile": {
"type": "string"
},
"chartmuseum": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"project": {
"type": "string"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"HelmRefKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"key"
],
"type": "object"
},
"ICMPCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"packetCount": {
"type": "integer"
},
"packetLossThreshold": {
"type": "integer"
},
"thresholdMillis": {
"type": "integer"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Items": {
"items": {
"type": "string"
},
"type": "array"
},
"JSONCheck": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"path",
"value"
],
"type": "object"
},
"JmeterCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"host": {
"type": "string"
},
"icon": {
"type": "string"
},
"jmx": {
"$ref": "#/$defs/EnvVar"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"port": {
"type": "integer"
},
"properties": {
"items": {
"type": "string"
},
"type": "array"
},
"responseDuration": {
"type": "string"
},
"systemProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"jmx"
],
"type": "object"
},
"JunitCheck": {
"additionalProperties": false,
"properties": {
"artifacts": {
"items": {
"$ref": "#/$defs/Artifact"
},
"type": "array"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"spec": true,
"test": {
"$ref": "#/$defs/Template"
},
"testResults": {
"type": "string"
},
"timeout": {
"type": "integer"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"testResults",
"spec"
],
"type": "object"
},
"KubernetesCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"kind": {
"type": "string"
},
"kubeconfig": {
"$ref": "#/$defs/EnvVar"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"namespaceSelector": {
"$ref": "#/$defs/ResourceSelector"
},
"ready": {
"type": "boolean"
},
"resource": {
"$ref": "#/$defs/ResourceSelector"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"kind"
],
"type": "object"
},
"LDAPCheck": {
"additionalProperties": false,
"properties": {
"bindDN": {
"type": "string"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"userSearch": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name",
"bindDN"
],
"type": "object"
},
"Labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"Link": {
"additionalProperties": false,
"properties": {
"icon": {
"type": "string"
},
"label": {
"type": "string"
},
"text": {
"type": "string"
},
"tooltip": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
},
"LocalObjectReference": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
}
},
"type": "object"
},
"LogSelector": {
"additionalProperties": false,
"properties": {
"labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"LogSelectors": {
"items": {
"$ref": "#/$defs/LogSelector"
},
"type": "array"
},
"Lookup": {
"additionalProperties": false,
"properties": {
"expr": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"LookupSpec": {
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/$defs/Lookup"
},
"namespace": {
"$ref": "#/$defs/Lookup"
},
"type": {
"$ref": "#/$defs/Lookup"
}
},
"type": "object"
},
"ManagedFieldsEntry": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"fieldsType": {
"type": "string"
},
"fieldsV1": {
"$ref": "#/$defs/FieldsV1"
},
"manager": {
"type": "string"
},
"operation": {
"type": "string"
},
"subresource": {
"type": "string"
},
"time": {
"$ref": "#/$defs/Time"
}
},
"type": "object"
},
"MetricLabel": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"valueExpr": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"MetricLabels": {
"items": {
"$ref": "#/$defs/MetricLabel"
},
"type": "array"
},
"Metrics": {
"additionalProperties": false,
"properties": {
"labels": {
"$ref": "#/$defs/MetricLabels"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"MongoDBCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"MssqlCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"query": {
"type": "string"
},
"results": {
"type": "integer"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"MysqlCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"query": {
"type": "string"
},
"results": {
"type": "integer"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"NamespaceCheck": {
"additionalProperties": false,
"properties": {
"deadline": {
"type": "integer"
},
"deleteTimeout": {
"type": "integer"
},
"description": {
"type": "string"
},
"expectedContent": {
"type": "string"
},
"expectedHttpStatuses": {
"items": {
"type": "integer"
},
"type": "array"
},
"httpRetryInterval": {
"type": "integer"
},
"httpTimeout": {
"type": "integer"
},
"icon": {
"type": "string"
},
"ingressHost": {
"type": "string"
},
"ingressName": {
"type": "string"
},
"ingressTimeout": {
"type": "integer"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"namespaceAnnotations": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"namespaceLabels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"namespaceNamePrefix": {
"type": "string"
},
"path": {
"type": "string"
},
"podSpec": {
"type": "string"
},
"port": {
"type": "integer"
},
"priorityClass": {
"type": "string"
},
"readyTimeout": {
"type": "integer"
},
"schedule_timeout": {
"type": "integer"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"podSpec"
],
"type": "object"
},
"Oauth2Config": {
"additionalProperties": false,
"properties": {
"params": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"scope": {
"items": {
"type": "string"
},
"type": "array"
},
"tokenURL": {
"type": "string"
}
},
"type": "object"
},
"ObjectFieldSelector": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"fieldPath": {
"type": "string"
}
},
"required": [
"fieldPath"
],
"type": "object"
},
"ObjectMeta": {
"additionalProperties": false,
"properties": {
"annotations": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"creationTimestamp": {
"$ref": "#/$defs/Time"
},
"deletionGracePeriodSeconds": {
"type": "integer"
},
"deletionTimestamp": {
"$ref": "#/$defs/Time"
},
"finalizers": {
"items": {
"type": "string"
},
"type": "array"
},
"generateName": {
"type": "string"
},
"generation": {
"type": "integer"
},
"labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"managedFields": {
"items": {
"$ref": "#/$defs/ManagedFieldsEntry"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"ownerReferences": {
"items": {
"$ref": "#/$defs/OwnerReference"
},
"type": "array"
},
"resourceVersion": {
"type": "string"
},
"selfLink": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
},
"OpenSearchCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"index": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"query": {
"type": "string"
},
"results": {
"type": "integer"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name",
"query",
"index"
],
"type": "object"
},
"OwnerReference": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"blockOwnerDeletion": {
"type": "boolean"
},
"controller": {
"type": "boolean"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name",
"uid"
],
"type": "object"
},
"ParentLookup": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"PodCheck": {
"additionalProperties": false,
"properties": {
"deadline": {
"type": "integer"
},
"deleteTimeout": {
"type": "integer"
},
"description": {
"type": "string"
},
"expectedContent": {
"type": "string"
},
"expectedHttpStatuses": {
"items": {
"type": "integer"
},
"type": "array"
},
"httpRetryInterval": {
"type": "integer"
},
"httpTimeout": {
"type": "integer"
},
"icon": {
"type": "string"
},
"ingressClass": {
"type": "string"
},
"ingressHost": {
"type": "string"
},
"ingressName": {
"type": "string"
},
"ingressTimeout": {
"type": "integer"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"path": {
"type": "string"
},
"port": {
"type": "integer"
},
"priorityClass": {
"type": "string"
},
"readyTimeout": {
"type": "integer"
},
"roundRobinNodes": {
"type": "boolean"
},
"scheduleTimeout": {
"type": "integer"
},
"spec": {
"type": "string"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"PostgresCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"query": {
"type": "string"
},
"results": {
"type": "integer"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"PrometheusCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"host": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"query": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name",
"query"
],
"type": "object"
},
"Properties": {
"items": {
"$ref": "#/$defs/Property"
},
"type": "array"
},
"Property": {
"additionalProperties": false,
"properties": {
"color": {
"type": "string"
},
"configLookup": {
"$ref": "#/$defs/ConfigLookup"
},
"headline": {
"type": "boolean"
},
"icon": {
"type": "string"
},
"label": {
"type": "string"
},
"lastTransition": {
"type": "string"
},
"links": {
"items": {
"$ref": "#/$defs/Link"
},
"type": "array"
},
"lookup": {
"$ref": "#/$defs/CanarySpec"
},
"max": {
"type": "integer"
},
"min": {
"type": "integer"
},
"name": {
"type": "string"
},
"order": {
"type": "integer"
},
"status": {
"type": "string"
},
"summary": {
"$ref": "#/$defs/Template"
},
"text": {
"type": "string"
},
"tooltip": {
"type": "string"
},
"type": {
"type": "string"
},
"unit": {
"type": "string"
},
"value": {
"type": "integer"
}
},
"type": "object"
},
"RedisCheck": {
"additionalProperties": false,
"properties": {
"addr": {
"type": "string"
},
"connection": {
"type": "string"
},
"db": {
"type": "integer"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"RelationshipSpec": {
"additionalProperties": false,
"properties": {
"ref": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"ResourceSelector": {
"additionalProperties": false,
"properties": {
"fieldSelector": {
"type": "string"
},
"labelSelector": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"ResourceSelectors": {
"items": {
"$ref": "#/$defs/ResourceSelector"
},
"type": "array"
},
"ResticCheck": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"awsConnectionName": {
"type": "string"
},
"caCert": {
"type": "string"
},
"checkIntegrity": {
"type": "boolean"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"maxAge": {
"type": "string"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"repository": {
"type": "string"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"repository",
"password",
"maxAge"
],
"type": "object"
},
"S3Check": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"bucket": {
"type": "string"
},
"bucketName": {
"type": "string"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"objectPath": {
"type": "string"
},
"region": {
"type": "string"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"sessionToken": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"transformDeleteStrategy": {
"type": "string"
},
"usePathStyle": {
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"S3Connection": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"bucket": {
"type": "string"
},
"connection": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"objectPath": {
"type": "string"
},
"region": {
"type": "string"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"sessionToken": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"usePathStyle": {
"type": "boolean"
}
},
"type": "object"
},
"SFTPConnection": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"port": {
"type": "integer"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"host"
],
"type": "object"
},
"SMBConnection": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"domain": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"port": {
"type": "integer"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"type": "object"
},
"SecretKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object"
},
"Summary": {
"additionalProperties": false,
"properties": {
"checks": {
"patternProperties": {
".*": {
"type": "integer"
}
},
"type": "object"
},
"healthy": {
"type": "integer"
},
"incidents": {
"patternProperties": {
".*": {
"patternProperties": {
".*": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"info": {
"type": "integer"
},
"insights": {
"patternProperties": {
".*": {
"patternProperties": {
".*": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"unhealthy": {
"type": "integer"
},
"warning": {
"type": "integer"
}
},
"type": "object"
},
"TCPCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"thresholdMillis": {
"type": "integer"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Template": {
"additionalProperties": false,
"properties": {
"expr": {
"type": "string"
},
"javascript": {
"type": "string"
},
"jsonPath": {
"type": "string"
},
"template": {
"type": "string"
}
},
"type": "object"
},
"Time": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"VarSource": {
"additionalProperties": false,
"properties": {
"configMapKeyRef": {
"$ref": "#/$defs/ConfigMapKeySelector"
},
"fieldRef": {
"$ref": "#/$defs/ObjectFieldSelector"
},
"secretKeyRef": {
"$ref": "#/$defs/SecretKeySelector"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"WebhookCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"token": {
"$ref": "#/$defs/EnvVar"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
},
"$id": "https://github.com/flanksource/canary-checker/api/v1/component",
"$ref": "#/$defs/Component",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
flanksource/canary-checker | 23a2a70ba2388a6bc87b1e874d768cdf83492dbc | 2023-07-18T18:11:58 | config/schemas/health_ldap.schema.json | 156 | 2024-05-28T05:48:37.367425Z | {
"$defs": {
"ConfigMapKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"key"
],
"type": "object"
},
"EnvVar": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"valueFrom": {
"$ref": "#/$defs/EnvVarSource"
}
},
"type": "object"
},
"EnvVarSource": {
"additionalProperties": false,
"properties": {
"configMapKeyRef": {
"$ref": "#/$defs/ConfigMapKeySelector"
},
"secretKeyRef": {
"$ref": "#/$defs/SecretKeySelector"
}
},
"type": "object"
},
"LDAPCheck": {
"additionalProperties": false,
"properties": {
"bindDN": {
"type": "string"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"name": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"userSearch": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name",
"bindDN"
],
"type": "object"
},
"Labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"SecretKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"key"
],
"type": "object"
}
},
"$id": "https://github.com/flanksource/canary-checker/api/v1/ldap-check",
"$ref": "#/$defs/LDAPCheck",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
flanksource/canary-checker | ed6077948be6923ac96d38fdc6ec19f059b55453 | 2023-12-20T19:54:32 | config/schemas/health_exec.schema.json | 156 | 2024-05-28T05:48:37.367425Z | {
"$defs": {
"AWSConnection": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"connection": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"objectPath": {
"type": "string"
},
"region": {
"type": "string"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"sessionToken": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"usePathStyle": {
"type": "boolean"
}
},
"type": "object"
},
"Artifact": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"AzureConnection": {
"additionalProperties": false,
"properties": {
"clientID": {
"$ref": "#/$defs/EnvVar"
},
"clientSecret": {
"$ref": "#/$defs/EnvVar"
},
"connection": {
"type": "string"
},
"tenantID": {
"type": "string"
}
},
"type": "object"
},
"ConfigMapKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"key"
],
"type": "object"
},
"EnvVar": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"valueFrom": {
"$ref": "#/$defs/EnvVarSource"
}
},
"type": "object"
},
"EnvVarSource": {
"additionalProperties": false,
"properties": {
"configMapKeyRef": {
"$ref": "#/$defs/ConfigMapKeySelector"
},
"helmRef": {
"$ref": "#/$defs/HelmRefKeySelector"
},
"secretKeyRef": {
"$ref": "#/$defs/SecretKeySelector"
},
"serviceAccount": {
"type": "string"
}
},
"type": "object"
},
"ExecCheck": {
"additionalProperties": false,
"properties": {
"artifacts": {
"items": {
"$ref": "#/$defs/Artifact"
},
"type": "array"
},
"checkout": {
"$ref": "#/$defs/GitCheckout"
},
"connections": {
"$ref": "#/$defs/ExecConnections"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"script": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"script"
],
"type": "object"
},
"ExecConnections": {
"additionalProperties": false,
"properties": {
"aws": {
"$ref": "#/$defs/AWSConnection"
},
"azure": {
"$ref": "#/$defs/AzureConnection"
},
"gcp": {
"$ref": "#/$defs/GCPConnection"
}
},
"type": "object"
},
"GCPConnection": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"credentials": {
"$ref": "#/$defs/EnvVar"
},
"endpoint": {
"type": "string"
}
},
"type": "object"
},
"GitCheckout": {
"additionalProperties": false,
"properties": {
"certificate": {
"$ref": "#/$defs/EnvVar"
},
"connection": {
"type": "string"
},
"destination": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"type": "object"
},
"HelmRefKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"key"
],
"type": "object"
},
"Labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"MetricLabel": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"valueExpr": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"MetricLabels": {
"items": {
"$ref": "#/$defs/MetricLabel"
},
"type": "array"
},
"Metrics": {
"additionalProperties": false,
"properties": {
"labels": {
"$ref": "#/$defs/MetricLabels"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"SecretKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"key"
],
"type": "object"
},
"Template": {
"additionalProperties": false,
"properties": {
"expr": {
"type": "string"
},
"javascript": {
"type": "string"
},
"jsonPath": {
"type": "string"
},
"template": {
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://github.com/flanksource/canary-checker/api/v1/exec-check",
"$ref": "#/$defs/ExecCheck",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
flanksource/canary-checker | 1aa9de327a23967f7354e409a01cb3377e4b66a4 | 2023-12-21T03:47:25 | config/schemas/topology.schema.json | 156 | 2024-05-28T05:48:37.367425Z | {
"$defs": {
"AWSConnection": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"connection": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"objectPath": {
"type": "string"
},
"region": {
"type": "string"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"sessionToken": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"usePathStyle": {
"type": "boolean"
}
},
"type": "object"
},
"AlertManagerCheck": {
"additionalProperties": false,
"properties": {
"alerts": {
"items": {
"type": "string"
},
"type": "array"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"exclude_filters": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"filters": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"icon": {
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"relationships": {
"$ref": "#/$defs/CheckRelationship"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"Artifact": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"Authentication": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/EnvVar"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"type": "object"
},
"AwsConfigCheck": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"aggregatorName": {
"type": "string"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"objectPath": {
"type": "string"
},
"query": {
"type": "string"
},
"region": {
"type": "string"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"sessionToken": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"usePathStyle": {
"type": "boolean"
}
},
"required": [
"name",
"query"
],
"type": "object"
},
"AwsConfigRuleCheck": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"complianceTypes": {
"items": {
"type": "string"
},
"type": "array"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"ignoreRules": {
"items": {
"type": "string"
},
"type": "array"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"objectPath": {
"type": "string"
},
"region": {
"type": "string"
},
"rules": {
"items": {
"type": "string"
},
"type": "array"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"sessionToken": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"usePathStyle": {
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"AzureConnection": {
"additionalProperties": false,
"properties": {
"clientID": {
"$ref": "#/$defs/EnvVar"
},
"clientSecret": {
"$ref": "#/$defs/EnvVar"
},
"connection": {
"type": "string"
},
"tenantID": {
"type": "string"
}
},
"type": "object"
},
"AzureDevopsCheck": {
"additionalProperties": false,
"properties": {
"branch": {
"items": {
"type": "string"
},
"type": "array"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"organization": {
"type": "string"
},
"personalAccessToken": {
"$ref": "#/$defs/EnvVar"
},
"pipeline": {
"type": "string"
},
"project": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"thresholdMillis": {
"type": "integer"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"variables": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"name",
"organization",
"personalAccessToken",
"project",
"pipeline",
"variables",
"branch",
"thresholdMillis"
],
"type": "object"
},
"CanarySpec": {
"additionalProperties": false,
"properties": {
"alertmanager": {
"items": {
"$ref": "#/$defs/AlertManagerCheck"
},
"type": "array"
},
"awsConfig": {
"items": {
"$ref": "#/$defs/AwsConfigCheck"
},
"type": "array"
},
"awsConfigRule": {
"items": {
"$ref": "#/$defs/AwsConfigRuleCheck"
},
"type": "array"
},
"azureDevops": {
"items": {
"$ref": "#/$defs/AzureDevopsCheck"
},
"type": "array"
},
"cloudwatch": {
"items": {
"$ref": "#/$defs/CloudWatchCheck"
},
"type": "array"
},
"configDB": {
"items": {
"$ref": "#/$defs/ConfigDBCheck"
},
"type": "array"
},
"containerd": {
"items": {
"$ref": "#/$defs/ContainerdPullCheck"
},
"type": "array"
},
"containerdPush": {
"items": {
"$ref": "#/$defs/ContainerdPushCheck"
},
"type": "array"
},
"databaseBackup": {
"items": {
"$ref": "#/$defs/DatabaseBackupCheck"
},
"type": "array"
},
"dns": {
"items": {
"$ref": "#/$defs/DNSCheck"
},
"type": "array"
},
"docker": {
"items": {
"$ref": "#/$defs/DockerPullCheck"
},
"type": "array"
},
"dockerPush": {
"items": {
"$ref": "#/$defs/DockerPushCheck"
},
"type": "array"
},
"dynatrace": {
"items": {
"$ref": "#/$defs/DynatraceCheck"
},
"type": "array"
},
"ec2": {
"items": {
"$ref": "#/$defs/EC2Check"
},
"type": "array"
},
"elasticsearch": {
"items": {
"$ref": "#/$defs/ElasticsearchCheck"
},
"type": "array"
},
"env": {
"patternProperties": {
".*": {
"$ref": "#/$defs/VarSource"
}
},
"type": "object"
},
"exec": {
"items": {
"$ref": "#/$defs/ExecCheck"
},
"type": "array"
},
"folder": {
"items": {
"$ref": "#/$defs/FolderCheck"
},
"type": "array"
},
"github": {
"items": {
"$ref": "#/$defs/GitHubCheck"
},
"type": "array"
},
"helm": {
"items": {
"$ref": "#/$defs/HelmCheck"
},
"type": "array"
},
"http": {
"items": {
"$ref": "#/$defs/HTTPCheck"
},
"type": "array"
},
"icmp": {
"items": {
"$ref": "#/$defs/ICMPCheck"
},
"type": "array"
},
"icon": {
"type": "string"
},
"interval": {
"type": "integer"
},
"jmeter": {
"items": {
"$ref": "#/$defs/JmeterCheck"
},
"type": "array"
},
"junit": {
"items": {
"$ref": "#/$defs/JunitCheck"
},
"type": "array"
},
"kubernetes": {
"items": {
"$ref": "#/$defs/KubernetesCheck"
},
"type": "array"
},
"ldap": {
"items": {
"$ref": "#/$defs/LDAPCheck"
},
"type": "array"
},
"mongodb": {
"items": {
"$ref": "#/$defs/MongoDBCheck"
},
"type": "array"
},
"mssql": {
"items": {
"$ref": "#/$defs/MssqlCheck"
},
"type": "array"
},
"mysql": {
"items": {
"$ref": "#/$defs/MysqlCheck"
},
"type": "array"
},
"namespace": {
"items": {
"$ref": "#/$defs/NamespaceCheck"
},
"type": "array"
},
"opensearch": {
"items": {
"$ref": "#/$defs/OpenSearchCheck"
},
"type": "array"
},
"owner": {
"type": "string"
},
"pod": {
"items": {
"$ref": "#/$defs/PodCheck"
},
"type": "array"
},
"postgres": {
"items": {
"$ref": "#/$defs/PostgresCheck"
},
"type": "array"
},
"prometheus": {
"items": {
"$ref": "#/$defs/PrometheusCheck"
},
"type": "array"
},
"redis": {
"items": {
"$ref": "#/$defs/RedisCheck"
},
"type": "array"
},
"replicas": {
"type": "integer"
},
"restic": {
"items": {
"$ref": "#/$defs/ResticCheck"
},
"type": "array"
},
"resultMode": {
"type": "string"
},
"s3": {
"items": {
"$ref": "#/$defs/S3Check"
},
"type": "array"
},
"schedule": {
"type": "string"
},
"severity": {
"type": "string"
},
"tcp": {
"items": {
"$ref": "#/$defs/TCPCheck"
},
"type": "array"
},
"webhook": {
"$ref": "#/$defs/WebhookCheck"
}
},
"type": "object"
},
"CheckRelationship": {
"additionalProperties": false,
"properties": {
"components": {
"items": {
"$ref": "#/$defs/LookupSpec"
},
"type": "array"
},
"configs": {
"items": {
"$ref": "#/$defs/LookupSpec"
},
"type": "array"
}
},
"type": "object"
},
"CloudWatchCheck": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"actionPrefix": {
"type": "string"
},
"alarmPrefix": {
"type": "string"
},
"alarms": {
"items": {
"type": "string"
},
"type": "array"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"objectPath": {
"type": "string"
},
"region": {
"type": "string"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"sessionToken": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"state": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"usePathStyle": {
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ComponentCheck": {
"additionalProperties": false,
"properties": {
"inline": {
"$ref": "#/$defs/CanarySpec"
},
"selector": {
"$ref": "#/$defs/ResourceSelector"
}
},
"type": "object"
},
"ComponentChecks": {
"items": {
"$ref": "#/$defs/ComponentCheck"
},
"type": "array"
},
"ComponentSpec": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/ComponentChecks"
},
"components": {
"items": {
"$ref": "#/$defs/ComponentSpecObject"
},
"type": "array"
},
"configs": {
"items": {
"$ref": "#/$defs/Config"
},
"type": "array"
},
"forEach": {
"$ref": "#/$defs/ForEach"
},
"icon": {
"type": "string"
},
"id": {
"$ref": "#/$defs/Template"
},
"labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"lifecycle": {
"type": "string"
},
"logs": {
"$ref": "#/$defs/LogSelectors"
},
"lookup": {
"$ref": "#/$defs/CanarySpec"
},
"name": {
"type": "string"
},
"order": {
"type": "integer"
},
"owner": {
"type": "string"
},
"properties": {
"items": {
"$ref": "#/$defs/Property"
},
"type": "array"
},
"relationships": {
"items": {
"$ref": "#/$defs/RelationshipSpec"
},
"type": "array"
},
"selectors": {
"$ref": "#/$defs/ResourceSelectors"
},
"summary": {
"$ref": "#/$defs/Summary"
},
"tooltip": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"ComponentSpecObject": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/ComponentChecks"
},
"components": {
"items": {
"$ref": "#/$defs/ComponentSpecObject"
},
"type": "array"
},
"configs": {
"items": {
"$ref": "#/$defs/Config"
},
"type": "array"
},
"forEach": {
"$ref": "#/$defs/ForEach"
},
"icon": {
"type": "string"
},
"id": {
"$ref": "#/$defs/Template"
},
"labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"lifecycle": {
"type": "string"
},
"logs": {
"$ref": "#/$defs/LogSelectors"
},
"lookup": {
"$ref": "#/$defs/CanarySpec"
},
"name": {
"type": "string"
},
"order": {
"type": "integer"
},
"owner": {
"type": "string"
},
"properties": {
"items": {
"$ref": "#/$defs/Property"
},
"type": "array"
},
"relationships": {
"items": {
"$ref": "#/$defs/RelationshipSpec"
},
"type": "array"
},
"selectors": {
"$ref": "#/$defs/ResourceSelectors"
},
"summary": {
"$ref": "#/$defs/Summary"
},
"tooltip": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"Config": {
"additionalProperties": false,
"properties": {
"id": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"tags": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"ConfigDBCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"query": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"query"
],
"type": "object"
},
"ConfigLookup": {
"additionalProperties": false,
"properties": {
"config": {
"$ref": "#/$defs/Config"
},
"display": {
"$ref": "#/$defs/Display"
},
"field": {
"type": "string"
},
"id": {
"type": "string"
}
},
"type": "object"
},
"ConfigMapKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object"
},
"ContainerdPullCheck": {
"additionalProperties": false,
"properties": {
"auth": {
"$ref": "#/$defs/Authentication"
},
"description": {
"type": "string"
},
"expectedDigest": {
"type": "string"
},
"expectedSize": {
"type": "integer"
},
"icon": {
"type": "string"
},
"image": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"image"
],
"type": "object"
},
"ContainerdPushCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"image": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"type": "string"
},
"transformDeleteStrategy": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"name",
"image"
],
"type": "object"
},
"DNSCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"exactreply": {
"items": {
"type": "string"
},
"type": "array"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"minrecords": {
"type": "integer"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"port": {
"type": "integer"
},
"query": {
"type": "string"
},
"querytype": {
"type": "string"
},
"server": {
"type": "string"
},
"thresholdMillis": {
"type": "integer"
},
"timeout": {
"type": "integer"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"DatabaseBackupCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"gcp": {
"$ref": "#/$defs/GCPDatabase"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"maxAge": {
"type": "string"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Display": {
"additionalProperties": false,
"properties": {
"expr": {
"type": "string"
},
"javascript": {
"type": "string"
},
"jsonPath": {
"type": "string"
},
"template": {
"type": "string"
}
},
"type": "object"
},
"DockerPullCheck": {
"additionalProperties": false,
"properties": {
"auth": {
"$ref": "#/$defs/Authentication"
},
"description": {
"type": "string"
},
"expectedDigest": {
"type": "string"
},
"expectedSize": {
"type": "integer"
},
"icon": {
"type": "string"
},
"image": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"image"
],
"type": "object"
},
"DockerPushCheck": {
"additionalProperties": false,
"properties": {
"auth": {
"$ref": "#/$defs/Authentication"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"image": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"image"
],
"type": "object"
},
"DynatraceCheck": {
"additionalProperties": false,
"properties": {
"apiKey": {
"$ref": "#/$defs/EnvVar"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"host": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"scheme": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"EC2Check": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"ami": {
"type": "string"
},
"canaryRef": {
"items": {
"$ref": "#/$defs/LocalObjectReference"
},
"type": "array"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"keepAlive": {
"type": "boolean"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"objectPath": {
"type": "string"
},
"region": {
"type": "string"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"securityGroup": {
"type": "string"
},
"sessionToken": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"timeOut": {
"type": "integer"
},
"transformDeleteStrategy": {
"type": "string"
},
"usePathStyle": {
"type": "boolean"
},
"userData": {
"type": "string"
},
"waitTime": {
"type": "integer"
}
},
"required": [
"name"
],
"type": "object"
},
"ElasticsearchCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"index": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"query": {
"type": "string"
},
"results": {
"type": "integer"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"EnvVar": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"valueFrom": {
"$ref": "#/$defs/EnvVarSource"
}
},
"type": "object"
},
"EnvVarSource": {
"additionalProperties": false,
"properties": {
"configMapKeyRef": {
"$ref": "#/$defs/ConfigMapKeySelector"
},
"helmRef": {
"$ref": "#/$defs/HelmRefKeySelector"
},
"secretKeyRef": {
"$ref": "#/$defs/SecretKeySelector"
},
"serviceAccount": {
"type": "string"
}
},
"type": "object"
},
"ExecCheck": {
"additionalProperties": false,
"properties": {
"artifacts": {
"items": {
"$ref": "#/$defs/Artifact"
},
"type": "array"
},
"checkout": {
"$ref": "#/$defs/GitCheckout"
},
"connections": {
"$ref": "#/$defs/ExecConnections"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"script": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"script"
],
"type": "object"
},
"ExecConnections": {
"additionalProperties": false,
"properties": {
"aws": {
"$ref": "#/$defs/AWSConnection"
},
"azure": {
"$ref": "#/$defs/AzureConnection"
},
"gcp": {
"$ref": "#/$defs/GCPConnection"
}
},
"type": "object"
},
"FieldsV1": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"FolderCheck": {
"additionalProperties": false,
"properties": {
"availableSize": {
"type": "string"
},
"awsConnection": {
"$ref": "#/$defs/AWSConnection"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"filter": {
"$ref": "#/$defs/FolderFilter"
},
"gcpConnection": {
"$ref": "#/$defs/GCPConnection"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"maxAge": {
"type": "string"
},
"maxCount": {
"type": "integer"
},
"maxSize": {
"type": "string"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"minAge": {
"type": "string"
},
"minCount": {
"type": "integer"
},
"minSize": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"path": {
"type": "string"
},
"recursive": {
"type": "boolean"
},
"sftpConnection": {
"$ref": "#/$defs/SFTPConnection"
},
"smbConnection": {
"$ref": "#/$defs/SMBConnection"
},
"test": {
"$ref": "#/$defs/Template"
},
"totalSize": {
"type": "string"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"path"
],
"type": "object"
},
"FolderFilter": {
"additionalProperties": false,
"properties": {
"maxAge": {
"type": "string"
},
"maxSize": {
"type": "string"
},
"minAge": {
"type": "string"
},
"minSize": {
"type": "string"
},
"regex": {
"type": "string"
},
"since": {
"type": "string"
}
},
"type": "object"
},
"ForEach": {
"additionalProperties": false,
"properties": {
"checks": {
"$ref": "#/$defs/ComponentChecks"
},
"components": {
"items": {
"$ref": "#/$defs/ComponentSpec"
},
"type": "array"
},
"configs": {
"items": {
"$ref": "#/$defs/Config"
},
"type": "array"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"relationships": {
"items": {
"$ref": "#/$defs/RelationshipSpec"
},
"type": "array"
},
"selectors": {
"$ref": "#/$defs/ResourceSelectors"
}
},
"type": "object"
},
"GCPConnection": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"credentials": {
"$ref": "#/$defs/EnvVar"
},
"endpoint": {
"type": "string"
}
},
"type": "object"
},
"GCPDatabase": {
"additionalProperties": false,
"properties": {
"gcpConnection": {
"$ref": "#/$defs/GCPConnection"
},
"instance": {
"type": "string"
},
"project": {
"type": "string"
}
},
"required": [
"project",
"instance"
],
"type": "object"
},
"GitCheckout": {
"additionalProperties": false,
"properties": {
"certificate": {
"$ref": "#/$defs/EnvVar"
},
"connection": {
"type": "string"
},
"destination": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"type": "object"
},
"GitHubCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"githubToken": {
"$ref": "#/$defs/EnvVar"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"query": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"query"
],
"type": "object"
},
"HTTPCheck": {
"additionalProperties": false,
"properties": {
"body": {
"type": "string"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"endpoint": {
"type": "string"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"headers": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"maxSSLExpiry": {
"type": "integer"
},
"method": {
"type": "string"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"ntlm": {
"type": "boolean"
},
"ntlmv2": {
"type": "boolean"
},
"oauth2": {
"$ref": "#/$defs/Oauth2Config"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"responseCodes": {
"items": {
"type": "integer"
},
"type": "array"
},
"responseContent": {
"type": "string"
},
"responseJSONContent": {
"$ref": "#/$defs/JSONCheck"
},
"templateBody": {
"type": "boolean"
},
"test": {
"$ref": "#/$defs/Template"
},
"thresholdMillis": {
"type": "integer"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"HelmCheck": {
"additionalProperties": false,
"properties": {
"auth": {
"$ref": "#/$defs/Authentication"
},
"cafile": {
"type": "string"
},
"chartmuseum": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"project": {
"type": "string"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"HelmRefKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"key"
],
"type": "object"
},
"ICMPCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"packetCount": {
"type": "integer"
},
"packetLossThreshold": {
"type": "integer"
},
"thresholdMillis": {
"type": "integer"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"JSONCheck": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"path",
"value"
],
"type": "object"
},
"JmeterCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"host": {
"type": "string"
},
"icon": {
"type": "string"
},
"jmx": {
"$ref": "#/$defs/EnvVar"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"port": {
"type": "integer"
},
"properties": {
"items": {
"type": "string"
},
"type": "array"
},
"responseDuration": {
"type": "string"
},
"systemProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"jmx"
],
"type": "object"
},
"JunitCheck": {
"additionalProperties": false,
"properties": {
"artifacts": {
"items": {
"$ref": "#/$defs/Artifact"
},
"type": "array"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"spec": true,
"test": {
"$ref": "#/$defs/Template"
},
"testResults": {
"type": "string"
},
"timeout": {
"type": "integer"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"testResults",
"spec"
],
"type": "object"
},
"KubernetesCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"kind": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"$ref": "#/$defs/ResourceSelector"
},
"ready": {
"type": "boolean"
},
"resource": {
"$ref": "#/$defs/ResourceSelector"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"kind"
],
"type": "object"
},
"LDAPCheck": {
"additionalProperties": false,
"properties": {
"bindDN": {
"type": "string"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"userSearch": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name",
"bindDN"
],
"type": "object"
},
"Labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"Link": {
"additionalProperties": false,
"properties": {
"icon": {
"type": "string"
},
"label": {
"type": "string"
},
"text": {
"type": "string"
},
"tooltip": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
}
},
"type": "object"
},
"LocalObjectReference": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
}
},
"type": "object"
},
"LogSelector": {
"additionalProperties": false,
"properties": {
"labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"LogSelectors": {
"items": {
"$ref": "#/$defs/LogSelector"
},
"type": "array"
},
"Lookup": {
"additionalProperties": false,
"properties": {
"expr": {
"type": "string"
},
"label": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"LookupSpec": {
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/$defs/Lookup"
},
"namespace": {
"$ref": "#/$defs/Lookup"
},
"type": {
"$ref": "#/$defs/Lookup"
}
},
"type": "object"
},
"ManagedFieldsEntry": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"fieldsType": {
"type": "string"
},
"fieldsV1": {
"$ref": "#/$defs/FieldsV1"
},
"manager": {
"type": "string"
},
"operation": {
"type": "string"
},
"subresource": {
"type": "string"
},
"time": {
"$ref": "#/$defs/Time"
}
},
"type": "object"
},
"MetricLabel": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"valueExpr": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"MetricLabels": {
"items": {
"$ref": "#/$defs/MetricLabel"
},
"type": "array"
},
"Metrics": {
"additionalProperties": false,
"properties": {
"labels": {
"$ref": "#/$defs/MetricLabels"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"MongoDBCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"MssqlCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"query": {
"type": "string"
},
"results": {
"type": "integer"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"MysqlCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"query": {
"type": "string"
},
"results": {
"type": "integer"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"NamespaceCheck": {
"additionalProperties": false,
"properties": {
"deadline": {
"type": "integer"
},
"deleteTimeout": {
"type": "integer"
},
"description": {
"type": "string"
},
"expectedContent": {
"type": "string"
},
"expectedHttpStatuses": {
"items": {
"type": "integer"
},
"type": "array"
},
"httpRetryInterval": {
"type": "integer"
},
"httpTimeout": {
"type": "integer"
},
"icon": {
"type": "string"
},
"ingressHost": {
"type": "string"
},
"ingressName": {
"type": "string"
},
"ingressTimeout": {
"type": "integer"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"namespaceAnnotations": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"namespaceLabels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"namespaceNamePrefix": {
"type": "string"
},
"path": {
"type": "string"
},
"podSpec": {
"type": "string"
},
"port": {
"type": "integer"
},
"priorityClass": {
"type": "string"
},
"readyTimeout": {
"type": "integer"
},
"schedule_timeout": {
"type": "integer"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"podSpec"
],
"type": "object"
},
"Oauth2Config": {
"additionalProperties": false,
"properties": {
"params": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"scope": {
"items": {
"type": "string"
},
"type": "array"
},
"tokenURL": {
"type": "string"
}
},
"type": "object"
},
"ObjectFieldSelector": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"fieldPath": {
"type": "string"
}
},
"required": [
"fieldPath"
],
"type": "object"
},
"ObjectMeta": {
"additionalProperties": false,
"properties": {
"annotations": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"creationTimestamp": {
"$ref": "#/$defs/Time"
},
"deletionGracePeriodSeconds": {
"type": "integer"
},
"deletionTimestamp": {
"$ref": "#/$defs/Time"
},
"finalizers": {
"items": {
"type": "string"
},
"type": "array"
},
"generateName": {
"type": "string"
},
"generation": {
"type": "integer"
},
"labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"managedFields": {
"items": {
"$ref": "#/$defs/ManagedFieldsEntry"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"ownerReferences": {
"items": {
"$ref": "#/$defs/OwnerReference"
},
"type": "array"
},
"resourceVersion": {
"type": "string"
},
"selfLink": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
},
"OpenSearchCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"index": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"query": {
"type": "string"
},
"results": {
"type": "integer"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name",
"query",
"index"
],
"type": "object"
},
"OwnerReference": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"blockOwnerDeletion": {
"type": "boolean"
},
"controller": {
"type": "boolean"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name",
"uid"
],
"type": "object"
},
"PodCheck": {
"additionalProperties": false,
"properties": {
"deadline": {
"type": "integer"
},
"deleteTimeout": {
"type": "integer"
},
"description": {
"type": "string"
},
"expectedContent": {
"type": "string"
},
"expectedHttpStatuses": {
"items": {
"type": "integer"
},
"type": "array"
},
"httpRetryInterval": {
"type": "integer"
},
"httpTimeout": {
"type": "integer"
},
"icon": {
"type": "string"
},
"ingressClass": {
"type": "string"
},
"ingressHost": {
"type": "string"
},
"ingressName": {
"type": "string"
},
"ingressTimeout": {
"type": "integer"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"path": {
"type": "string"
},
"port": {
"type": "integer"
},
"priorityClass": {
"type": "string"
},
"readyTimeout": {
"type": "integer"
},
"roundRobinNodes": {
"type": "boolean"
},
"scheduleTimeout": {
"type": "integer"
},
"spec": {
"type": "string"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"PostgresCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"query": {
"type": "string"
},
"results": {
"type": "integer"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"PrometheusCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"host": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"query": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name",
"query"
],
"type": "object"
},
"Properties": {
"items": {
"$ref": "#/$defs/Property"
},
"type": "array"
},
"Property": {
"additionalProperties": false,
"properties": {
"color": {
"type": "string"
},
"configLookup": {
"$ref": "#/$defs/ConfigLookup"
},
"headline": {
"type": "boolean"
},
"icon": {
"type": "string"
},
"label": {
"type": "string"
},
"lastTransition": {
"type": "string"
},
"links": {
"items": {
"$ref": "#/$defs/Link"
},
"type": "array"
},
"lookup": {
"$ref": "#/$defs/CanarySpec"
},
"max": {
"type": "integer"
},
"min": {
"type": "integer"
},
"name": {
"type": "string"
},
"order": {
"type": "integer"
},
"status": {
"type": "string"
},
"summary": {
"$ref": "#/$defs/Template"
},
"text": {
"type": "string"
},
"tooltip": {
"type": "string"
},
"type": {
"type": "string"
},
"unit": {
"type": "string"
},
"value": {
"type": "integer"
}
},
"type": "object"
},
"RedisCheck": {
"additionalProperties": false,
"properties": {
"addr": {
"type": "string"
},
"connection": {
"type": "string"
},
"db": {
"type": "integer"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"RelationshipSpec": {
"additionalProperties": false,
"properties": {
"ref": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"ResourceSelector": {
"additionalProperties": false,
"properties": {
"fieldSelector": {
"type": "string"
},
"labelSelector": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"ResourceSelectors": {
"items": {
"$ref": "#/$defs/ResourceSelector"
},
"type": "array"
},
"ResticCheck": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"awsConnectionName": {
"type": "string"
},
"caCert": {
"type": "string"
},
"checkIntegrity": {
"type": "boolean"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"maxAge": {
"type": "string"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"repository": {
"type": "string"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"repository",
"password",
"maxAge"
],
"type": "object"
},
"S3Check": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"bucketName": {
"type": "string"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"objectPath": {
"type": "string"
},
"region": {
"type": "string"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"sessionToken": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"transformDeleteStrategy": {
"type": "string"
},
"usePathStyle": {
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"SFTPConnection": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"port": {
"type": "integer"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"host"
],
"type": "object"
},
"SMBConnection": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"domain": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"port": {
"type": "integer"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"type": "object"
},
"SecretKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object"
},
"Summary": {
"additionalProperties": false,
"properties": {
"healthy": {
"type": "integer"
},
"incidents": {
"patternProperties": {
".*": {
"patternProperties": {
".*": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"info": {
"type": "integer"
},
"insights": {
"patternProperties": {
".*": {
"patternProperties": {
".*": {
"type": "integer"
}
},
"type": "object"
}
},
"type": "object"
},
"unhealthy": {
"type": "integer"
},
"warning": {
"type": "integer"
}
},
"type": "object"
},
"TCPCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"thresholdMillis": {
"type": "integer"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Template": {
"additionalProperties": false,
"properties": {
"expr": {
"type": "string"
},
"javascript": {
"type": "string"
},
"jsonPath": {
"type": "string"
},
"template": {
"type": "string"
}
},
"type": "object"
},
"Time": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"Topology": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta"
},
"spec": {
"$ref": "#/$defs/TopologySpec"
},
"status": {
"$ref": "#/$defs/TopologyStatus"
}
},
"type": "object"
},
"TopologySpec": {
"additionalProperties": false,
"properties": {
"components": {
"items": {
"$ref": "#/$defs/ComponentSpec"
},
"type": "array"
},
"configs": {
"items": {
"$ref": "#/$defs/Config"
},
"type": "array"
},
"icon": {
"type": "string"
},
"id": {
"$ref": "#/$defs/Template"
},
"label": {
"type": "string"
},
"owner": {
"type": "string"
},
"properties": {
"$ref": "#/$defs/Properties"
},
"schedule": {
"type": "string"
},
"text": {
"type": "string"
},
"tooltip": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"TopologyStatus": {
"additionalProperties": false,
"properties": {
"observedGeneration": {
"type": "integer"
},
"persistentID": {
"type": "string"
},
"status": {
"type": "string"
}
},
"type": "object"
},
"VarSource": {
"additionalProperties": false,
"properties": {
"configMapKeyRef": {
"$ref": "#/$defs/ConfigMapKeySelector"
},
"fieldRef": {
"$ref": "#/$defs/ObjectFieldSelector"
},
"secretKeyRef": {
"$ref": "#/$defs/SecretKeySelector"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"WebhookCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"token": {
"$ref": "#/$defs/EnvVar"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
},
"$id": "https://github.com/flanksource/canary-checker/api/v1/topology",
"$ref": "#/$defs/Topology",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
flanksource/canary-checker | e438bd9c662f06acc45fbc108c7c9b8dfaa60517 | 2023-12-21T05:45:25 | config/schemas/health_ec2.schema.json | 156 | 2024-05-28T05:48:37.367425Z | {
"$defs": {
"ConfigMapKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"key"
],
"type": "object"
},
"EC2Check": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"ami": {
"type": "string"
},
"canaryRef": {
"items": {
"$ref": "#/$defs/LocalObjectReference"
},
"type": "array"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"keepAlive": {
"type": "boolean"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"region": {
"type": "string"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"securityGroup": {
"type": "string"
},
"sessionToken": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"timeOut": {
"type": "integer"
},
"transformDeleteStrategy": {
"type": "string"
},
"userData": {
"type": "string"
},
"waitTime": {
"type": "integer"
}
},
"required": [
"name"
],
"type": "object"
},
"EnvVar": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"valueFrom": {
"$ref": "#/$defs/EnvVarSource"
}
},
"type": "object"
},
"EnvVarSource": {
"additionalProperties": false,
"properties": {
"configMapKeyRef": {
"$ref": "#/$defs/ConfigMapKeySelector"
},
"helmRef": {
"$ref": "#/$defs/HelmRefKeySelector"
},
"secretKeyRef": {
"$ref": "#/$defs/SecretKeySelector"
},
"serviceAccount": {
"type": "string"
}
},
"type": "object"
},
"HelmRefKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"key"
],
"type": "object"
},
"Labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"LocalObjectReference": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
}
},
"type": "object"
},
"MetricLabel": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"valueExpr": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"MetricLabels": {
"items": {
"$ref": "#/$defs/MetricLabel"
},
"type": "array"
},
"Metrics": {
"additionalProperties": false,
"properties": {
"labels": {
"$ref": "#/$defs/MetricLabels"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"SecretKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"key"
],
"type": "object"
}
},
"$id": "https://github.com/flanksource/canary-checker/api/v1/ec2-check",
"$ref": "#/$defs/EC2Check",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
flanksource/canary-checker | 311edab23ceae9c5620622500d40cb2aa57b35fd | 2023-12-08T01:53:27 | config/schemas/health_mongodb.schema.json | 156 | 2024-05-28T05:48:37.367425Z | {
"$defs": {
"ConfigMapKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"key"
],
"type": "object"
},
"EnvVar": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"valueFrom": {
"$ref": "#/$defs/EnvVarSource"
}
},
"type": "object"
},
"EnvVarSource": {
"additionalProperties": false,
"properties": {
"configMapKeyRef": {
"$ref": "#/$defs/ConfigMapKeySelector"
},
"secretKeyRef": {
"$ref": "#/$defs/SecretKeySelector"
},
"serviceAccount": {
"type": "string"
}
},
"type": "object"
},
"Labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"MetricLabel": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"valueExpr": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"MetricLabels": {
"items": {
"$ref": "#/$defs/MetricLabel"
},
"type": "array"
},
"Metrics": {
"additionalProperties": false,
"properties": {
"labels": {
"$ref": "#/$defs/MetricLabels"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"MongoDBCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"SecretKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"key"
],
"type": "object"
}
},
"$id": "https://github.com/flanksource/canary-checker/api/v1/mongo-db-check",
"$ref": "#/$defs/MongoDBCheck",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
flanksource/canary-checker | 6fe6095294375de0b3856a0801e884ef581e4ba5 | 2023-10-17T04:48:11 | config/schemas/canary.schema.json | 156 | 2024-05-28T05:48:37.367425Z | {
"$defs": {
"AWSConnection": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"connection": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"objectPath": {
"type": "string"
},
"region": {
"type": "string"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"sessionToken": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"usePathStyle": {
"type": "boolean"
}
},
"type": "object"
},
"AlertManagerCheck": {
"additionalProperties": false,
"properties": {
"alerts": {
"items": {
"type": "string"
},
"type": "array"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"exclude_filters": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"filters": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"icon": {
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"Authentication": {
"additionalProperties": false,
"properties": {
"password": {
"$ref": "#/$defs/EnvVar"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"type": "object"
},
"AwsConfigCheck": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"aggregatorName": {
"type": "string"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"objectPath": {
"type": "string"
},
"query": {
"type": "string"
},
"region": {
"type": "string"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"sessionToken": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"usePathStyle": {
"type": "boolean"
}
},
"required": [
"name",
"query"
],
"type": "object"
},
"AwsConfigRuleCheck": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"complianceTypes": {
"items": {
"type": "string"
},
"type": "array"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"ignoreRules": {
"items": {
"type": "string"
},
"type": "array"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"objectPath": {
"type": "string"
},
"region": {
"type": "string"
},
"rules": {
"items": {
"type": "string"
},
"type": "array"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"sessionToken": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"usePathStyle": {
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"AzureConnection": {
"additionalProperties": false,
"properties": {
"clientID": {
"$ref": "#/$defs/EnvVar"
},
"clientSecret": {
"$ref": "#/$defs/EnvVar"
},
"connection": {
"type": "string"
},
"tenantID": {
"type": "string"
}
},
"type": "object"
},
"AzureDevopsCheck": {
"additionalProperties": false,
"properties": {
"branch": {
"items": {
"type": "string"
},
"type": "array"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"organization": {
"type": "string"
},
"personalAccessToken": {
"$ref": "#/$defs/EnvVar"
},
"pipeline": {
"type": "string"
},
"project": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"thresholdMillis": {
"type": "integer"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"variables": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
}
},
"required": [
"name",
"organization",
"personalAccessToken",
"project",
"pipeline",
"variables",
"branch",
"thresholdMillis"
],
"type": "object"
},
"Canary": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"type": "string"
},
"metadata": {
"$ref": "#/$defs/ObjectMeta"
},
"spec": {
"$ref": "#/$defs/CanarySpec"
},
"status": {
"$ref": "#/$defs/CanaryStatus"
}
},
"type": "object"
},
"CanarySpec": {
"additionalProperties": false,
"properties": {
"alertmanager": {
"items": {
"$ref": "#/$defs/AlertManagerCheck"
},
"type": "array"
},
"awsConfig": {
"items": {
"$ref": "#/$defs/AwsConfigCheck"
},
"type": "array"
},
"awsConfigRule": {
"items": {
"$ref": "#/$defs/AwsConfigRuleCheck"
},
"type": "array"
},
"azureDevops": {
"items": {
"$ref": "#/$defs/AzureDevopsCheck"
},
"type": "array"
},
"cloudwatch": {
"items": {
"$ref": "#/$defs/CloudWatchCheck"
},
"type": "array"
},
"configDB": {
"items": {
"$ref": "#/$defs/ConfigDBCheck"
},
"type": "array"
},
"containerd": {
"items": {
"$ref": "#/$defs/ContainerdPullCheck"
},
"type": "array"
},
"containerdPush": {
"items": {
"$ref": "#/$defs/ContainerdPushCheck"
},
"type": "array"
},
"databaseBackup": {
"items": {
"$ref": "#/$defs/DatabaseBackupCheck"
},
"type": "array"
},
"dns": {
"items": {
"$ref": "#/$defs/DNSCheck"
},
"type": "array"
},
"docker": {
"items": {
"$ref": "#/$defs/DockerPullCheck"
},
"type": "array"
},
"dockerPush": {
"items": {
"$ref": "#/$defs/DockerPushCheck"
},
"type": "array"
},
"dynatrace": {
"items": {
"$ref": "#/$defs/DynatraceCheck"
},
"type": "array"
},
"ec2": {
"items": {
"$ref": "#/$defs/EC2Check"
},
"type": "array"
},
"elasticsearch": {
"items": {
"$ref": "#/$defs/ElasticsearchCheck"
},
"type": "array"
},
"env": {
"patternProperties": {
".*": {
"$ref": "#/$defs/VarSource"
}
},
"type": "object"
},
"exec": {
"items": {
"$ref": "#/$defs/ExecCheck"
},
"type": "array"
},
"folder": {
"items": {
"$ref": "#/$defs/FolderCheck"
},
"type": "array"
},
"github": {
"items": {
"$ref": "#/$defs/GitHubCheck"
},
"type": "array"
},
"helm": {
"items": {
"$ref": "#/$defs/HelmCheck"
},
"type": "array"
},
"http": {
"items": {
"$ref": "#/$defs/HTTPCheck"
},
"type": "array"
},
"icmp": {
"items": {
"$ref": "#/$defs/ICMPCheck"
},
"type": "array"
},
"icon": {
"type": "string"
},
"interval": {
"type": "integer"
},
"jmeter": {
"items": {
"$ref": "#/$defs/JmeterCheck"
},
"type": "array"
},
"junit": {
"items": {
"$ref": "#/$defs/JunitCheck"
},
"type": "array"
},
"kubernetes": {
"items": {
"$ref": "#/$defs/KubernetesCheck"
},
"type": "array"
},
"ldap": {
"items": {
"$ref": "#/$defs/LDAPCheck"
},
"type": "array"
},
"mongodb": {
"items": {
"$ref": "#/$defs/MongoDBCheck"
},
"type": "array"
},
"mssql": {
"items": {
"$ref": "#/$defs/MssqlCheck"
},
"type": "array"
},
"mysql": {
"items": {
"$ref": "#/$defs/MysqlCheck"
},
"type": "array"
},
"namespace": {
"items": {
"$ref": "#/$defs/NamespaceCheck"
},
"type": "array"
},
"opensearch": {
"items": {
"$ref": "#/$defs/OpenSearchCheck"
},
"type": "array"
},
"owner": {
"type": "string"
},
"pod": {
"items": {
"$ref": "#/$defs/PodCheck"
},
"type": "array"
},
"postgres": {
"items": {
"$ref": "#/$defs/PostgresCheck"
},
"type": "array"
},
"prometheus": {
"items": {
"$ref": "#/$defs/PrometheusCheck"
},
"type": "array"
},
"redis": {
"items": {
"$ref": "#/$defs/RedisCheck"
},
"type": "array"
},
"restic": {
"items": {
"$ref": "#/$defs/ResticCheck"
},
"type": "array"
},
"resultMode": {
"type": "string"
},
"s3": {
"items": {
"$ref": "#/$defs/S3Check"
},
"type": "array"
},
"schedule": {
"type": "string"
},
"severity": {
"type": "string"
},
"tcp": {
"items": {
"$ref": "#/$defs/TCPCheck"
},
"type": "array"
}
},
"type": "object"
},
"CanaryStatus": {
"additionalProperties": false,
"properties": {
"checkStatus": {
"patternProperties": {
".*": {
"$ref": "#/$defs/CheckStatus"
}
},
"type": "object"
},
"checks": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"errorMessage": {
"type": "string"
},
"lastCheck": {
"$ref": "#/$defs/Time"
},
"lastTransitionedTime": {
"$ref": "#/$defs/Time"
},
"latency1h": {
"type": "string"
},
"message": {
"type": "string"
},
"observedGeneration": {
"type": "integer"
},
"persistedID": {
"type": "string"
},
"status": {
"type": "string"
},
"uptime1h": {
"type": "string"
}
},
"type": "object"
},
"CheckStatus": {
"additionalProperties": false,
"properties": {
"errorMessage": {
"type": "string"
},
"lastCheck": {
"$ref": "#/$defs/Time"
},
"lastTransitionedTime": {
"$ref": "#/$defs/Time"
},
"latency1h": {
"type": "string"
},
"message": {
"type": "string"
},
"uptime1h": {
"type": "string"
}
},
"type": "object"
},
"CloudWatchCheck": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"actionPrefix": {
"type": "string"
},
"alarmPrefix": {
"type": "string"
},
"alarms": {
"items": {
"type": "string"
},
"type": "array"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"objectPath": {
"type": "string"
},
"region": {
"type": "string"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"sessionToken": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"state": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"usePathStyle": {
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"ConfigDBCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"query": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"query"
],
"type": "object"
},
"ConfigMapKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object"
},
"ContainerdPullCheck": {
"additionalProperties": false,
"properties": {
"auth": {
"$ref": "#/$defs/Authentication"
},
"description": {
"type": "string"
},
"expectedDigest": {
"type": "string"
},
"expectedSize": {
"type": "integer"
},
"icon": {
"type": "string"
},
"image": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"image"
],
"type": "object"
},
"ContainerdPushCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"image": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"password": {
"type": "string"
},
"transformDeleteStrategy": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"name",
"image"
],
"type": "object"
},
"DNSCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"exactreply": {
"items": {
"type": "string"
},
"type": "array"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"minrecords": {
"type": "integer"
},
"name": {
"type": "string"
},
"port": {
"type": "integer"
},
"query": {
"type": "string"
},
"querytype": {
"type": "string"
},
"server": {
"type": "string"
},
"thresholdMillis": {
"type": "integer"
},
"timeout": {
"type": "integer"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"DatabaseBackupCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"gcp": {
"$ref": "#/$defs/GCPDatabase"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"maxAge": {
"type": "string"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"DockerPullCheck": {
"additionalProperties": false,
"properties": {
"auth": {
"$ref": "#/$defs/Authentication"
},
"description": {
"type": "string"
},
"expectedDigest": {
"type": "string"
},
"expectedSize": {
"type": "integer"
},
"icon": {
"type": "string"
},
"image": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"image"
],
"type": "object"
},
"DockerPushCheck": {
"additionalProperties": false,
"properties": {
"auth": {
"$ref": "#/$defs/Authentication"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"image": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"image"
],
"type": "object"
},
"DynatraceCheck": {
"additionalProperties": false,
"properties": {
"apiKey": {
"$ref": "#/$defs/EnvVar"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"host": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"scheme": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"EC2Check": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"ami": {
"type": "string"
},
"canaryRef": {
"items": {
"$ref": "#/$defs/LocalObjectReference"
},
"type": "array"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"keepAlive": {
"type": "boolean"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"objectPath": {
"type": "string"
},
"region": {
"type": "string"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"securityGroup": {
"type": "string"
},
"sessionToken": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"timeOut": {
"type": "integer"
},
"transformDeleteStrategy": {
"type": "string"
},
"usePathStyle": {
"type": "boolean"
},
"userData": {
"type": "string"
},
"waitTime": {
"type": "integer"
}
},
"required": [
"name"
],
"type": "object"
},
"ElasticsearchCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"index": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"query": {
"type": "string"
},
"results": {
"type": "integer"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"EnvVar": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"valueFrom": {
"$ref": "#/$defs/EnvVarSource"
}
},
"type": "object"
},
"EnvVarSource": {
"additionalProperties": false,
"properties": {
"configMapKeyRef": {
"$ref": "#/$defs/ConfigMapKeySelector"
},
"secretKeyRef": {
"$ref": "#/$defs/SecretKeySelector"
}
},
"type": "object"
},
"ExecCheck": {
"additionalProperties": false,
"properties": {
"connections": {
"$ref": "#/$defs/ExecConnections"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"script": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"script"
],
"type": "object"
},
"ExecConnections": {
"additionalProperties": false,
"properties": {
"aws": {
"$ref": "#/$defs/AWSConnection"
},
"azure": {
"$ref": "#/$defs/AzureConnection"
},
"gcp": {
"$ref": "#/$defs/GCPConnection"
}
},
"type": "object"
},
"FieldsV1": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"FolderCheck": {
"additionalProperties": false,
"properties": {
"availableSize": {
"type": "string"
},
"awsConnection": {
"$ref": "#/$defs/AWSConnection"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"filter": {
"$ref": "#/$defs/FolderFilter"
},
"gcpConnection": {
"$ref": "#/$defs/GCPConnection"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"maxAge": {
"type": "string"
},
"maxCount": {
"type": "integer"
},
"maxSize": {
"type": "string"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"minAge": {
"type": "string"
},
"minCount": {
"type": "integer"
},
"minSize": {
"type": "string"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"sftpConnection": {
"$ref": "#/$defs/SFTPConnection"
},
"smbConnection": {
"$ref": "#/$defs/SMBConnection"
},
"test": {
"$ref": "#/$defs/Template"
},
"totalSize": {
"type": "string"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"path"
],
"type": "object"
},
"FolderFilter": {
"additionalProperties": false,
"properties": {
"maxAge": {
"type": "string"
},
"maxSize": {
"type": "string"
},
"minAge": {
"type": "string"
},
"minSize": {
"type": "string"
},
"regex": {
"type": "string"
}
},
"type": "object"
},
"GCPConnection": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"credentials": {
"$ref": "#/$defs/EnvVar"
},
"endpoint": {
"type": "string"
}
},
"type": "object"
},
"GCPDatabase": {
"additionalProperties": false,
"properties": {
"gcpConnection": {
"$ref": "#/$defs/GCPConnection"
},
"instance": {
"type": "string"
},
"project": {
"type": "string"
}
},
"required": [
"project",
"instance"
],
"type": "object"
},
"GitHubCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"githubToken": {
"$ref": "#/$defs/EnvVar"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"query": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"query"
],
"type": "object"
},
"HTTPCheck": {
"additionalProperties": false,
"properties": {
"body": {
"type": "string"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"endpoint": {
"type": "string"
},
"env": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"headers": {
"items": {
"$ref": "#/$defs/EnvVar"
},
"type": "array"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"maxSSLExpiry": {
"type": "integer"
},
"method": {
"type": "string"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"ntlm": {
"type": "boolean"
},
"ntlmv2": {
"type": "boolean"
},
"oauth2": {
"$ref": "#/$defs/Oauth2Config"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"responseCodes": {
"items": {
"type": "integer"
},
"type": "array"
},
"responseContent": {
"type": "string"
},
"responseJSONContent": {
"$ref": "#/$defs/JSONCheck"
},
"templateBody": {
"type": "boolean"
},
"test": {
"$ref": "#/$defs/Template"
},
"thresholdMillis": {
"type": "integer"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"HelmCheck": {
"additionalProperties": false,
"properties": {
"auth": {
"$ref": "#/$defs/Authentication"
},
"cafile": {
"type": "string"
},
"chartmuseum": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"project": {
"type": "string"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ICMPCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"packetCount": {
"type": "integer"
},
"packetLossThreshold": {
"type": "integer"
},
"thresholdMillis": {
"type": "integer"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"JSONCheck": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"path",
"value"
],
"type": "object"
},
"JmeterCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"host": {
"type": "string"
},
"icon": {
"type": "string"
},
"jmx": {
"$ref": "#/$defs/EnvVar"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"port": {
"type": "integer"
},
"properties": {
"items": {
"type": "string"
},
"type": "array"
},
"responseDuration": {
"type": "string"
},
"systemProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"jmx"
],
"type": "object"
},
"JunitCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"spec": true,
"test": {
"$ref": "#/$defs/Template"
},
"testResults": {
"type": "string"
},
"timeout": {
"type": "integer"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"testResults",
"spec"
],
"type": "object"
},
"KubernetesCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"ignore": {
"items": {
"type": "string"
},
"type": "array"
},
"kind": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"$ref": "#/$defs/ResourceSelector"
},
"ready": {
"type": "boolean"
},
"resource": {
"$ref": "#/$defs/ResourceSelector"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"kind"
],
"type": "object"
},
"LDAPCheck": {
"additionalProperties": false,
"properties": {
"bindDN": {
"type": "string"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"userSearch": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name",
"bindDN"
],
"type": "object"
},
"Labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"LocalObjectReference": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
}
},
"type": "object"
},
"ManagedFieldsEntry": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"fieldsType": {
"type": "string"
},
"fieldsV1": {
"$ref": "#/$defs/FieldsV1"
},
"manager": {
"type": "string"
},
"operation": {
"type": "string"
},
"subresource": {
"type": "string"
},
"time": {
"$ref": "#/$defs/Time"
}
},
"type": "object"
},
"MetricLabel": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"valueExpr": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"MetricLabels": {
"items": {
"$ref": "#/$defs/MetricLabel"
},
"type": "array"
},
"Metrics": {
"additionalProperties": false,
"properties": {
"labels": {
"$ref": "#/$defs/MetricLabels"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"MongoDBCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"MssqlCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"query": {
"type": "string"
},
"results": {
"type": "integer"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"MysqlCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"query": {
"type": "string"
},
"results": {
"type": "integer"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"NamespaceCheck": {
"additionalProperties": false,
"properties": {
"deadline": {
"type": "integer"
},
"deleteTimeout": {
"type": "integer"
},
"description": {
"type": "string"
},
"expectedContent": {
"type": "string"
},
"expectedHttpStatuses": {
"items": {
"type": "integer"
},
"type": "array"
},
"httpRetryInterval": {
"type": "integer"
},
"httpTimeout": {
"type": "integer"
},
"icon": {
"type": "string"
},
"ingressHost": {
"type": "string"
},
"ingressName": {
"type": "string"
},
"ingressTimeout": {
"type": "integer"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespaceAnnotations": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"namespaceLabels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"namespaceNamePrefix": {
"type": "string"
},
"path": {
"type": "string"
},
"podSpec": {
"type": "string"
},
"port": {
"type": "integer"
},
"priorityClass": {
"type": "string"
},
"readyTimeout": {
"type": "integer"
},
"schedule_timeout": {
"type": "integer"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"podSpec"
],
"type": "object"
},
"Oauth2Config": {
"additionalProperties": false,
"properties": {
"Scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"TokenURL": {
"type": "string"
}
},
"required": [
"Scopes",
"TokenURL"
],
"type": "object"
},
"ObjectFieldSelector": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"fieldPath": {
"type": "string"
}
},
"required": [
"fieldPath"
],
"type": "object"
},
"ObjectMeta": {
"additionalProperties": false,
"properties": {
"annotations": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"creationTimestamp": {
"$ref": "#/$defs/Time"
},
"deletionGracePeriodSeconds": {
"type": "integer"
},
"deletionTimestamp": {
"$ref": "#/$defs/Time"
},
"finalizers": {
"items": {
"type": "string"
},
"type": "array"
},
"generateName": {
"type": "string"
},
"generation": {
"type": "integer"
},
"labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"managedFields": {
"items": {
"$ref": "#/$defs/ManagedFieldsEntry"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"ownerReferences": {
"items": {
"$ref": "#/$defs/OwnerReference"
},
"type": "array"
},
"resourceVersion": {
"type": "string"
},
"selfLink": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
},
"OpenSearchCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"index": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"query": {
"type": "string"
},
"results": {
"type": "integer"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name",
"query",
"index"
],
"type": "object"
},
"OwnerReference": {
"additionalProperties": false,
"properties": {
"apiVersion": {
"type": "string"
},
"blockOwnerDeletion": {
"type": "boolean"
},
"controller": {
"type": "boolean"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"required": [
"apiVersion",
"kind",
"name",
"uid"
],
"type": "object"
},
"PodCheck": {
"additionalProperties": false,
"properties": {
"deadline": {
"type": "integer"
},
"deleteTimeout": {
"type": "integer"
},
"description": {
"type": "string"
},
"expectedContent": {
"type": "string"
},
"expectedHttpStatuses": {
"items": {
"type": "integer"
},
"type": "array"
},
"httpRetryInterval": {
"type": "integer"
},
"httpTimeout": {
"type": "integer"
},
"icon": {
"type": "string"
},
"ingressClass": {
"type": "string"
},
"ingressHost": {
"type": "string"
},
"ingressName": {
"type": "string"
},
"ingressTimeout": {
"type": "integer"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"path": {
"type": "string"
},
"port": {
"type": "integer"
},
"priorityClass": {
"type": "string"
},
"readyTimeout": {
"type": "integer"
},
"roundRobinNodes": {
"type": "boolean"
},
"scheduleTimeout": {
"type": "integer"
},
"spec": {
"type": "string"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"PostgresCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"query": {
"type": "string"
},
"results": {
"type": "integer"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"PrometheusCheck": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"host": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"query": {
"type": "string"
},
"test": {
"$ref": "#/$defs/Template"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name",
"query"
],
"type": "object"
},
"RedisCheck": {
"additionalProperties": false,
"properties": {
"addr": {
"type": "string"
},
"connection": {
"type": "string"
},
"db": {
"type": "integer"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"transformDeleteStrategy": {
"type": "string"
},
"url": {
"type": "string"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"name"
],
"type": "object"
},
"ResourceSelector": {
"additionalProperties": false,
"properties": {
"fieldSelector": {
"type": "string"
},
"labelSelector": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"ResticCheck": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"awsConnectionName": {
"type": "string"
},
"caCert": {
"type": "string"
},
"checkIntegrity": {
"type": "boolean"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"maxAge": {
"type": "string"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"repository": {
"type": "string"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"repository",
"password",
"maxAge"
],
"type": "object"
},
"S3Check": {
"additionalProperties": false,
"properties": {
"accessKey": {
"$ref": "#/$defs/EnvVar"
},
"bucketName": {
"type": "string"
},
"connection": {
"type": "string"
},
"description": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"objectPath": {
"type": "string"
},
"region": {
"type": "string"
},
"secretKey": {
"$ref": "#/$defs/EnvVar"
},
"sessionToken": {
"$ref": "#/$defs/EnvVar"
},
"skipTLSVerify": {
"type": "boolean"
},
"transformDeleteStrategy": {
"type": "string"
},
"usePathStyle": {
"type": "boolean"
}
},
"required": [
"name"
],
"type": "object"
},
"SFTPConnection": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"host": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"port": {
"type": "integer"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"required": [
"host"
],
"type": "object"
},
"SMBConnection": {
"additionalProperties": false,
"properties": {
"connection": {
"type": "string"
},
"domain": {
"type": "string"
},
"password": {
"$ref": "#/$defs/EnvVar"
},
"port": {
"type": "integer"
},
"username": {
"$ref": "#/$defs/EnvVar"
}
},
"type": "object"
},
"SecretKeySelector": {
"additionalProperties": false,
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"optional": {
"type": "boolean"
}
},
"required": [
"key"
],
"type": "object"
},
"TCPCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"thresholdMillis": {
"type": "integer"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Template": {
"additionalProperties": false,
"properties": {
"expr": {
"type": "string"
},
"javascript": {
"type": "string"
},
"jsonPath": {
"type": "string"
},
"template": {
"type": "string"
}
},
"type": "object"
},
"Time": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"VarSource": {
"additionalProperties": false,
"properties": {
"configMapKeyRef": {
"$ref": "#/$defs/ConfigMapKeySelector"
},
"fieldRef": {
"$ref": "#/$defs/ObjectFieldSelector"
},
"secretKeyRef": {
"$ref": "#/$defs/SecretKeySelector"
},
"value": {
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://github.com/flanksource/canary-checker/api/v1/canary",
"$ref": "#/$defs/Canary",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
flanksource/canary-checker | 23a2a70ba2388a6bc87b1e874d768cdf83492dbc | 2023-07-18T18:11:58 | config/schemas/health_junit.schema.json | 156 | 2024-05-28T05:48:37.367425Z | {
"$defs": {
"JunitCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"display": {
"$ref": "#/$defs/Template"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"name": {
"type": "string"
},
"spec": true,
"test": {
"$ref": "#/$defs/Template"
},
"testResults": {
"type": "string"
},
"timeout": {
"type": "integer"
},
"transform": {
"$ref": "#/$defs/Template"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name",
"testResults",
"spec"
],
"type": "object"
},
"Labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"Template": {
"additionalProperties": false,
"properties": {
"expr": {
"type": "string"
},
"javascript": {
"type": "string"
},
"jsonPath": {
"type": "string"
},
"template": {
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://github.com/flanksource/canary-checker/api/v1/junit-check",
"$ref": "#/$defs/JunitCheck",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
flanksource/canary-checker | dd079f0880fa2214c1a84c3aeae6799d596c0259 | 2023-05-19T12:23:14 | config/schemas/health_pod.schema.json | 156 | 2024-05-28T05:48:37.367425Z | {
"$defs": {
"Labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"PodCheck": {
"additionalProperties": false,
"properties": {
"deadline": {
"type": "integer"
},
"deleteTimeout": {
"type": "integer"
},
"description": {
"type": "string"
},
"expectedContent": {
"type": "string"
},
"expectedHttpStatuses": {
"items": {
"type": "integer"
},
"type": "array"
},
"httpRetryInterval": {
"type": "integer"
},
"httpTimeout": {
"type": "integer"
},
"icon": {
"type": "string"
},
"ingressClass": {
"type": "string"
},
"ingressHost": {
"type": "string"
},
"ingressName": {
"type": "string"
},
"ingressTimeout": {
"type": "integer"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"path": {
"type": "string"
},
"port": {
"type": "integer"
},
"priorityClass": {
"type": "string"
},
"readyTimeout": {
"type": "integer"
},
"scheduleTimeout": {
"type": "integer"
},
"spec": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
},
"$id": "https://github.com/flanksource/canary-checker/api/v1/pod-check",
"$ref": "#/$defs/PodCheck",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
flanksource/canary-checker | 7615b353e5bfe91baa43265f81501faef2bd0c77 | 2023-08-23T14:33:22 | config/schemas/health_icmp.schema.json | 156 | 2024-05-28T05:48:37.367425Z | {
"$defs": {
"ICMPCheck": {
"additionalProperties": false,
"properties": {
"description": {
"type": "string"
},
"endpoint": {
"type": "string"
},
"icon": {
"type": "string"
},
"labels": {
"$ref": "#/$defs/Labels"
},
"metrics": {
"items": {
"$ref": "#/$defs/Metrics"
},
"type": "array"
},
"name": {
"type": "string"
},
"packetCount": {
"type": "integer"
},
"packetLossThreshold": {
"type": "integer"
},
"thresholdMillis": {
"type": "integer"
},
"transformDeleteStrategy": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"Metrics": {
"additionalProperties": false,
"properties": {
"labels": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
}
},
"$id": "https://github.com/flanksource/canary-checker/api/v1/icmp-check",
"$ref": "#/$defs/ICMPCheck",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | ce58650ff96d61d9879be71bb329d040668fd404 | 2023-12-29T09:35:24 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"jwt_secret": {
"description": "Used for signing HS256 JWT's for identity verification",
"title": "Secret Key for JWT's",
"type": "string"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled'",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 723b02945783b66f455759fc75b9a297dd44c647 | 2024-03-04T09:29:12 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule.",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests.",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section.",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to.",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to.",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to.",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to."
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to.",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match.",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to.",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to.",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to.",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to.",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to.",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule.",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration.",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration.",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour.",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend.",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia.",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database.",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour.",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database.",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use.",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters.",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters.",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters.",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters.",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters.",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length.",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used.",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used.",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length.",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used.",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used.",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used.",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used.",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used.",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used.",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used.",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used.",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used.",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used.",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used.",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used.",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used.",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used.",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search.",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username.",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups.",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users.",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server.",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations.",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects.",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects.",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values.",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding.",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup.",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals.",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind.",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS.",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties.",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding.",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects.",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of.",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users.",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects.",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups.",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups.",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users.",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL.",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option.",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration.",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration.",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted.",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them.",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration.",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration.",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration.",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration.",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration.",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration.",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration.",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration.",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration.",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration.",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration.",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration.",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration.",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI.",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration.",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration.",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration.",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow.",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard.",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard.",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard.",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing.",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients.",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended.",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges.",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients.",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens.",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens.",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens.",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration.",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter.",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests.",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests.",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients.",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for.",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg').",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences.",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client.",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg').",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client.",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users.",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client.",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client.",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints.",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID.",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg').",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg').",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client.",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client.",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type.",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs.",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client.",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request.",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request.",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted.",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication.",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation.",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client.",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg').",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types.",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant.",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant.",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant.",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant.",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM).",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients.",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows.",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow.",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"elevation_expiration": {
"description": "Duration of time the elevation can exist for after the user performs the validation.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Expiration"
},
"expiration": {
"description": "Duration of time the OTP code is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes.",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods.",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor.",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"expiration": {
"description": "Duration of time the JWT is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"jwt_algorithm": {
"default": "HS256",
"description": "The JWT Algorithm (JWA) used to sign the Reset Password flow JWT's.",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_secret": {
"description": "The JWT secret used to sign the Reset Password flow JWT's.",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK.",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format.",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK.",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK.",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled.",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages.",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option.",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log.",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server.",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error.",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely.",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use.",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks.",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier.",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier.",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides.",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications.",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address.",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version.",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS.",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it.",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command.",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP.",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check.",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used.",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties.",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine.",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine.",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length.",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length.",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters.",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters.",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters.",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters.",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed.",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality.",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy.",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy.",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user.",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on.",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside.",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration.",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality.",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration.",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration.",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration.",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration.",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size.",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size.",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints.",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint.",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint.",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use.",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template.",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate.",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS.",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key.",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations.",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration.",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data.",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration.",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration.",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration.",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index.",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host.",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time.",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis.",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password.",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port.",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance.",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode.",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode.",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance.",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port.",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine.",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings.",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings.",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings.",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file.",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use.",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options.",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options.",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options.",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options.",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain.",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted.",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted.",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key.",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against.",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties.",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys.",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default.",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default.",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default.",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys.",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code.",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys.",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys.",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys.",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys.",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration.",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on.",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server.",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server.",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server.",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials.",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party.",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials.",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 8e4e8ce8768fb1cabef13a794454cf4486a65f64 | 2023-09-03T10:20:10 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests. Not relevant to OpenID Connect.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?umask=[0-7]{3,4})?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"description": "Used to redirect users when they visit the portal directly",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"jwt_secret": {
"description": "Used for signing HS256 JWT's for identity verification",
"title": "Secret Key for JWT's",
"type": "string"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"DisableRememberMe": {
"type": "boolean"
},
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the cookies options instead.",
"type": "string"
},
"expiration": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"DisableRememberMe": {
"type": "boolean"
},
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"type": "string"
},
"remember_me": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"schema": {
"default": "public",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead."
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"type": "string"
},
"key": {
"type": "string"
},
"mode": {
"deprecated": true,
"type": "string"
},
"root_certificate": {
"deprecated": true,
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 320b96486cb26ff36e79a6aa5c6aa6ddb4cc0e41 | 2024-03-04T09:29:11 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"elevation_expiration": {
"description": "Duration of time the elevation can exist for after the user performs the validation",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Expiration"
},
"expiration": {
"description": "Duration of time the OTP code is considered valid",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"expiration": {
"description": "Duration of time the JWT is considered valid",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"jwt_algorithm": {
"default": "HS256",
"description": "The JWT Algorithm (JWA) used to sign the Reset Password flow JWT's'",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_secret": {
"description": "The JWT secret used to sign the Reset Password flow JWT's",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled'",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 13837b7b84e561981b081f7f67f3775893377d5b | 2024-03-04T09:29:11 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"credential_management": {
"$ref": "#/$defs/IdentityValidationCredentials",
"description": "Identity validation options for the Credential Management flows",
"title": "Credential Management"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity validation options for the Reset Password flow",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationCredentials": {
"additionalProperties": false,
"description": "IdentityValidationCredentials represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"elevation_expiration": {
"description": "Duration of time the elevation can exist for after the user performs the validation",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Expiration"
},
"expiration": {
"description": "Duration of time the OTP code is considered valid",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"otp_characters": {
"description": "Number of characters in the generated OTP codes",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"skip_2fa": {
"description": "Skips 2FA requirement TODO",
"title": "Skip 2FA",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"expiration": {
"description": "Duration of time the JWT is considered valid",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"jwt_algorithm": {
"default": "HS256",
"description": "The JWT Algorithm (JWA) used to sign the Reset Password flow JWT's'",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_secret": {
"description": "The JWT secret used to sign the Reset Password flow JWT's",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled'",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 6a6059dc228b20fe13aee274188911d00458fe24 | 2023-09-28T22:46:41 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests. Not relevant to OpenID Connect.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?umask=[0-7]{3,4})?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"description": "Used to redirect users when they visit the portal directly",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"jwt_secret": {
"description": "Used for signing HS256 JWT's for identity verification",
"title": "Secret Key for JWT's",
"type": "string"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the cookies options instead.",
"type": "string"
},
"expiration": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this cookie domain",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"type": "string"
},
"remember_me": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"schema": {
"default": "public",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead."
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"type": "string"
},
"key": {
"type": "string"
},
"mode": {
"deprecated": true,
"type": "string"
},
"root_certificate": {
"deprecated": true,
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 40026701fdf604b874334166b9984f6ac003f0fa | 2023-09-03T06:01:46 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests. Not relevant to OpenID Connect.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?umask=[0-7]{3,4})?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"description": "Used to redirect users when they visit the portal directly",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"jwt_secret": {
"description": "Used for signing HS256 JWT's for identity verification",
"title": "Secret Key for JWT's",
"type": "string"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"oneOf": [
{
"pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*$",
"type": "string"
},
{
"pattern": "^[^<]+ <[a-zA-Z0-9.!#$%&'*+/=?^_{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*>$",
"type": "string"
}
],
"title": "Sender"
},
"startup_check_address": {
"description": "The address used for the recipient in the startup check",
"oneOf": [
{
"pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*$",
"type": "string"
},
{
"pattern": "^[^<]+ <[a-zA-Z0-9.!#$%&'*+/=?^_{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*>$",
"type": "string"
}
],
"title": "Startup Check Address"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"DisableRememberMe": {
"type": "boolean"
},
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the cookies options instead.",
"type": "string"
},
"expiration": {
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"DisableRememberMe": {
"type": "boolean"
},
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"type": "string"
},
"remember_me": {
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"schema": {
"default": "public",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead."
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"type": "string"
},
"key": {
"type": "string"
},
"mode": {
"deprecated": true,
"type": "string"
},
"root_certificate": {
"deprecated": true,
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 40026701fdf604b874334166b9984f6ac003f0fa | 2023-09-03T06:01:46 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests. Not relevant to OpenID Connect.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?umask=[0-7]{3,4})?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"description": "Used to redirect users when they visit the portal directly",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"jwt_secret": {
"description": "Used for signing HS256 JWT's for identity verification",
"title": "Secret Key for JWT's",
"type": "string"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"oneOf": [
{
"pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*$",
"type": "string"
},
{
"pattern": "^[^<]+ <[a-zA-Z0-9.!#$%&'*+/=?^_{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*>$",
"type": "string"
}
],
"title": "Sender"
},
"startup_check_address": {
"description": "The address used for the recipient in the startup check",
"oneOf": [
{
"pattern": "^[a-zA-Z0-9.!#$%&'*+/=?^_{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*$",
"type": "string"
},
{
"pattern": "^[^<]+ <[a-zA-Z0-9.!#$%&'*+/=?^_{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*>$",
"type": "string"
}
],
"title": "Startup Check Address"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"DisableRememberMe": {
"type": "boolean"
},
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the cookies options instead.",
"type": "string"
},
"expiration": {
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"DisableRememberMe": {
"type": "boolean"
},
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"type": "string"
},
"remember_me": {
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"schema": {
"default": "public",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead."
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"type": "string"
},
"key": {
"type": "string"
},
"mode": {
"deprecated": true,
"type": "string"
},
"root_certificate": {
"deprecated": true,
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"$comment": "Example comment",
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 87d2a3419d6f29db900bc1aeb4cf5d7769a15ce3 | 2024-03-04T09:28:24 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"jwt_secret": {
"description": "Used for signing HS256 JWT's for identity verification",
"title": "Secret Key for JWT's",
"type": "string"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled'",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"description": "List of algorithms the user is allowed to select in addition to the default",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"description": "List of periods the user is allowed to select in addition to the default",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | acff603092951972fdd13691574c0110a34cb64d | 2024-03-06T19:24:03 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule.",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests.",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section.",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to.",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to.",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to.",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to."
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to.",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match.",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to.",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to.",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to.",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to.",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to.",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule.",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group|oauth2:client:):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group|oauth2:client:):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group|oauth2:client:):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration.",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration.",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour.",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend.",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia.",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database.",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour.",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database.",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use.",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters.",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters.",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters.",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters.",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters.",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length.",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used.",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used.",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length.",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used.",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used.",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used.",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used.",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used.",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used.",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used.",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used.",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used.",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used.",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used.",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used.",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used.",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used.",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search.",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username.",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups.",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users.",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server.",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations.",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects.",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects.",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values.",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding.",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup.",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals.",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind.",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS.",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties.",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding.",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects.",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of.",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users.",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects.",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups.",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups.",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users.",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL.",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option.",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration.",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration.",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted.",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them.",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration.",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration.",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration.",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration.",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration.",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration.",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration.",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration.",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration.",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration.",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration.",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration.",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration.",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI.",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration.",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration.",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration.",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow.",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard.",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard.",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard.",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing.",
"title": "CORS"
},
"discovery_signed_response_alg": {
"default": "none",
"description": "The Algorithm this provider uses to sign the Discovery and Metadata Document responses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Discovery Response Signing Algorithm",
"type": "string"
},
"discovery_signed_response_key_id": {
"description": "The Key ID this provider uses to sign the Discovery and Metadata Document responses (overrides the 'discovery_signed_response_alg').",
"title": "Discovery Response Signing Key ID",
"type": "string"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients.",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended.",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges.",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients.",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens.",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"deprecated": true,
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens.",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"deprecated": true,
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens.",
"title": "Issuer Private Key",
"type": "string"
},
"jwks": {
"description": "The JWK's which are to be used to sign various objects like ID Tokens.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer JSON Web Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration.",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter.",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests.",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests.",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients.",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for.",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg').",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences.",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client.",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg').",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"client_id": {
"description": "The Client ID.",
"minLength": 1,
"title": "Client ID",
"type": "string"
},
"client_name": {
"description": "The Client Name displayed to End-Users.",
"title": "Client Name",
"type": "string"
},
"client_secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication.",
"title": "Client Secret"
},
"consent_mode": {
"description": "The Consent Mode used for this client.",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints.",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg').",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg').",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"jwks": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "JSON Web Keys",
"type": "array"
},
"jwks_uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"format": "uri",
"title": "JSON Web Keys URI",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client.",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client.",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type.",
"title": "Public",
"type": "boolean"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs.",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client.",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"require_pkce": {
"default": false,
"description": "Requires a Proof Key for this client to perform Code Exchange.",
"title": "Require PKCE",
"type": "boolean"
},
"require_pushed_authorization_requests": {
"default": false,
"description": "Requires Pushed Authorization Requests for this client to perform an authorization.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
},
"response_modes": {
"description": "The Response Modes this client is authorized request.",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request.",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted.",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"sector_identifier_uri": {
"description": "The Client Sector Identifier URI for Privacy Isolation via Pairwise subject types.",
"format": "uri",
"title": "Sector Identifier URI",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client.",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg').",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"client_id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types.",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant.",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant.",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant.",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant.",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM).",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients.",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows.",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow.",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"elevation_expiration": {
"description": "Duration of time the elevation can exist for after the user performs the validation.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Expiration"
},
"expiration": {
"description": "Duration of time the OTP code is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes.",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods.",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor.",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"expiration": {
"description": "Duration of time the JWT is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"jwt_algorithm": {
"default": "HS256",
"description": "The JWT Algorithm (JWA) used to sign the Reset Password flow JWT's.",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_secret": {
"description": "The JWT secret used to sign the Reset Password flow JWT's.",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK.",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format.",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK.",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK.",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled.",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages.",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option.",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log.",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server.",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error.",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely.",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use.",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks.",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier.",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier.",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides.",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications.",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address.",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version.",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS.",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it.",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command.",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP.",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check.",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used.",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties.",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine.",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine.",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length.",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length.",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters.",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters.",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters.",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters.",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed.",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality.",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy.",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy.",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user.",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on.",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside.",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration.",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality.",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration.",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration.",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration.",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration.",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size.",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size.",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints.",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint.",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint.",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use.",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
},
"schemes": {
"default": [
"basic"
],
"description": "The name of the authorization schemes to allow with the header strategies.",
"items": {
"enum": [
"basic",
"bearer"
],
"type": "string"
},
"title": "Authorization Schemes",
"type": "array"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template.",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate.",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS.",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key.",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations.",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration.",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data.",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration.",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration.",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration.",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index.",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host.",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time.",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis.",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password.",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port.",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance.",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode.",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode.",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance.",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port.",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine.",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings.",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings.",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings.",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file.",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use.",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options.",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options.",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options.",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options.",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain.",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted.",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted.",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key.",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against.",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties.",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys.",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default.",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default.",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default.",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys.",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code.",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys.",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys.",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys.",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys.",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration.",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on.",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server.",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server.",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server.",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials.",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party.",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials.",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 6a6059dc228b20fe13aee274188911d00458fe24 | 2023-09-28T22:46:41 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests. Not relevant to OpenID Connect.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?umask=[0-7]{3,4})?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"description": "Used to redirect users when they visit the portal directly",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"jwt_secret": {
"description": "Used for signing HS256 JWT's for identity verification",
"title": "Secret Key for JWT's",
"type": "string"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the cookies options instead.",
"type": "string"
},
"expiration": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this cookie domain",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"type": "string"
},
"remember_me": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"schema": {
"default": "public",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead."
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"type": "string"
},
"key": {
"type": "string"
},
"mode": {
"deprecated": true,
"type": "string"
},
"root_certificate": {
"deprecated": true,
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 0299e8d6ce1c70d56d9320845d092e809cb90de9 | 2024-03-06T07:25:42 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule.",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests.",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section.",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to.",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to.",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to.",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to."
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to.",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match.",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to.",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to.",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to.",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to.",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to.",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule.",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group|oauth2:client:):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group|oauth2:client:):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group|oauth2:client:):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration.",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration.",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour.",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend.",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia.",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database.",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour.",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database.",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use.",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters.",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters.",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters.",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters.",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters.",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length.",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used.",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used.",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length.",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used.",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used.",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used.",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used.",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used.",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used.",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used.",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used.",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used.",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used.",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used.",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used.",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used.",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used.",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search.",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username.",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups.",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users.",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server.",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations.",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects.",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects.",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values.",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding.",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup.",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals.",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind.",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS.",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties.",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding.",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects.",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of.",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users.",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects.",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups.",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups.",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users.",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL.",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option.",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration.",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration.",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted.",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them.",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration.",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration.",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration.",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration.",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration.",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration.",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration.",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration.",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration.",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration.",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration.",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration.",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration.",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI.",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration.",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration.",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration.",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow.",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard.",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard.",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard.",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing.",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients.",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended.",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges.",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients.",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens.",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"deprecated": true,
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens.",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"deprecated": true,
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens.",
"title": "Issuer Private Key",
"type": "string"
},
"jwks": {
"description": "The JWK's which are to be used to sign various objects like ID Tokens.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer JSON Web Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration.",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter.",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests.",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests.",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients.",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for.",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg').",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences.",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client.",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg').",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"client_id": {
"description": "The Client ID.",
"minLength": 1,
"title": "Client ID",
"type": "string"
},
"client_name": {
"description": "The Client Name displayed to End-Users.",
"title": "Client Name",
"type": "string"
},
"client_secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication.",
"title": "Client Secret"
},
"consent_mode": {
"description": "The Consent Mode used for this client.",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints.",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg').",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg').",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"jwks": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "JSON Web Keys",
"type": "array"
},
"jwks_uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"format": "uri",
"title": "JSON Web Keys URI",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client.",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client.",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type.",
"title": "Public",
"type": "boolean"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs.",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client.",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"require_pkce": {
"default": false,
"description": "Requires a Proof Key for this client to perform Code Exchange.",
"title": "Require PKCE",
"type": "boolean"
},
"require_pushed_authorization_requests": {
"default": false,
"description": "Requires Pushed Authorization Requests for this client to perform an authorization.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
},
"response_modes": {
"description": "The Response Modes this client is authorized request.",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request.",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted.",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"sector_identifier_uri": {
"description": "The Client Sector Identifier URI for Privacy Isolation via Pairwise subject types.",
"format": "uri",
"title": "Sector Identifier URI",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client.",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg').",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"client_id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types.",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant.",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant.",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant.",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant.",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM).",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients.",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows.",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow.",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"elevation_expiration": {
"description": "Duration of time the elevation can exist for after the user performs the validation.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Expiration"
},
"expiration": {
"description": "Duration of time the OTP code is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes.",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods.",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor.",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"expiration": {
"description": "Duration of time the JWT is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"jwt_algorithm": {
"default": "HS256",
"description": "The JWT Algorithm (JWA) used to sign the Reset Password flow JWT's.",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_secret": {
"description": "The JWT secret used to sign the Reset Password flow JWT's.",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK.",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format.",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK.",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK.",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled.",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages.",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option.",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log.",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server.",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error.",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely.",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use.",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks.",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier.",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier.",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides.",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications.",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address.",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version.",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS.",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it.",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command.",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP.",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check.",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used.",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties.",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine.",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine.",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length.",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length.",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters.",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters.",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters.",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters.",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed.",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality.",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy.",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy.",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user.",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on.",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside.",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration.",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality.",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration.",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration.",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration.",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration.",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size.",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size.",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints.",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint.",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint.",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use.",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
},
"schemes": {
"default": [
"basic"
],
"description": "The name of the authorization schemes to allow with the header strategies.",
"items": {
"enum": [
"basic",
"bearer"
],
"type": "string"
},
"title": "Authorization Schemes",
"type": "array"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template.",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate.",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS.",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key.",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations.",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration.",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data.",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration.",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration.",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration.",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index.",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host.",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time.",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis.",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password.",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port.",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance.",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode.",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode.",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance.",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port.",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine.",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings.",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings.",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings.",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file.",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use.",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options.",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options.",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options.",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options.",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain.",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted.",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted.",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key.",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against.",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties.",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys.",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default.",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default.",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default.",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys.",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code.",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys.",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys.",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys.",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys.",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration.",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on.",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server.",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server.",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server.",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials.",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party.",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials.",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | f89778272cd35ffd7afae036c1eccbbecba19144 | 2024-03-04T09:29:12 | docs/static/schemas/latest/json-schema/exports.webauthn.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"WebAuthnCredentialData": {
"additionalProperties": false,
"properties": {
"aaguid": {
"description": "The Authenticator Attestation Global Unique Identifier of this credential",
"title": "AAGUID",
"type": "string"
},
"attachment": {
"description": "The last recorded credential attachment type",
"title": "Attachment",
"type": "string"
},
"attestation_type": {
"description": "The attestation format type this credential uses",
"title": "Attestation Type",
"type": "string"
},
"backup_eligible": {
"description": "The backup eligible status of this credential",
"title": "Backup Eligible",
"type": "boolean"
},
"backup_state": {
"description": "The backup eligible status of this credential",
"title": "Backup Eligible",
"type": "boolean"
},
"clone_warning": {
"description": "The clone warning status of the credential",
"title": "Clone Warning",
"type": "boolean"
},
"created_at": {
"description": "The time this credential was created",
"format": "date-time",
"title": "Created At",
"type": "string"
},
"description": {
"description": "The user description of this credential",
"title": "Description",
"type": "string"
},
"discoverable": {
"description": "The discoverable status of this credential",
"title": "Discoverable",
"type": "boolean"
},
"id": {
"type": "integer"
},
"kid": {
"description": "The Public Key ID of this credential",
"title": "Public Key ID",
"type": "string"
},
"last_used_at": {
"description": "The last time this credential was used",
"format": "date-time",
"title": "Last Used At",
"type": "string"
},
"legacy": {
"description": "The legacy value indicates this credential may need to be registered again",
"title": "Legacy",
"type": "boolean"
},
"present": {
"description": "The user presence status of this credential",
"title": "Present",
"type": "boolean"
},
"public_key": {
"description": "The credential public key",
"title": "Public Key",
"type": "string"
},
"rpid": {
"description": "The Relying Party ID used to register this credential",
"title": "Relying Party ID",
"type": "string"
},
"sign_count": {
"description": "The last recorded credential sign count",
"title": "Sign Count",
"type": "integer"
},
"transports": {
"description": "The last recorded credential transports",
"items": {
"type": "string"
},
"title": "Transports",
"type": "array"
},
"username": {
"description": "The username of the user this credential belongs to",
"title": "Username",
"type": "string"
},
"verified": {
"description": "The verified status of this credential",
"title": "Verified",
"type": "boolean"
}
},
"type": "object"
},
"WebAuthnCredentialDataExport": {
"additionalProperties": false,
"properties": {
"webauthn_credentials": {
"description": "The list of WebAuthn credentials",
"items": {
"$ref": "#/$defs/WebAuthnCredentialData"
},
"title": "WebAuthn Credentials",
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/exports.webauthn.json",
"$ref": "#/$defs/WebAuthnCredentialDataExport",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 320b96486cb26ff36e79a6aa5c6aa6ddb4cc0e41 | 2024-03-04T09:29:11 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"elevation_expiration": {
"description": "Duration of time the elevation can exist for after the user performs the validation",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Expiration"
},
"expiration": {
"description": "Duration of time the OTP code is considered valid",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"expiration": {
"description": "Duration of time the JWT is considered valid",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"jwt_algorithm": {
"default": "HS256",
"description": "The JWT Algorithm (JWA) used to sign the Reset Password flow JWT's'",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_secret": {
"description": "The JWT secret used to sign the Reset Password flow JWT's",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled'",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | e4bf1d73f529d4aa5c158e91e65a59a991ce00cc | 2023-11-20T10:19:30 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?umask=[0-7]{3,4})?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"jwt_secret": {
"description": "Used for signing HS256 JWT's for identity verification",
"title": "Secret Key for JWT's",
"type": "string"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled'",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 0299e8d6ce1c70d56d9320845d092e809cb90de9 | 2024-03-06T07:25:42 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule.",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests.",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section.",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to.",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to.",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to.",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to."
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to.",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match.",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to.",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to.",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to.",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to.",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to.",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule.",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group|oauth2:client:):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group|oauth2:client:):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group|oauth2:client:):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration.",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration.",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour.",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend.",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia.",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database.",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour.",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database.",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use.",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters.",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters.",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters.",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters.",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters.",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length.",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used.",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used.",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length.",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used.",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used.",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used.",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used.",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used.",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used.",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used.",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used.",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used.",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used.",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used.",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used.",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used.",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used.",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search.",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username.",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups.",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users.",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server.",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations.",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects.",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects.",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values.",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding.",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup.",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals.",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind.",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS.",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties.",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding.",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects.",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of.",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users.",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects.",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups.",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups.",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users.",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL.",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option.",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration.",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration.",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted.",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them.",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration.",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration.",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration.",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration.",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration.",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration.",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration.",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration.",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration.",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration.",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration.",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration.",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration.",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI.",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration.",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration.",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration.",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow.",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard.",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard.",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard.",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing.",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients.",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended.",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges.",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients.",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens.",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"deprecated": true,
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens.",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"deprecated": true,
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens.",
"title": "Issuer Private Key",
"type": "string"
},
"jwks": {
"description": "The JWK's which are to be used to sign various objects like ID Tokens.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer JSON Web Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration.",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter.",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests.",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests.",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients.",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for.",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg').",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences.",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client.",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg').",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"client_id": {
"description": "The Client ID.",
"minLength": 1,
"title": "Client ID",
"type": "string"
},
"client_name": {
"description": "The Client Name displayed to End-Users.",
"title": "Client Name",
"type": "string"
},
"client_secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication.",
"title": "Client Secret"
},
"consent_mode": {
"description": "The Consent Mode used for this client.",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints.",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg').",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg').",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"jwks": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "JSON Web Keys",
"type": "array"
},
"jwks_uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"format": "uri",
"title": "JSON Web Keys URI",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client.",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client.",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type.",
"title": "Public",
"type": "boolean"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs.",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client.",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"require_pkce": {
"default": false,
"description": "Requires a Proof Key for this client to perform Code Exchange.",
"title": "Require PKCE",
"type": "boolean"
},
"require_pushed_authorization_requests": {
"default": false,
"description": "Requires Pushed Authorization Requests for this client to perform an authorization.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
},
"response_modes": {
"description": "The Response Modes this client is authorized request.",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request.",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted.",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"sector_identifier_uri": {
"description": "The Client Sector Identifier URI for Privacy Isolation via Pairwise subject types.",
"format": "uri",
"title": "Sector Identifier URI",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client.",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg').",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"client_id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types.",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant.",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant.",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant.",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant.",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM).",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients.",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows.",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow.",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"elevation_expiration": {
"description": "Duration of time the elevation can exist for after the user performs the validation.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Expiration"
},
"expiration": {
"description": "Duration of time the OTP code is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes.",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods.",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor.",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"expiration": {
"description": "Duration of time the JWT is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"jwt_algorithm": {
"default": "HS256",
"description": "The JWT Algorithm (JWA) used to sign the Reset Password flow JWT's.",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_secret": {
"description": "The JWT secret used to sign the Reset Password flow JWT's.",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK.",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format.",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK.",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK.",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled.",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages.",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option.",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log.",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server.",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error.",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely.",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use.",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks.",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier.",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier.",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides.",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications.",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address.",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version.",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS.",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it.",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command.",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP.",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check.",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used.",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties.",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine.",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine.",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length.",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length.",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters.",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters.",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters.",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters.",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed.",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality.",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy.",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy.",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user.",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on.",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside.",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration.",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality.",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration.",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration.",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration.",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration.",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size.",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size.",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints.",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint.",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint.",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use.",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
},
"schemes": {
"default": [
"basic"
],
"description": "The name of the authorization schemes to allow with the header strategies.",
"items": {
"enum": [
"basic",
"bearer"
],
"type": "string"
},
"title": "Authorization Schemes",
"type": "array"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template.",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate.",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS.",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key.",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations.",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration.",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data.",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration.",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration.",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration.",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index.",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host.",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time.",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis.",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password.",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port.",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance.",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode.",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode.",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance.",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port.",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine.",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings.",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings.",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings.",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file.",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use.",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options.",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options.",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options.",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options.",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain.",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted.",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted.",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key.",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against.",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties.",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys.",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default.",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default.",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default.",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys.",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code.",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys.",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys.",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys.",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys.",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration.",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on.",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server.",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server.",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server.",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials.",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party.",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials.",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 5d3e7a0183c9842c2cc4e6b12fe8300297110a71 | 2024-03-04T09:29:12 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"elevation_expiration": {
"description": "Duration of time the elevation can exist for after the user performs the validation",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Expiration"
},
"expiration": {
"description": "Duration of time the OTP code is considered valid",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"expiration": {
"description": "Duration of time the JWT is considered valid",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"jwt_algorithm": {
"default": "HS256",
"description": "The JWT Algorithm (JWA) used to sign the Reset Password flow JWT's'",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_secret": {
"description": "The JWT secret used to sign the Reset Password flow JWT's",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled'",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | e0f803cea09a1fa61b91cc1a51a663bbe6d1f5bb | 2024-03-10T22:22:24 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule.",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests.",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section.",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to.",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to.",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to.",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to."
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to.",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match.",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to.",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to.",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to.",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to.",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to.",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule.",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration.",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration.",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour.",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend.",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia.",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database.",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour.",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database.",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use.",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters.",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters.",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters.",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters.",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters.",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length.",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used.",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used.",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length.",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used.",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used.",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used.",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used.",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used.",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used.",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used.",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used.",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used.",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used.",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used.",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used.",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used.",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used.",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search.",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username.",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups.",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users.",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server.",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations.",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects.",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects.",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values.",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding.",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup.",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals.",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind.",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS.",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties.",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding.",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects.",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of.",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users.",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects.",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups.",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups.",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users.",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL.",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option.",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration.",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration.",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted.",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them.",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration.",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration.",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration.",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration.",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration.",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration.",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration.",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration.",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration.",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration.",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration.",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration.",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration.",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI.",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration.",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration.",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration.",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow.",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard.",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard.",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard.",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing.",
"title": "CORS"
},
"discovery_signed_response_alg": {
"default": "none",
"description": "The Algorithm this provider uses to sign the Discovery and Metadata Document responses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Discovery Response Signing Algorithm",
"type": "string"
},
"discovery_signed_response_key_id": {
"description": "The Key ID this provider uses to sign the Discovery and Metadata Document responses (overrides the 'discovery_signed_response_alg').",
"title": "Discovery Response Signing Key ID",
"type": "string"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients.",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended.",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges.",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients.",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens.",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"deprecated": true,
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens.",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"deprecated": true,
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens.",
"pattern": "^-{5}(BEGIN (RSA )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (RSA )?PRIVATE KEY-{5}\\n?)+$",
"title": "Issuer Private Key",
"type": "string"
},
"jwks": {
"description": "The JWK's which are to be used to sign various objects like ID Tokens.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer JSON Web Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration.",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter.",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests.",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests.",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients.",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for.",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg').",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences.",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client.",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg').",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"client_id": {
"description": "The Client ID.",
"minLength": 1,
"title": "Client ID",
"type": "string"
},
"client_name": {
"description": "The Client Name displayed to End-Users.",
"title": "Client Name",
"type": "string"
},
"client_secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication.",
"title": "Client Secret"
},
"consent_mode": {
"description": "The Consent Mode used for this client.",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints.",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token",
"client_credentials"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg').",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg').",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"jwks": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "JSON Web Keys",
"type": "array"
},
"jwks_uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"format": "uri",
"title": "JSON Web Keys URI",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client.",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client.",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type.",
"title": "Public",
"type": "boolean"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs.",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client.",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"require_pkce": {
"default": false,
"description": "Requires a Proof Key for this client to perform Code Exchange.",
"title": "Require PKCE",
"type": "boolean"
},
"require_pushed_authorization_requests": {
"default": false,
"description": "Requires Pushed Authorization Requests for this client to perform an authorization.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
},
"response_modes": {
"description": "The Response Modes this client is authorized request.",
"items": {
"enum": [
"form_post",
"form_post.jwt",
"query",
"query.jwt",
"fragment",
"fragment.jwt",
"jwt"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request.",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted.",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile",
"authelia.bearer.authz"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"sector_identifier_uri": {
"description": "The Client Sector Identifier URI for Privacy Isolation via Pairwise subject types.",
"format": "uri",
"title": "Sector Identifier URI",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client.",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg').",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"client_id",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types.",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant.",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant.",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant.",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant.",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM).",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients.",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows.",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow.",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"elevation_expiration": {
"description": "Duration of time the elevation can exist for after the user performs the validation.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Expiration"
},
"expiration": {
"description": "Duration of time the OTP code is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes.",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods.",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor.",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"expiration": {
"description": "Duration of time the JWT is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"jwt_algorithm": {
"default": "HS256",
"description": "The JWT Algorithm (JWA) used to sign the Reset Password flow JWT's.",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_secret": {
"description": "The JWT secret used to sign the Reset Password flow JWT's.",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK.",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format.",
"pattern": "^-{5}BEGIN (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n?$",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK.",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK.",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled.",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages.",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option.",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log.",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server.",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error.",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely.",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use.",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks.",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier.",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier.",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides.",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications.",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address.",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version.",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS.",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it.",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command.",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP.",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check.",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used.",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties.",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine.",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine.",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length.",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length.",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters.",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters.",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters.",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters.",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed.",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality.",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy.",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy.",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user.",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on.",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside.",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration.",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality.",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration.",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration.",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration.",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration.",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size.",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size.",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints.",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint.",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint.",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use.",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
},
"schemes": {
"default": [
"basic"
],
"description": "The name of the authorization schemes to allow with the header strategies.",
"items": {
"enum": [
"basic",
"bearer"
],
"type": "string"
},
"title": "Authorization Schemes",
"type": "array"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template.",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate.",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS.",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key.",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations.",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration.",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data.",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration.",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration.",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration.",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index.",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host.",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time.",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis.",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password.",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port.",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance.",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode.",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode.",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance.",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port.",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine.",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings.",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings.",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings.",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file.",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use.",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options.",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options.",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options.",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options.",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain.",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted.",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted.",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key.",
"pattern": "^-{5}BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against.",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties.",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys.",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default.",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default.",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default.",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys.",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code.",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys.",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys.",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys.",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys.",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration.",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on.",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server.",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server.",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server.",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials.",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party.",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials.",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 2b9281564070eac6aeafa35024f31e902c214c44 | 2024-03-11T14:35:49 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule.",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests.",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section.",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to.",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to.",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to.",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to."
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to.",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match.",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to.",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to.",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to.",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to.",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to.",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule.",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration.",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration.",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour.",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend.",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia.",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database.",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour.",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database.",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use.",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters.",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters.",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters.",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters.",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters.",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length.",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used.",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used.",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length.",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used.",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used.",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used.",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used.",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used.",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used.",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used.",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used.",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used.",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used.",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used.",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used.",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used.",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used.",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search.",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username.",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups.",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users.",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server.",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations.",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects.",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects.",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values.",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding.",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup.",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals.",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind.",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS.",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties.",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding.",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects.",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of.",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users.",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects.",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups.",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups.",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users.",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL.",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option.",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration.",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration.",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted.",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them.",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration.",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration.",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration.",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration.",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration.",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration.",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration.",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration.",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration.",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration.",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration.",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration.",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration.",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI.",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration.",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration.",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration.",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow.",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard.",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard.",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard.",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing.",
"title": "CORS"
},
"discovery_signed_response_alg": {
"default": "none",
"description": "The Algorithm this provider uses to sign the Discovery and Metadata Document responses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Discovery Response Signing Algorithm",
"type": "string"
},
"discovery_signed_response_key_id": {
"description": "The Key ID this provider uses to sign the Discovery and Metadata Document responses (overrides the 'discovery_signed_response_alg').",
"title": "Discovery Response Signing Key ID",
"type": "string"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients.",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended.",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges.",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients.",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens.",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"deprecated": true,
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens.",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"deprecated": true,
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens.",
"pattern": "^-{5}(BEGIN (RSA )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (RSA )?PRIVATE KEY-{5}\\n?)+$",
"title": "Issuer Private Key",
"type": "string"
},
"jwks": {
"description": "The JWK's which are to be used to sign various objects like ID Tokens.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer JSON Web Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration.",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter.",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"require_pushed_authorization_requests": {
"description": "Requires Pushed Authorization Requests for all clients for this Issuer.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests.",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients.",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for.",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg').",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences.",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client.",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg').",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"client_id": {
"description": "The Client ID.",
"minLength": 1,
"title": "Client ID",
"type": "string"
},
"client_name": {
"description": "The Client Name displayed to End-Users.",
"title": "Client Name",
"type": "string"
},
"client_secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication.",
"title": "Client Secret"
},
"consent_mode": {
"description": "The Consent Mode used for this client.",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints.",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token",
"client_credentials"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg').",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg').",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"jwks": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "JSON Web Keys",
"type": "array"
},
"jwks_uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"format": "uri",
"title": "JSON Web Keys URI",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client.",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client.",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type.",
"title": "Public",
"type": "boolean"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs.",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client.",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"require_pkce": {
"default": false,
"description": "Requires a Proof Key for this client to perform Code Exchange.",
"title": "Require PKCE",
"type": "boolean"
},
"require_pushed_authorization_requests": {
"default": false,
"description": "Requires Pushed Authorization Requests for this client to perform an authorization.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
},
"response_modes": {
"description": "The Response Modes this client is authorized request.",
"items": {
"enum": [
"form_post",
"form_post.jwt",
"query",
"query.jwt",
"fragment",
"fragment.jwt",
"jwt"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request.",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted.",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile",
"authelia.bearer.authz"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"sector_identifier_uri": {
"description": "The Client Sector Identifier URI for Privacy Isolation via Pairwise subject types.",
"format": "uri",
"title": "Sector Identifier URI",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client.",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg').",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"client_id",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types.",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant.",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant.",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant.",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant.",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM).",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows.",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow.",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"elevation_expiration": {
"description": "Duration of time the elevation can exist for after the user performs the validation.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Expiration"
},
"expiration": {
"description": "Duration of time the OTP code is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes.",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods.",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor.",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"expiration": {
"description": "Duration of time the JWT is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"jwt_algorithm": {
"default": "HS256",
"description": "The JWT Algorithm (JWA) used to sign the Reset Password flow JWT's.",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_secret": {
"description": "The JWT secret used to sign the Reset Password flow JWT's.",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK.",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format.",
"pattern": "^-{5}BEGIN (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n?$",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK.",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK.",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled.",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages.",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option.",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log.",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server.",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error.",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely.",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use.",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks.",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier.",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier.",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides.",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications.",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address.",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version.",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS.",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it.",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command.",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP.",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check.",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used.",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties.",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine.",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine.",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length.",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length.",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters.",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters.",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters.",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters.",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed.",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality.",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy.",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy.",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user.",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on.",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside.",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration.",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality.",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration.",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration.",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration.",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration.",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size.",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size.",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints.",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint.",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint.",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use.",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
},
"schemes": {
"default": [
"basic"
],
"description": "The name of the authorization schemes to allow with the header strategies.",
"items": {
"enum": [
"basic",
"bearer"
],
"type": "string"
},
"title": "Authorization Schemes",
"type": "array"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template.",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate.",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS.",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key.",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations.",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration.",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data.",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration.",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration.",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration.",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index.",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host.",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time.",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis.",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password.",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port.",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance.",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode.",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode.",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance.",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port.",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine.",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings.",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings.",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings.",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file.",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use.",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options.",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options.",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options.",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options.",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain.",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted.",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted.",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key.",
"pattern": "^-{5}BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against.",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties.",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys.",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default.",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default.",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default.",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys.",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code.",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys.",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys.",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys.",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys.",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration.",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on.",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server.",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server.",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server.",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials.",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party.",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials.",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 40026701fdf604b874334166b9984f6ac003f0fa | 2023-09-03T06:01:46 | docs/static/schemas/latest/json-schema/exports.totp.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"TOTPConfigurationData": {
"additionalProperties": false,
"properties": {
"algorithm": {
"description": "The algorithm this configuration uses",
"title": "Algorithm",
"type": "string"
},
"created_at": {
"description": "The time the configuration was created",
"format": "date-time",
"title": "Created At",
"type": "string"
},
"digits": {
"description": "The number of digits this configuration uses",
"title": "Digits",
"type": "integer"
},
"issuer": {
"description": "The issuer name this was generated with",
"title": "Issuer",
"type": "string"
},
"last_used_at": {
"description": "The time the configuration was last used at",
"format": "date-time",
"title": "Last Used At",
"type": "string"
},
"period": {
"description": "The period of time this configuration uses",
"title": "Period",
"type": "integer"
},
"secret": {
"description": "The secret shared key for this configuration",
"title": "Secret",
"type": "string"
},
"username": {
"description": "The username of the user this configuration belongs to",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"TOTPConfigurationDataExport": {
"additionalProperties": false,
"properties": {
"totp_configurations": {
"description": "The list of TOTP configurations",
"items": {
"$ref": "#/$defs/TOTPConfigurationData"
},
"title": "TOTP Configurations",
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/exports.totp.json",
"$ref": "#/$defs/TOTPConfigurationDataExport",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 723b02945783b66f455759fc75b9a297dd44c647 | 2024-03-04T09:29:12 | docs/static/schemas/v4.38/json-schema/exports.webauthn.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"WebAuthnCredentialData": {
"additionalProperties": false,
"properties": {
"aaguid": {
"description": "The Authenticator Attestation Global Unique Identifier of this credential.",
"title": "AAGUID",
"type": "string"
},
"attachment": {
"description": "The last recorded credential attachment type.",
"title": "Attachment",
"type": "string"
},
"attestation_type": {
"description": "The attestation format type this credential uses.",
"title": "Attestation Type",
"type": "string"
},
"backup_eligible": {
"description": "The backup eligible status of this credential.",
"title": "Backup Eligible",
"type": "boolean"
},
"backup_state": {
"description": "The backup eligible status of this credential.",
"title": "Backup Eligible",
"type": "boolean"
},
"clone_warning": {
"description": "The clone warning status of the credential.",
"title": "Clone Warning",
"type": "boolean"
},
"created_at": {
"description": "The time this credential was created.",
"format": "date-time",
"title": "Created At",
"type": "string"
},
"description": {
"description": "The user description of this credential.",
"title": "Description",
"type": "string"
},
"discoverable": {
"description": "The discoverable status of this credential.",
"title": "Discoverable",
"type": "boolean"
},
"id": {
"type": "integer"
},
"kid": {
"description": "The Public Key ID of this credential.",
"title": "Public Key ID",
"type": "string"
},
"last_used_at": {
"description": "The last time this credential was used.",
"format": "date-time",
"title": "Last Used At",
"type": "string"
},
"legacy": {
"description": "The legacy value indicates this credential may need to be registered again.",
"title": "Legacy",
"type": "boolean"
},
"present": {
"description": "The user presence status of this credential.",
"title": "Present",
"type": "boolean"
},
"public_key": {
"description": "The credential public key.",
"title": "Public Key",
"type": "string"
},
"rpid": {
"description": "The Relying Party ID used to register this credential.",
"title": "Relying Party ID",
"type": "string"
},
"sign_count": {
"description": "The last recorded credential sign count.",
"title": "Sign Count",
"type": "integer"
},
"transports": {
"description": "The last recorded credential transports.",
"items": {
"type": "string"
},
"title": "Transports",
"type": "array"
},
"username": {
"description": "The username of the user this credential belongs to.",
"title": "Username",
"type": "string"
},
"verified": {
"description": "The verified status of this credential.",
"title": "Verified",
"type": "boolean"
}
},
"type": "object"
},
"WebAuthnCredentialDataExport": {
"additionalProperties": false,
"properties": {
"webauthn_credentials": {
"description": "The list of WebAuthn credentials.",
"items": {
"$ref": "#/$defs/WebAuthnCredentialData"
},
"title": "WebAuthn Credentials",
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/exports.webauthn.json",
"$ref": "#/$defs/WebAuthnCredentialDataExport",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | ce58650ff96d61d9879be71bb329d040668fd404 | 2023-12-29T09:35:24 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"jwt_secret": {
"description": "Used for signing HS256 JWT's for identity verification",
"title": "Secret Key for JWT's",
"type": "string"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled'",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | d0cf1c1014d45b34476e6c7ab668506377e4c4ad | 2024-04-25T09:36:47 | docs/static/schemas/v4.39/json-schema/exports.totp.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"TOTPConfigurationData": {
"additionalProperties": false,
"properties": {
"algorithm": {
"description": "The algorithm this configuration uses.",
"title": "Algorithm",
"type": "string"
},
"created_at": {
"description": "The time the configuration was created.",
"format": "date-time",
"title": "Created At",
"type": "string"
},
"digits": {
"description": "The number of digits this configuration uses.",
"title": "Digits",
"type": "integer"
},
"issuer": {
"description": "The issuer name this was generated with.",
"title": "Issuer",
"type": "string"
},
"last_used_at": {
"description": "The time the configuration was last used at.",
"format": "date-time",
"title": "Last Used At",
"type": "string"
},
"period": {
"description": "The period of time this configuration uses.",
"title": "Period",
"type": "integer"
},
"secret": {
"description": "The secret shared key for this configuration.",
"title": "Secret",
"type": "string"
},
"username": {
"description": "The username of the user this configuration belongs to.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"TOTPConfigurationDataExport": {
"additionalProperties": false,
"properties": {
"totp_configurations": {
"description": "The list of TOTP configurations.",
"items": {
"$ref": "#/$defs/TOTPConfigurationData"
},
"title": "TOTP Configurations",
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://www.authelia.com/schemas/v4.39/json-schema/exports.totp.json",
"$ref": "#/$defs/TOTPConfigurationDataExport",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 40026701fdf604b874334166b9984f6ac003f0fa | 2023-09-03T06:01:46 | docs/static/schemas/v4.38/json-schema/user-database.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"FileUserDatabase": {
"additionalProperties": false,
"description": "FileUserDatabase is a user details database that is concurrency safe database and can be reloaded.",
"properties": {
"users": {
"description": "The dictionary of users",
"patternProperties": {
".*": {
"$ref": "#/$defs/FileUserDatabaseUserDetails"
}
},
"title": "Users",
"type": "object"
}
},
"required": [
"users"
],
"type": "object"
},
"FileUserDatabaseUserDetails": {
"additionalProperties": false,
"description": "FileUserDatabaseUserDetails is the model of user details in the file database.",
"properties": {
"disabled": {
"default": false,
"description": "The disabled status for the user",
"title": "Disabled",
"type": "boolean"
},
"displayname": {
"description": "The display name for the user",
"title": "Display Name",
"type": "string"
},
"email": {
"description": "The email for the user",
"title": "Email",
"type": "string"
},
"groups": {
"description": "The groups list for the user",
"items": {
"type": "string"
},
"title": "Groups",
"type": "array"
},
"password": {
"$ref": "#/$defs/PasswordDigest",
"description": "The hashed password for the user",
"title": "Password"
}
},
"required": [
"password",
"displayname"
],
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/user-database.json",
"$ref": "#/$defs/FileUserDatabase",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 40026701fdf604b874334166b9984f6ac003f0fa | 2023-09-03T06:01:46 | docs/static/schemas/v4.38/json-schema/exports.totp.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"TOTPConfigurationData": {
"additionalProperties": false,
"properties": {
"algorithm": {
"description": "The algorithm this configuration uses",
"title": "Algorithm",
"type": "string"
},
"created_at": {
"description": "The time the configuration was created",
"format": "date-time",
"title": "Created At",
"type": "string"
},
"digits": {
"description": "The number of digits this configuration uses",
"title": "Digits",
"type": "integer"
},
"issuer": {
"description": "The issuer name this was generated with",
"title": "Issuer",
"type": "string"
},
"last_used_at": {
"description": "The time the configuration was last used at",
"format": "date-time",
"title": "Last Used At",
"type": "string"
},
"period": {
"description": "The period of time this configuration uses",
"title": "Period",
"type": "integer"
},
"secret": {
"description": "The secret shared key for this configuration",
"title": "Secret",
"type": "string"
},
"username": {
"description": "The username of the user this configuration belongs to",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"TOTPConfigurationDataExport": {
"additionalProperties": false,
"properties": {
"totp_configurations": {
"description": "The list of TOTP configurations",
"items": {
"$ref": "#/$defs/TOTPConfigurationData"
},
"title": "TOTP Configurations",
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/exports.totp.json",
"$ref": "#/$defs/TOTPConfigurationDataExport",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | e618cf341627a89b5fec594090cf765c86aafaad | 2024-03-04T09:28:24 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"credential_management": {
"$ref": "#/$defs/IdentityValidationCredentials",
"description": "Identity validation options for the Credential Management flows",
"title": "Credential Management"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity validation options for the Reset Password flow",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationCredentials": {
"additionalProperties": false,
"description": "IdentityValidationCredentials represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"elevation_expiration": {
"description": "Duration of time the elevation can exist for after the user performs the validation",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Expiration"
},
"expiration": {
"description": "Duration of time the OTP code is considered valid",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"otp_characters": {
"description": "Number of characters in the generated OTP codes",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"skip_2fa": {
"description": "Skips 2FA requirement TODO",
"title": "Skip 2FA",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"expiration": {
"description": "Duration of time the JWT is considered valid",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"jwt_algorithm": {
"default": "HS256",
"description": "The JWT Algorithm (JWA) used to sign the Reset Password flow JWT's'",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_secret": {
"description": "The JWT secret used to sign the Reset Password flow JWT's",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled'",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 723b02945783b66f455759fc75b9a297dd44c647 | 2024-03-04T09:29:12 | docs/static/schemas/latest/json-schema/exports.identifiers.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"UUID": {
"items": {
"type": "integer"
},
"maxItems": 16,
"minItems": 16,
"type": "array"
},
"UserOpaqueIdentifier": {
"additionalProperties": false,
"properties": {
"ID": {
"type": "integer"
},
"identifier": {
"$ref": "#/$defs/UUID",
"description": "The random UUID for this opaque identifier.",
"title": "Identifier"
},
"sector_id": {
"description": "Sector Identifier this UUID is used with.",
"title": "Sector Identifier",
"type": "string"
},
"service": {
"description": "The service name this UUID is used with.",
"title": "Service",
"type": "string"
},
"username": {
"description": "The username of the user this UUID is for.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"UserOpaqueIdentifiersExport": {
"additionalProperties": false,
"properties": {
"identifiers": {
"description": "The list of opaque identifiers.",
"items": {
"$ref": "#/$defs/UserOpaqueIdentifier"
},
"title": "Identifiers",
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/exports.identifiers.json",
"$ref": "#/$defs/UserOpaqueIdentifiersExport",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 40026701fdf604b874334166b9984f6ac003f0fa | 2023-09-03T06:01:46 | docs/static/schemas/latest/json-schema/exports.webauthn.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"WebAuthnDeviceData": {
"additionalProperties": false,
"properties": {
"aaguid": {
"description": "The Authenticator Attestation Global Unique Identifier of this device",
"title": "AAGUID",
"type": "string"
},
"attestation_type": {
"description": "The attestation format type this device uses",
"title": "Attestation Type",
"type": "string"
},
"clone_warning": {
"description": "The clone warning status of the device",
"title": "Clone Warning",
"type": "boolean"
},
"created_at": {
"description": "The time this device was created",
"format": "date-time",
"title": "Created At",
"type": "string"
},
"description": {
"description": "The user description of this device",
"title": "Description",
"type": "string"
},
"id": {
"type": "integer"
},
"kid": {
"description": "The Public Key ID of this device",
"title": "Public Key ID",
"type": "string"
},
"last_used_at": {
"description": "The last time this device was used",
"format": "date-time",
"title": "Last Used At",
"type": "string"
},
"public_key": {
"description": "The device public key",
"title": "Public Key",
"type": "string"
},
"rpid": {
"description": "The Relying Party ID used to register this device",
"title": "Relying Party ID",
"type": "string"
},
"sign_count": {
"description": "The last recorded device sign count",
"title": "Sign Count",
"type": "integer"
},
"transports": {
"description": "The last recorded device transports",
"items": {
"type": "string"
},
"title": "Transports",
"type": "array"
},
"username": {
"description": "The username of the user this device belongs to",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"WebAuthnDeviceDataExport": {
"additionalProperties": false,
"properties": {
"webauthn_devices": {
"description": "The list of WebAuthn devices",
"items": {
"$ref": "#/$defs/WebAuthnDeviceData"
},
"title": "WebAuthn Devices",
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/exports.webauthn.json",
"$ref": "#/$defs/WebAuthnDeviceDataExport",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | c0dbdd97ab2ac580e3da07a0137dbc7a1b9c9b83 | 2024-03-04T09:28:24 | docs/static/schemas/v4.38/json-schema/exports.webauthn.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"WebAuthnCredentialData": {
"additionalProperties": false,
"properties": {
"aaguid": {
"description": "The Authenticator Attestation Global Unique Identifier of this credential",
"title": "AAGUID",
"type": "string"
},
"attachment": {
"description": "The last recorded credential attachment type",
"title": "Attachment",
"type": "string"
},
"attestation_type": {
"description": "The attestation format type this credential uses",
"title": "Attestation Type",
"type": "string"
},
"backup_eligible": {
"description": "The backup eligible status of this credential",
"title": "Backup Eligible",
"type": "boolean"
},
"backup_state": {
"description": "The backup eligible status of this credential",
"title": "Backup Eligible",
"type": "boolean"
},
"clone_warning": {
"description": "The clone warning status of the credential",
"title": "Clone Warning",
"type": "boolean"
},
"created_at": {
"description": "The time this credential was created",
"format": "date-time",
"title": "Created At",
"type": "string"
},
"description": {
"description": "The user description of this credential",
"title": "Description",
"type": "string"
},
"discoverable": {
"description": "The discoverable status of this credential",
"title": "Discoverable",
"type": "boolean"
},
"id": {
"type": "integer"
},
"kid": {
"description": "The Public Key ID of this credential",
"title": "Public Key ID",
"type": "string"
},
"last_used_at": {
"description": "The last time this credential was used",
"format": "date-time",
"title": "Last Used At",
"type": "string"
},
"present": {
"description": "The user presence status of this credential",
"title": "Present",
"type": "boolean"
},
"public_key": {
"description": "The credential public key",
"title": "Public Key",
"type": "string"
},
"rpid": {
"description": "The Relying Party ID used to register this credential",
"title": "Relying Party ID",
"type": "string"
},
"sign_count": {
"description": "The last recorded credential sign count",
"title": "Sign Count",
"type": "integer"
},
"transports": {
"description": "The last recorded credential transports",
"items": {
"type": "string"
},
"title": "Transports",
"type": "array"
},
"username": {
"description": "The username of the user this credential belongs to",
"title": "Username",
"type": "string"
},
"verified": {
"description": "The verified status of this credential",
"title": "Verified",
"type": "boolean"
}
},
"type": "object"
},
"WebAuthnCredentialDataExport": {
"additionalProperties": false,
"properties": {
"webauthn_credentials": {
"description": "The list of WebAuthn credentials",
"items": {
"$ref": "#/$defs/WebAuthnCredentialData"
},
"title": "WebAuthn Credentials",
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/exports.webauthn.json",
"$ref": "#/$defs/WebAuthnCredentialDataExport",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 28389020fff56c40133763b9f2048e9d210888a4 | 2023-10-07T22:54:37 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?umask=[0-7]{3,4})?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"jwt_secret": {
"description": "Used for signing HS256 JWT's for identity verification",
"title": "Secret Key for JWT's",
"type": "string"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled'",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | caf9c61342fdd8c3b2943375e516aa3ab62194a1 | 2024-03-14T10:20:32 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule.",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests.",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section.",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to.",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to.",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to.",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to."
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to.",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match.",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to.",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to.",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to.",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to.",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to.",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule.",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration.",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration.",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour.",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend.",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia.",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database.",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour.",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database.",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use.",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters.",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters.",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters.",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters.",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters.",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length.",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used.",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used.",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length.",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used.",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used.",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used.",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used.",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used.",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used.",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used.",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used.",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used.",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used.",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used.",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used.",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used.",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used.",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search.",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username.",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups.",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users.",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server.",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations.",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects.",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects.",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values.",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding.",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup.",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals.",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind.",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS.",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties.",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding.",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects.",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of.",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users.",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects.",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups.",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups.",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users.",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL.",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option.",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration.",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration.",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted.",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them.",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration.",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration.",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration.",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration.",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration.",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration.",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration.",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration.",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration.",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration.",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration.",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration.",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration.",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI.",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration.",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration.",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration.",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow.",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard.",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard.",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard.",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing.",
"title": "CORS"
},
"discovery_signed_response_alg": {
"default": "none",
"description": "The Algorithm this provider uses to sign the Discovery and Metadata Document responses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Discovery Response Signing Algorithm",
"type": "string"
},
"discovery_signed_response_key_id": {
"description": "The Key ID this provider uses to sign the Discovery and Metadata Document responses (overrides the 'discovery_signed_response_alg').",
"title": "Discovery Response Signing Key ID",
"type": "string"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients.",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended.",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges.",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients.",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens.",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"deprecated": true,
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens.",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"deprecated": true,
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens.",
"pattern": "^-{5}(BEGIN (RSA )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (RSA )?PRIVATE KEY-{5}\\n?)+$",
"title": "Issuer Private Key",
"type": "string"
},
"jwks": {
"description": "The JWK's which are to be used to sign various objects like ID Tokens.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer JSON Web Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration.",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter.",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"require_pushed_authorization_requests": {
"description": "Requires Pushed Authorization Requests for all clients for this Issuer.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests.",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients.",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for.",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg').",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences.",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client.",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg').",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"client_id": {
"description": "The Client ID.",
"minLength": 1,
"title": "Client ID",
"type": "string"
},
"client_name": {
"description": "The Client Name displayed to End-Users.",
"title": "Client Name",
"type": "string"
},
"client_secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication.",
"title": "Client Secret"
},
"consent_mode": {
"description": "The Consent Mode used for this client.",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints.",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token",
"client_credentials"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg').",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg').",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"jwks": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "JSON Web Keys",
"type": "array"
},
"jwks_uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"format": "uri",
"title": "JSON Web Keys URI",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client.",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client.",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type.",
"title": "Public",
"type": "boolean"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs.",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client.",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"require_pkce": {
"default": false,
"description": "Requires a Proof Key for this client to perform Code Exchange.",
"title": "Require PKCE",
"type": "boolean"
},
"require_pushed_authorization_requests": {
"default": false,
"description": "Requires Pushed Authorization Requests for this client to perform an authorization.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
},
"response_modes": {
"description": "The Response Modes this client is authorized request.",
"items": {
"enum": [
"form_post",
"form_post.jwt",
"query",
"query.jwt",
"fragment",
"fragment.jwt",
"jwt"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request.",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted.",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile",
"authelia.bearer.authz"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"sector_identifier_uri": {
"description": "The Client Sector Identifier URI for Privacy Isolation via Pairwise subject types.",
"format": "uri",
"title": "Sector Identifier URI",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client.",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg').",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"client_id",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types.",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant.",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant.",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant.",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant.",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM).",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows.",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow.",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"code_lifespan": {
"description": "The lifespan of the randomly generated One Time Code after which it's considered invalid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Code Lifespan"
},
"elevation_lifespan": {
"description": "The lifespan of the elevation after initially validating the One-Time Code before it expires.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Lifespan"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes.",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods.",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor.",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"jwt_algorithm": {
"default": "HS256",
"description": "The JSON Web Token Algorithm (JWA) used to sign the Reset Password flow JSON Web Token's.",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_lifespan": {
"description": "The lifespan of the JSON Web Token after it's initially generated after which it's considered invalid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JWT Lifespan"
},
"jwt_secret": {
"description": "The secret key used to sign the Reset Password flow JSON Web Token's.",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK.",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format.",
"pattern": "^-{5}BEGIN (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n?$",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK.",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK.",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled.",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages.",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option.",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log.",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server.",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error.",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely.",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use.",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks.",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier.",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier.",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides.",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications.",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address.",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version.",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS.",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it.",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command.",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP.",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check.",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used.",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties.",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine.",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine.",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length.",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length.",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters.",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters.",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters.",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters.",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed.",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality.",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy.",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy.",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user.",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on.",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside.",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration.",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality.",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration.",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration.",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration.",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration.",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size.",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size.",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints.",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint.",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint.",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use.",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
},
"schemes": {
"default": [
"basic"
],
"description": "The name of the authorization schemes to allow with the header strategies.",
"items": {
"enum": [
"basic",
"bearer"
],
"type": "string"
},
"title": "Authorization Schemes",
"type": "array"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template.",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate.",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS.",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key.",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations.",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration.",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data.",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration.",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration.",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration.",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index.",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host.",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time.",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis.",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password.",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port.",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance.",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode.",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode.",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance.",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port.",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine.",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings.",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings.",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings.",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file.",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use.",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options.",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options.",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options.",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options.",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain.",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted.",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted.",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key.",
"pattern": "^-{5}BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against.",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties.",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys.",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default.",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default.",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default.",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys.",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code.",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys.",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys.",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys.",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys.",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration.",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on.",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server.",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server.",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server.",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials.",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party.",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials.",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 87d2a3419d6f29db900bc1aeb4cf5d7769a15ce3 | 2024-03-04T09:28:24 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"jwt_secret": {
"description": "Used for signing HS256 JWT's for identity verification",
"title": "Secret Key for JWT's",
"type": "string"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled'",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"description": "List of algorithms the user is allowed to select in addition to the default",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"description": "List of periods the user is allowed to select in addition to the default",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 723b02945783b66f455759fc75b9a297dd44c647 | 2024-03-04T09:29:12 | docs/static/schemas/latest/json-schema/exports.totp.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"TOTPConfigurationData": {
"additionalProperties": false,
"properties": {
"algorithm": {
"description": "The algorithm this configuration uses.",
"title": "Algorithm",
"type": "string"
},
"created_at": {
"description": "The time the configuration was created.",
"format": "date-time",
"title": "Created At",
"type": "string"
},
"digits": {
"description": "The number of digits this configuration uses.",
"title": "Digits",
"type": "integer"
},
"issuer": {
"description": "The issuer name this was generated with.",
"title": "Issuer",
"type": "string"
},
"last_used_at": {
"description": "The time the configuration was last used at.",
"format": "date-time",
"title": "Last Used At",
"type": "string"
},
"period": {
"description": "The period of time this configuration uses.",
"title": "Period",
"type": "integer"
},
"secret": {
"description": "The secret shared key for this configuration.",
"title": "Secret",
"type": "string"
},
"username": {
"description": "The username of the user this configuration belongs to.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"TOTPConfigurationDataExport": {
"additionalProperties": false,
"properties": {
"totp_configurations": {
"description": "The list of TOTP configurations.",
"items": {
"$ref": "#/$defs/TOTPConfigurationData"
},
"title": "TOTP Configurations",
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/exports.totp.json",
"$ref": "#/$defs/TOTPConfigurationDataExport",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | ab4d14c890bc2f79a1f7e684746bc5659c819356 | 2024-03-27T11:25:35 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule.",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests.",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section.",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to.",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to.",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to.",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to."
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to.",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match.",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to.",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to.",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to.",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to.",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to.",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule.",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration.",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration.",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour.",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend.",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia.",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database.",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour.",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database.",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use.",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters.",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters.",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters.",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters.",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters.",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length.",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used.",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used.",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length.",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used.",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used.",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used.",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used.",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used.",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used.",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used.",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used.",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used.",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used.",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used.",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used.",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used.",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used.",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search.",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username.",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups.",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users.",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server.",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations.",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects.",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects.",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values.",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding.",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup.",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals.",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind.",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS.",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties.",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding.",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects.",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of.",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users.",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects.",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups.",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups.",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users.",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL.",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option.",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration.",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration.",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted.",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them.",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration.",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration.",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration.",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration.",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration.",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration.",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration.",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration.",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration.",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration.",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration.",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration.",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration.",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI.",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration.",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration.",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration.",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow.",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard.",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard.",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard.",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing.",
"title": "CORS"
},
"discovery_signed_response_alg": {
"default": "none",
"description": "The Algorithm this provider uses to sign the Discovery and Metadata Document responses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Discovery Response Signing Algorithm",
"type": "string"
},
"discovery_signed_response_key_id": {
"description": "The Key ID this provider uses to sign the Discovery and Metadata Document responses (overrides the 'discovery_signed_response_alg').",
"title": "Discovery Response Signing Key ID",
"type": "string"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients.",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended.",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges.",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients.",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens.",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"deprecated": true,
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens.",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"deprecated": true,
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens.",
"pattern": "^-{5}(BEGIN (RSA )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (RSA )?PRIVATE KEY-{5}\\n?)+$",
"title": "Issuer Private Key",
"type": "string"
},
"jwks": {
"description": "The JWK's which are to be used to sign various objects like ID Tokens.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer JSON Web Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration.",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter.",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"require_pushed_authorization_requests": {
"description": "Requires Pushed Authorization Requests for all clients for this Issuer.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests.",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients.",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for.",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg').",
"title": "Access Token Signing Key ID",
"type": "string"
},
"allow_multiple_auth_methods": {
"description": "Permits this registered client to accept misbehaving clients which use a broad authentication approach. This is not standards complaint, use at your own security risk.",
"title": "Allow Multiple Authentication Methods",
"type": "boolean"
},
"audience": {
"description": "List of authorized audiences.",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client.",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg').",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"client_id": {
"description": "The Client ID.",
"minLength": 1,
"title": "Client ID",
"type": "string"
},
"client_name": {
"description": "The Client Name displayed to End-Users.",
"title": "Client Name",
"type": "string"
},
"client_secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication.",
"title": "Client Secret"
},
"consent_mode": {
"description": "The Consent Mode used for this client.",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints.",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token",
"client_credentials"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg').",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg').",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"jwks": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "JSON Web Keys",
"type": "array"
},
"jwks_uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"format": "uri",
"title": "JSON Web Keys URI",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client.",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client.",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type.",
"title": "Public",
"type": "boolean"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientURIs",
"description": "List of whitelisted redirect URIs.",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"request_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientURIs",
"description": "List of whitelisted request URIs.",
"title": "Request URIs"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client.",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"require_pkce": {
"default": false,
"description": "Requires a Proof Key for this client to perform Code Exchange.",
"title": "Require PKCE",
"type": "boolean"
},
"require_pushed_authorization_requests": {
"default": false,
"description": "Requires Pushed Authorization Requests for this client to perform an authorization.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
},
"response_modes": {
"description": "The Response Modes this client is authorized request.",
"items": {
"enum": [
"form_post",
"form_post.jwt",
"query",
"query.jwt",
"fragment",
"fragment.jwt",
"jwt"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request.",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted.",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile",
"authelia.bearer.authz"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"sector_identifier_uri": {
"description": "The Client Sector Identifier URI for Privacy Isolation via Pairwise subject types.",
"format": "uri",
"title": "Sector Identifier URI",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client.",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg').",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"client_id",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types.",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant.",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant.",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant.",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant.",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM).",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows.",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow.",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"code_lifespan": {
"description": "The lifespan of the randomly generated One Time Code after which it's considered invalid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Code Lifespan"
},
"elevation_lifespan": {
"description": "The lifespan of the elevation after initially validating the One-Time Code before it expires.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Lifespan"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes.",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods.",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor.",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"jwt_algorithm": {
"default": "HS256",
"description": "The JSON Web Token Algorithm (JWA) used to sign the Reset Password flow JSON Web Token's.",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_lifespan": {
"description": "The lifespan of the JSON Web Token after it's initially generated after which it's considered invalid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JWT Lifespan"
},
"jwt_secret": {
"description": "The secret key used to sign the Reset Password flow JSON Web Token's.",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK.",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format.",
"pattern": "^-{5}BEGIN (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n?$",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK.",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK.",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled.",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages.",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option.",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log.",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server.",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error.",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely.",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use.",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks.",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier.",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier.",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides.",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications.",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address.",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version.",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS.",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it.",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command.",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP.",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check.",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used.",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties.",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine.",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine.",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length.",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length.",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters.",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters.",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters.",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters.",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed.",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality.",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy.",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy.",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user.",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on.",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside.",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration.",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality.",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration.",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration.",
"title": "Headers"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration.",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration.",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size.",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size.",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints.",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint.",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint.",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use.",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
},
"schemes": {
"default": [
"basic"
],
"description": "The name of the authorization schemes to allow with the header strategies.",
"items": {
"enum": [
"basic",
"bearer"
],
"type": "string"
},
"title": "Authorization Schemes",
"type": "array"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template.",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate.",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS.",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key.",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations.",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration.",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data.",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration.",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration.",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration.",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index.",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host.",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time.",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis.",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password.",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port.",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance.",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode.",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode.",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance.",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port.",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine.",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings.",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings.",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings.",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file.",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"schema": {
"default": "public",
"description": "The default schema name to use.",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options.",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options.",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options.",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options.",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain.",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted.",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted.",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key.",
"pattern": "^-{5}BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against.",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties.",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys.",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default.",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default.",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default.",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys.",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code.",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys.",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys.",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys.",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys.",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration.",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on.",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server.",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server.",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server.",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials.",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party.",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials.",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | c49b973120c7fd755923a2b88afd794c7d320d6e | 2023-11-22T21:20:36 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?umask=[0-7]{3,4})?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"jwt_secret": {
"description": "Used for signing HS256 JWT's for identity verification",
"title": "Secret Key for JWT's",
"type": "string"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled'",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 438e433e5b211512954f3c6ae5255269883f65e3 | 2024-03-16T08:07:54 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule.",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests.",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section.",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to.",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to.",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to.",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to."
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to.",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match.",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to.",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to.",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to.",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to.",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to.",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule.",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration.",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration.",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour.",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend.",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia.",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database.",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour.",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database.",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use.",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters.",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters.",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters.",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters.",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters.",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length.",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used.",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used.",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length.",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used.",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used.",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used.",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used.",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used.",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used.",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used.",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used.",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used.",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used.",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used.",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used.",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used.",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used.",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search.",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username.",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups.",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users.",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server.",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations.",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects.",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects.",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values.",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding.",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup.",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals.",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind.",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS.",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties.",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding.",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects.",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of.",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users.",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects.",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups.",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups.",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users.",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL.",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option.",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration.",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration.",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted.",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them.",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration.",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration.",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration.",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration.",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration.",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration.",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration.",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration.",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration.",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration.",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration.",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration.",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration.",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI.",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration.",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration.",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration.",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow.",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard.",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard.",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard.",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing.",
"title": "CORS"
},
"discovery_signed_response_alg": {
"default": "none",
"description": "The Algorithm this provider uses to sign the Discovery and Metadata Document responses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Discovery Response Signing Algorithm",
"type": "string"
},
"discovery_signed_response_key_id": {
"description": "The Key ID this provider uses to sign the Discovery and Metadata Document responses (overrides the 'discovery_signed_response_alg').",
"title": "Discovery Response Signing Key ID",
"type": "string"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients.",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended.",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges.",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients.",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens.",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"deprecated": true,
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens.",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"deprecated": true,
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens.",
"pattern": "^-{5}(BEGIN (RSA )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (RSA )?PRIVATE KEY-{5}\\n?)+$",
"title": "Issuer Private Key",
"type": "string"
},
"jwks": {
"description": "The JWK's which are to be used to sign various objects like ID Tokens.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer JSON Web Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration.",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter.",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"require_pushed_authorization_requests": {
"description": "Requires Pushed Authorization Requests for all clients for this Issuer.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests.",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients.",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for.",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg').",
"title": "Access Token Signing Key ID",
"type": "string"
},
"allow_multiple_auth_methods": {
"description": "Permits this registered client to accept misbehaving clients which use a broad authentication approach. This is not standards complaint, use at your own security risk.",
"title": "Allow Multiple Authentication Methods",
"type": "boolean"
},
"audience": {
"description": "List of authorized audiences.",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client.",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg').",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"client_id": {
"description": "The Client ID.",
"minLength": 1,
"title": "Client ID",
"type": "string"
},
"client_name": {
"description": "The Client Name displayed to End-Users.",
"title": "Client Name",
"type": "string"
},
"client_secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication.",
"title": "Client Secret"
},
"consent_mode": {
"description": "The Consent Mode used for this client.",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints.",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token",
"client_credentials"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg').",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg').",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"jwks": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "JSON Web Keys",
"type": "array"
},
"jwks_uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"format": "uri",
"title": "JSON Web Keys URI",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client.",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client.",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type.",
"title": "Public",
"type": "boolean"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs.",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client.",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"require_pkce": {
"default": false,
"description": "Requires a Proof Key for this client to perform Code Exchange.",
"title": "Require PKCE",
"type": "boolean"
},
"require_pushed_authorization_requests": {
"default": false,
"description": "Requires Pushed Authorization Requests for this client to perform an authorization.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
},
"response_modes": {
"description": "The Response Modes this client is authorized request.",
"items": {
"enum": [
"form_post",
"form_post.jwt",
"query",
"query.jwt",
"fragment",
"fragment.jwt",
"jwt"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request.",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted.",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile",
"authelia.bearer.authz"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"sector_identifier_uri": {
"description": "The Client Sector Identifier URI for Privacy Isolation via Pairwise subject types.",
"format": "uri",
"title": "Sector Identifier URI",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client.",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg').",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"client_id",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types.",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant.",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant.",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant.",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant.",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM).",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows.",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow.",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"code_lifespan": {
"description": "The lifespan of the randomly generated One Time Code after which it's considered invalid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Code Lifespan"
},
"elevation_lifespan": {
"description": "The lifespan of the elevation after initially validating the One-Time Code before it expires.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Lifespan"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes.",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods.",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor.",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"jwt_algorithm": {
"default": "HS256",
"description": "The JSON Web Token Algorithm (JWA) used to sign the Reset Password flow JSON Web Token's.",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_lifespan": {
"description": "The lifespan of the JSON Web Token after it's initially generated after which it's considered invalid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JWT Lifespan"
},
"jwt_secret": {
"description": "The secret key used to sign the Reset Password flow JSON Web Token's.",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK.",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format.",
"pattern": "^-{5}BEGIN (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n?$",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK.",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK.",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled.",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages.",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option.",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log.",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server.",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error.",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely.",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use.",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks.",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier.",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier.",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides.",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications.",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address.",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version.",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS.",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it.",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command.",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP.",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check.",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used.",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties.",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine.",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine.",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length.",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length.",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters.",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters.",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters.",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters.",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed.",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality.",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy.",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy.",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user.",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on.",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside.",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration.",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality.",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration.",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration.",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration.",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration.",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size.",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size.",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints.",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint.",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint.",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use.",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
},
"schemes": {
"default": [
"basic"
],
"description": "The name of the authorization schemes to allow with the header strategies.",
"items": {
"enum": [
"basic",
"bearer"
],
"type": "string"
},
"title": "Authorization Schemes",
"type": "array"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template.",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate.",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS.",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key.",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations.",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration.",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data.",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration.",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration.",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration.",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index.",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host.",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time.",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis.",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password.",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port.",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance.",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode.",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode.",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance.",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port.",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine.",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings.",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings.",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings.",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file.",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use.",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options.",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options.",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options.",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options.",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain.",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted.",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted.",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key.",
"pattern": "^-{5}BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against.",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties.",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys.",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default.",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default.",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default.",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys.",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code.",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys.",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys.",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys.",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys.",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration.",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on.",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server.",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server.",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server.",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials.",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party.",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials.",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 723b02945783b66f455759fc75b9a297dd44c647 | 2024-03-04T09:29:12 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule.",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests.",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section.",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to.",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to.",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to.",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to."
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to.",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match.",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to.",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to.",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to.",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to.",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to.",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule.",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration.",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration.",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour.",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend.",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia.",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database.",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour.",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database.",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use.",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters.",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters.",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters.",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters.",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters.",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length.",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used.",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used.",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length.",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used.",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used.",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used.",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used.",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used.",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used.",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used.",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used.",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used.",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used.",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used.",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used.",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used.",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used.",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search.",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username.",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups.",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users.",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server.",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations.",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects.",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects.",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values.",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding.",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup.",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals.",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind.",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS.",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties.",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding.",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects.",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of.",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users.",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects.",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups.",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups.",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users.",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL.",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option.",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration.",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration.",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted.",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them.",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration.",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration.",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration.",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration.",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration.",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration.",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration.",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration.",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration.",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration.",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration.",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration.",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration.",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI.",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration.",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration.",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration.",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow.",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard.",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard.",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard.",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing.",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients.",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended.",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges.",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients.",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens.",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens.",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens.",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration.",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter.",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests.",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests.",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients.",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for.",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg').",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences.",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client.",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg').",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client.",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users.",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client.",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client.",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints.",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID.",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg').",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg').",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client.",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client.",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type.",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs.",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client.",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request.",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request.",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted.",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication.",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation.",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client.",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg').",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types.",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant.",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant.",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant.",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant.",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM).",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients.",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows.",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow.",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"elevation_expiration": {
"description": "Duration of time the elevation can exist for after the user performs the validation.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Expiration"
},
"expiration": {
"description": "Duration of time the OTP code is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes.",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods.",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor.",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"expiration": {
"description": "Duration of time the JWT is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"jwt_algorithm": {
"default": "HS256",
"description": "The JWT Algorithm (JWA) used to sign the Reset Password flow JWT's.",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_secret": {
"description": "The JWT secret used to sign the Reset Password flow JWT's.",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK.",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format.",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK.",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK.",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled.",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages.",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option.",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log.",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server.",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error.",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely.",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use.",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks.",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier.",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier.",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides.",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications.",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address.",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version.",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS.",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it.",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command.",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP.",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check.",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used.",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties.",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine.",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine.",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length.",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length.",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters.",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters.",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters.",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters.",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed.",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality.",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy.",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy.",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user.",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on.",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside.",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration.",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality.",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration.",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration.",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration.",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration.",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size.",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size.",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints.",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint.",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint.",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use.",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template.",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate.",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS.",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key.",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations.",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration.",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data.",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration.",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration.",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration.",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index.",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host.",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time.",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis.",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password.",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port.",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance.",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode.",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode.",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance.",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port.",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine.",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings.",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings.",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings.",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file.",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use.",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options.",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options.",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options.",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options.",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain.",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted.",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted.",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key.",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against.",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties.",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys.",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default.",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default.",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default.",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys.",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code.",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys.",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys.",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys.",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys.",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration.",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on.",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server.",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server.",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server.",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials.",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party.",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials.",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 8e4e8ce8768fb1cabef13a794454cf4486a65f64 | 2023-09-03T10:20:10 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests. Not relevant to OpenID Connect.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?umask=[0-7]{3,4})?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"description": "Used to redirect users when they visit the portal directly",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"jwt_secret": {
"description": "Used for signing HS256 JWT's for identity verification",
"title": "Secret Key for JWT's",
"type": "string"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"DisableRememberMe": {
"type": "boolean"
},
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the cookies options instead.",
"type": "string"
},
"expiration": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"DisableRememberMe": {
"type": "boolean"
},
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"type": "string"
},
"remember_me": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"schema": {
"default": "public",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead."
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"type": "string"
},
"key": {
"type": "string"
},
"mode": {
"deprecated": true,
"type": "string"
},
"root_certificate": {
"deprecated": true,
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | e618cf341627a89b5fec594090cf765c86aafaad | 2024-03-04T09:28:24 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"credential_management": {
"$ref": "#/$defs/IdentityValidationCredentials",
"description": "Identity validation options for the Credential Management flows",
"title": "Credential Management"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity validation options for the Reset Password flow",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationCredentials": {
"additionalProperties": false,
"description": "IdentityValidationCredentials represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"elevation_expiration": {
"description": "Duration of time the elevation can exist for after the user performs the validation",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Expiration"
},
"expiration": {
"description": "Duration of time the OTP code is considered valid",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"otp_characters": {
"description": "Number of characters in the generated OTP codes",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"skip_2fa": {
"description": "Skips 2FA requirement TODO",
"title": "Skip 2FA",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"expiration": {
"description": "Duration of time the JWT is considered valid",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"jwt_algorithm": {
"default": "HS256",
"description": "The JWT Algorithm (JWA) used to sign the Reset Password flow JWT's'",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_secret": {
"description": "The JWT secret used to sign the Reset Password flow JWT's",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled'",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | d0cf1c1014d45b34476e6c7ab668506377e4c4ad | 2024-04-25T09:36:47 | docs/static/schemas/v4.39/json-schema/exports.identifiers.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"UUID": {
"items": {
"type": "integer"
},
"maxItems": 16,
"minItems": 16,
"type": "array"
},
"UserOpaqueIdentifier": {
"additionalProperties": false,
"properties": {
"ID": {
"type": "integer"
},
"identifier": {
"$ref": "#/$defs/UUID",
"description": "The random UUID for this opaque identifier.",
"title": "Identifier"
},
"sector_id": {
"description": "Sector Identifier this UUID is used with.",
"title": "Sector Identifier",
"type": "string"
},
"service": {
"description": "The service name this UUID is used with.",
"title": "Service",
"type": "string"
},
"username": {
"description": "The username of the user this UUID is for.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"UserOpaqueIdentifiersExport": {
"additionalProperties": false,
"properties": {
"identifiers": {
"description": "The list of opaque identifiers.",
"items": {
"$ref": "#/$defs/UserOpaqueIdentifier"
},
"title": "Identifiers",
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://www.authelia.com/schemas/v4.39/json-schema/exports.identifiers.json",
"$ref": "#/$defs/UserOpaqueIdentifiersExport",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 32424bf8c5f0abc7199689d82794e30d85d3abbd | 2024-03-16T11:50:40 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule.",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests.",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section.",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to.",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to.",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to.",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to."
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to.",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match.",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to.",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to.",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to.",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to.",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to.",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule.",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration.",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration.",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour.",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend.",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia.",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database.",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour.",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database.",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use.",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters.",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters.",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters.",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters.",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters.",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length.",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used.",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used.",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length.",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used.",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used.",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used.",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used.",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used.",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used.",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used.",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used.",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used.",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used.",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used.",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used.",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used.",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used.",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search.",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username.",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups.",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users.",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server.",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations.",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects.",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects.",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values.",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding.",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup.",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals.",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind.",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS.",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties.",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding.",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects.",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of.",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users.",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects.",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups.",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups.",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users.",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL.",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option.",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration.",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration.",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted.",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them.",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration.",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration.",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration.",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration.",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration.",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration.",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration.",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration.",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration.",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration.",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration.",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration.",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration.",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI.",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration.",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration.",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration.",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow.",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard.",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard.",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard.",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing.",
"title": "CORS"
},
"discovery_signed_response_alg": {
"default": "none",
"description": "The Algorithm this provider uses to sign the Discovery and Metadata Document responses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Discovery Response Signing Algorithm",
"type": "string"
},
"discovery_signed_response_key_id": {
"description": "The Key ID this provider uses to sign the Discovery and Metadata Document responses (overrides the 'discovery_signed_response_alg').",
"title": "Discovery Response Signing Key ID",
"type": "string"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients.",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended.",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges.",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients.",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens.",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"deprecated": true,
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens.",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"deprecated": true,
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens.",
"pattern": "^-{5}(BEGIN (RSA )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (RSA )?PRIVATE KEY-{5}\\n?)+$",
"title": "Issuer Private Key",
"type": "string"
},
"jwks": {
"description": "The JWK's which are to be used to sign various objects like ID Tokens.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer JSON Web Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration.",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter.",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"require_pushed_authorization_requests": {
"description": "Requires Pushed Authorization Requests for all clients for this Issuer.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests.",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients.",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for.",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg').",
"title": "Access Token Signing Key ID",
"type": "string"
},
"allow_multiple_auth_methods": {
"description": "Permits this registered client to accept misbehaving clients which use a broad authentication approach. This is not standards complaint, use at your own security risk.",
"title": "Allow Multiple Authentication Methods",
"type": "boolean"
},
"audience": {
"description": "List of authorized audiences.",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client.",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg').",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"client_id": {
"description": "The Client ID.",
"minLength": 1,
"title": "Client ID",
"type": "string"
},
"client_name": {
"description": "The Client Name displayed to End-Users.",
"title": "Client Name",
"type": "string"
},
"client_secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication.",
"title": "Client Secret"
},
"consent_mode": {
"description": "The Consent Mode used for this client.",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints.",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token",
"client_credentials"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg').",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg').",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"jwks": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "JSON Web Keys",
"type": "array"
},
"jwks_uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"format": "uri",
"title": "JSON Web Keys URI",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client.",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client.",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type.",
"title": "Public",
"type": "boolean"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs.",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client.",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"require_pkce": {
"default": false,
"description": "Requires a Proof Key for this client to perform Code Exchange.",
"title": "Require PKCE",
"type": "boolean"
},
"require_pushed_authorization_requests": {
"default": false,
"description": "Requires Pushed Authorization Requests for this client to perform an authorization.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
},
"response_modes": {
"description": "The Response Modes this client is authorized request.",
"items": {
"enum": [
"form_post",
"form_post.jwt",
"query",
"query.jwt",
"fragment",
"fragment.jwt",
"jwt"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request.",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted.",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile",
"authelia.bearer.authz"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"sector_identifier_uri": {
"description": "The Client Sector Identifier URI for Privacy Isolation via Pairwise subject types.",
"format": "uri",
"title": "Sector Identifier URI",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client.",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg').",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"client_id",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types.",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant.",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant.",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant.",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant.",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM).",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows.",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow.",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"code_lifespan": {
"description": "The lifespan of the randomly generated One Time Code after which it's considered invalid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Code Lifespan"
},
"elevation_lifespan": {
"description": "The lifespan of the elevation after initially validating the One-Time Code before it expires.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Lifespan"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes.",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods.",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor.",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"jwt_algorithm": {
"default": "HS256",
"description": "The JSON Web Token Algorithm (JWA) used to sign the Reset Password flow JSON Web Token's.",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_lifespan": {
"description": "The lifespan of the JSON Web Token after it's initially generated after which it's considered invalid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JWT Lifespan"
},
"jwt_secret": {
"description": "The secret key used to sign the Reset Password flow JSON Web Token's.",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK.",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format.",
"pattern": "^-{5}BEGIN (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n?$",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK.",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK.",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled.",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages.",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option.",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log.",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server.",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error.",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely.",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use.",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks.",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier.",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier.",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides.",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications.",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address.",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version.",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS.",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it.",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command.",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP.",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check.",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used.",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties.",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine.",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine.",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length.",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length.",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters.",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters.",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters.",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters.",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed.",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality.",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy.",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy.",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user.",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on.",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside.",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration.",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality.",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration.",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration.",
"title": "Headers"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration.",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration.",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size.",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size.",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints.",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint.",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint.",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use.",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
},
"schemes": {
"default": [
"basic"
],
"description": "The name of the authorization schemes to allow with the header strategies.",
"items": {
"enum": [
"basic",
"bearer"
],
"type": "string"
},
"title": "Authorization Schemes",
"type": "array"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template.",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate.",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS.",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key.",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations.",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration.",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data.",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration.",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration.",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration.",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index.",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host.",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time.",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis.",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password.",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port.",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance.",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode.",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode.",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance.",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port.",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine.",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings.",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings.",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings.",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file.",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"schema": {
"default": "public",
"description": "The default schema name to use.",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options.",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options.",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options.",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options.",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain.",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted.",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted.",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key.",
"pattern": "^-{5}BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against.",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties.",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys.",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default.",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default.",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default.",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys.",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code.",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys.",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys.",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys.",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys.",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration.",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on.",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server.",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server.",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server.",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials.",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party.",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials.",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 723b02945783b66f455759fc75b9a297dd44c647 | 2024-03-04T09:29:12 | docs/static/schemas/v4.38/json-schema/exports.identifiers.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"UUID": {
"items": {
"type": "integer"
},
"maxItems": 16,
"minItems": 16,
"type": "array"
},
"UserOpaqueIdentifier": {
"additionalProperties": false,
"properties": {
"ID": {
"type": "integer"
},
"identifier": {
"$ref": "#/$defs/UUID",
"description": "The random UUID for this opaque identifier.",
"title": "Identifier"
},
"sector_id": {
"description": "Sector Identifier this UUID is used with.",
"title": "Sector Identifier",
"type": "string"
},
"service": {
"description": "The service name this UUID is used with.",
"title": "Service",
"type": "string"
},
"username": {
"description": "The username of the user this UUID is for.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"UserOpaqueIdentifiersExport": {
"additionalProperties": false,
"properties": {
"identifiers": {
"description": "The list of opaque identifiers.",
"items": {
"$ref": "#/$defs/UserOpaqueIdentifier"
},
"title": "Identifiers",
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/exports.identifiers.json",
"$ref": "#/$defs/UserOpaqueIdentifiersExport",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | acff603092951972fdd13691574c0110a34cb64d | 2024-03-06T19:24:03 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule.",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests.",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section.",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to.",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to.",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to.",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to."
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to.",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match.",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to.",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to.",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to.",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to.",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to.",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule.",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group|oauth2:client:):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group|oauth2:client:):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group|oauth2:client:):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration.",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration.",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour.",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend.",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia.",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database.",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour.",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database.",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use.",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters.",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters.",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters.",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters.",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters.",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length.",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used.",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used.",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length.",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used.",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used.",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used.",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used.",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used.",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used.",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used.",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used.",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used.",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used.",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used.",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used.",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used.",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used.",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search.",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username.",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups.",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users.",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server.",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations.",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects.",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects.",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values.",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding.",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup.",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals.",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind.",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS.",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties.",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding.",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects.",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of.",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users.",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects.",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups.",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups.",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users.",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL.",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option.",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration.",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration.",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted.",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them.",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration.",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration.",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration.",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration.",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration.",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration.",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration.",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration.",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration.",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration.",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration.",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration.",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration.",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI.",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration.",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration.",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration.",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow.",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard.",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard.",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard.",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing.",
"title": "CORS"
},
"discovery_signed_response_alg": {
"default": "none",
"description": "The Algorithm this provider uses to sign the Discovery and Metadata Document responses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Discovery Response Signing Algorithm",
"type": "string"
},
"discovery_signed_response_key_id": {
"description": "The Key ID this provider uses to sign the Discovery and Metadata Document responses (overrides the 'discovery_signed_response_alg').",
"title": "Discovery Response Signing Key ID",
"type": "string"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients.",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended.",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges.",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients.",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens.",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"deprecated": true,
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens.",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"deprecated": true,
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens.",
"title": "Issuer Private Key",
"type": "string"
},
"jwks": {
"description": "The JWK's which are to be used to sign various objects like ID Tokens.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer JSON Web Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration.",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter.",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests.",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests.",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients.",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for.",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg').",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences.",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client.",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg').",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"client_id": {
"description": "The Client ID.",
"minLength": 1,
"title": "Client ID",
"type": "string"
},
"client_name": {
"description": "The Client Name displayed to End-Users.",
"title": "Client Name",
"type": "string"
},
"client_secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication.",
"title": "Client Secret"
},
"consent_mode": {
"description": "The Consent Mode used for this client.",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints.",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg').",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg').",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"jwks": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "JSON Web Keys",
"type": "array"
},
"jwks_uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"format": "uri",
"title": "JSON Web Keys URI",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client.",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client.",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type.",
"title": "Public",
"type": "boolean"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs.",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client.",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"require_pkce": {
"default": false,
"description": "Requires a Proof Key for this client to perform Code Exchange.",
"title": "Require PKCE",
"type": "boolean"
},
"require_pushed_authorization_requests": {
"default": false,
"description": "Requires Pushed Authorization Requests for this client to perform an authorization.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
},
"response_modes": {
"description": "The Response Modes this client is authorized request.",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request.",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted.",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"sector_identifier_uri": {
"description": "The Client Sector Identifier URI for Privacy Isolation via Pairwise subject types.",
"format": "uri",
"title": "Sector Identifier URI",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client.",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg').",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"client_id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types.",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant.",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant.",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant.",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant.",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM).",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients.",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows.",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow.",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"elevation_expiration": {
"description": "Duration of time the elevation can exist for after the user performs the validation.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Expiration"
},
"expiration": {
"description": "Duration of time the OTP code is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes.",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods.",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor.",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"expiration": {
"description": "Duration of time the JWT is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"jwt_algorithm": {
"default": "HS256",
"description": "The JWT Algorithm (JWA) used to sign the Reset Password flow JWT's.",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_secret": {
"description": "The JWT secret used to sign the Reset Password flow JWT's.",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK.",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format.",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK.",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK.",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled.",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages.",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option.",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log.",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server.",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error.",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely.",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use.",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks.",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier.",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier.",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides.",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications.",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address.",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version.",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS.",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it.",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command.",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP.",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check.",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used.",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties.",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine.",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine.",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length.",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length.",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters.",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters.",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters.",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters.",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed.",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality.",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy.",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy.",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user.",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on.",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside.",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration.",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality.",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration.",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration.",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration.",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration.",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size.",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size.",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints.",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint.",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint.",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use.",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
},
"schemes": {
"default": [
"basic"
],
"description": "The name of the authorization schemes to allow with the header strategies.",
"items": {
"enum": [
"basic",
"bearer"
],
"type": "string"
},
"title": "Authorization Schemes",
"type": "array"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template.",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate.",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS.",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key.",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations.",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration.",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data.",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration.",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration.",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration.",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index.",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host.",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time.",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis.",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password.",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port.",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance.",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode.",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode.",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance.",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port.",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine.",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings.",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings.",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings.",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file.",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use.",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options.",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options.",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options.",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options.",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain.",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted.",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted.",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key.",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against.",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties.",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys.",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default.",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default.",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default.",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys.",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code.",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys.",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys.",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys.",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys.",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration.",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on.",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server.",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server.",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server.",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials.",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party.",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials.",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 28389020fff56c40133763b9f2048e9d210888a4 | 2023-10-07T22:54:37 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?umask=[0-7]{3,4})?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"jwt_secret": {
"description": "Used for signing HS256 JWT's for identity verification",
"title": "Secret Key for JWT's",
"type": "string"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled'",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | fb50f1a70c66d96391a3e9cae5721c9c78c75d8d | 2024-03-05T09:11:16 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule.",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests.",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section.",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to.",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to.",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to.",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to."
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to.",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match.",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to.",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to.",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to.",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to.",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to.",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule.",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group|oauth2:client:):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group|oauth2:client:):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group|oauth2:client:):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration.",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration.",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour.",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend.",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia.",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database.",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour.",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database.",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use.",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters.",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters.",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters.",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters.",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters.",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length.",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used.",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used.",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length.",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used.",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used.",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used.",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used.",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used.",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used.",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used.",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used.",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used.",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used.",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used.",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used.",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used.",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used.",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search.",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username.",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups.",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users.",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server.",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations.",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects.",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects.",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values.",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding.",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup.",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals.",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind.",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS.",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties.",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding.",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects.",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of.",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users.",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects.",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups.",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups.",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users.",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL.",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option.",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration.",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration.",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted.",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them.",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration.",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration.",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration.",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration.",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration.",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration.",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration.",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration.",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration.",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration.",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration.",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration.",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration.",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI.",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration.",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration.",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration.",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow.",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard.",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard.",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard.",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing.",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients.",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended.",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges.",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients.",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens.",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"deprecated": true,
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens.",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"deprecated": true,
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens.",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration.",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter.",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests.",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests.",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients.",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for.",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg').",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences.",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client.",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg').",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client.",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users.",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client.",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client.",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints.",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID.",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg').",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg').",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client.",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client.",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type.",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs.",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client.",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request.",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request.",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted.",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication.",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation.",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client.",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg').",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types.",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant.",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant.",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant.",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant.",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM).",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients.",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows.",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow.",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"elevation_expiration": {
"description": "Duration of time the elevation can exist for after the user performs the validation.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Expiration"
},
"expiration": {
"description": "Duration of time the OTP code is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes.",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods.",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor.",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"expiration": {
"description": "Duration of time the JWT is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"jwt_algorithm": {
"default": "HS256",
"description": "The JWT Algorithm (JWA) used to sign the Reset Password flow JWT's.",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_secret": {
"description": "The JWT secret used to sign the Reset Password flow JWT's.",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK.",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format.",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK.",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK.",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled.",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages.",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option.",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log.",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server.",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error.",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely.",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use.",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks.",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier.",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier.",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides.",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications.",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address.",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version.",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS.",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it.",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command.",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP.",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check.",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used.",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties.",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine.",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine.",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length.",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length.",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters.",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters.",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters.",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters.",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed.",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality.",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy.",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy.",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user.",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on.",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside.",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration.",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality.",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration.",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration.",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration.",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration.",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size.",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size.",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints.",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint.",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint.",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use.",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
},
"schemes": {
"default": [
"basic"
],
"description": "The name of the authorization schemes to allow with the header strategies.",
"items": {
"enum": [
"basic",
"bearer"
],
"type": "string"
},
"title": "Authorization Schemes",
"type": "array"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template.",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate.",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS.",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key.",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations.",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration.",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data.",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration.",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration.",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration.",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index.",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host.",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time.",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis.",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password.",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port.",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance.",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode.",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode.",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance.",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port.",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine.",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings.",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings.",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings.",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file.",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use.",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options.",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options.",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options.",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options.",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain.",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted.",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted.",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key.",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against.",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties.",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys.",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default.",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default.",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default.",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys.",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code.",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys.",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys.",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys.",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys.",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration.",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on.",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server.",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server.",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server.",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials.",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party.",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials.",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | e0f803cea09a1fa61b91cc1a51a663bbe6d1f5bb | 2024-03-10T22:22:24 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule.",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests.",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section.",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to.",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to.",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to.",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to."
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to.",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match.",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to.",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to.",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to.",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to.",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to.",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule.",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration.",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration.",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour.",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend.",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia.",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database.",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour.",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database.",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use.",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters.",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters.",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters.",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters.",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters.",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length.",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used.",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used.",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length.",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used.",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used.",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used.",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used.",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used.",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used.",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used.",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used.",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used.",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used.",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used.",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used.",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used.",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used.",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search.",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username.",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups.",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users.",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server.",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations.",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects.",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects.",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values.",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding.",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup.",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals.",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind.",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS.",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties.",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding.",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects.",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of.",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users.",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects.",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups.",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups.",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users.",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL.",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option.",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration.",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration.",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted.",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them.",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration.",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration.",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration.",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration.",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration.",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration.",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration.",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration.",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration.",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration.",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration.",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration.",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration.",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI.",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration.",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration.",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration.",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow.",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard.",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard.",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard.",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing.",
"title": "CORS"
},
"discovery_signed_response_alg": {
"default": "none",
"description": "The Algorithm this provider uses to sign the Discovery and Metadata Document responses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Discovery Response Signing Algorithm",
"type": "string"
},
"discovery_signed_response_key_id": {
"description": "The Key ID this provider uses to sign the Discovery and Metadata Document responses (overrides the 'discovery_signed_response_alg').",
"title": "Discovery Response Signing Key ID",
"type": "string"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients.",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended.",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges.",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients.",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens.",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"deprecated": true,
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens.",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"deprecated": true,
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens.",
"pattern": "^-{5}(BEGIN (RSA )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (RSA )?PRIVATE KEY-{5}\\n?)+$",
"title": "Issuer Private Key",
"type": "string"
},
"jwks": {
"description": "The JWK's which are to be used to sign various objects like ID Tokens.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer JSON Web Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration.",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter.",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests.",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests.",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients.",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for.",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg').",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences.",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client.",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg').",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"client_id": {
"description": "The Client ID.",
"minLength": 1,
"title": "Client ID",
"type": "string"
},
"client_name": {
"description": "The Client Name displayed to End-Users.",
"title": "Client Name",
"type": "string"
},
"client_secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication.",
"title": "Client Secret"
},
"consent_mode": {
"description": "The Consent Mode used for this client.",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints.",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token",
"client_credentials"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg').",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg').",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"jwks": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "JSON Web Keys",
"type": "array"
},
"jwks_uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"format": "uri",
"title": "JSON Web Keys URI",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client.",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client.",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type.",
"title": "Public",
"type": "boolean"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs.",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client.",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"require_pkce": {
"default": false,
"description": "Requires a Proof Key for this client to perform Code Exchange.",
"title": "Require PKCE",
"type": "boolean"
},
"require_pushed_authorization_requests": {
"default": false,
"description": "Requires Pushed Authorization Requests for this client to perform an authorization.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
},
"response_modes": {
"description": "The Response Modes this client is authorized request.",
"items": {
"enum": [
"form_post",
"form_post.jwt",
"query",
"query.jwt",
"fragment",
"fragment.jwt",
"jwt"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request.",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted.",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile",
"authelia.bearer.authz"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"sector_identifier_uri": {
"description": "The Client Sector Identifier URI for Privacy Isolation via Pairwise subject types.",
"format": "uri",
"title": "Sector Identifier URI",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client.",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg').",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"client_id",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types.",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant.",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant.",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant.",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant.",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM).",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients.",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows.",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow.",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"elevation_expiration": {
"description": "Duration of time the elevation can exist for after the user performs the validation.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Expiration"
},
"expiration": {
"description": "Duration of time the OTP code is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes.",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods.",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor.",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"expiration": {
"description": "Duration of time the JWT is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"jwt_algorithm": {
"default": "HS256",
"description": "The JWT Algorithm (JWA) used to sign the Reset Password flow JWT's.",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_secret": {
"description": "The JWT secret used to sign the Reset Password flow JWT's.",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK.",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format.",
"pattern": "^-{5}BEGIN (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n?$",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK.",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK.",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled.",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages.",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option.",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log.",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server.",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error.",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely.",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use.",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks.",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier.",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier.",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides.",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications.",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address.",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version.",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS.",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it.",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command.",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP.",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check.",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used.",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties.",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine.",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine.",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length.",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length.",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters.",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters.",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters.",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters.",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed.",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality.",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy.",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy.",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user.",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on.",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside.",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration.",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality.",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration.",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration.",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration.",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration.",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size.",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size.",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints.",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint.",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint.",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use.",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
},
"schemes": {
"default": [
"basic"
],
"description": "The name of the authorization schemes to allow with the header strategies.",
"items": {
"enum": [
"basic",
"bearer"
],
"type": "string"
},
"title": "Authorization Schemes",
"type": "array"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template.",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate.",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS.",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key.",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations.",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration.",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data.",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration.",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration.",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration.",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index.",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host.",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time.",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis.",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password.",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port.",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance.",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode.",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode.",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance.",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port.",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine.",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings.",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings.",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings.",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file.",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use.",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options.",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options.",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options.",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options.",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain.",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted.",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted.",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key.",
"pattern": "^-{5}BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against.",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties.",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys.",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default.",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default.",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default.",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys.",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code.",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys.",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys.",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys.",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys.",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration.",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on.",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server.",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server.",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server.",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials.",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party.",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials.",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 40026701fdf604b874334166b9984f6ac003f0fa | 2023-09-03T06:01:46 | docs/static/schemas/latest/json-schema/user-database.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"FileUserDatabase": {
"additionalProperties": false,
"description": "FileUserDatabase is a user details database that is concurrency safe database and can be reloaded.",
"properties": {
"users": {
"description": "The dictionary of users",
"patternProperties": {
".*": {
"$ref": "#/$defs/FileUserDatabaseUserDetails"
}
},
"title": "Users",
"type": "object"
}
},
"required": [
"users"
],
"type": "object"
},
"FileUserDatabaseUserDetails": {
"additionalProperties": false,
"description": "FileUserDatabaseUserDetails is the model of user details in the file database.",
"properties": {
"disabled": {
"default": false,
"description": "The disabled status for the user",
"title": "Disabled",
"type": "boolean"
},
"displayname": {
"description": "The display name for the user",
"title": "Display Name",
"type": "string"
},
"email": {
"description": "The email for the user",
"title": "Email",
"type": "string"
},
"groups": {
"description": "The groups list for the user",
"items": {
"type": "string"
},
"title": "Groups",
"type": "array"
},
"password": {
"$ref": "#/$defs/PasswordDigest",
"description": "The hashed password for the user",
"title": "Password"
}
},
"required": [
"password",
"displayname"
],
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/user-database.json",
"$ref": "#/$defs/FileUserDatabase",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 5d3e7a0183c9842c2cc4e6b12fe8300297110a71 | 2024-03-04T09:29:12 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"elevation_expiration": {
"description": "Duration of time the elevation can exist for after the user performs the validation",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Expiration"
},
"expiration": {
"description": "Duration of time the OTP code is considered valid",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"expiration": {
"description": "Duration of time the JWT is considered valid",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"jwt_algorithm": {
"default": "HS256",
"description": "The JWT Algorithm (JWA) used to sign the Reset Password flow JWT's'",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_secret": {
"description": "The JWT secret used to sign the Reset Password flow JWT's",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled'",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 40026701fdf604b874334166b9984f6ac003f0fa | 2023-09-03T06:01:46 | docs/static/schemas/latest/json-schema/exports.identifiers.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"UUID": {
"items": {
"type": "integer"
},
"maxItems": 16,
"minItems": 16,
"type": "array"
},
"UserOpaqueIdentifier": {
"additionalProperties": false,
"properties": {
"ID": {
"type": "integer"
},
"identifier": {
"$ref": "#/$defs/UUID",
"description": "The random UUID for this opaque identifier",
"title": "Identifier"
},
"sector_id": {
"description": "Sector Identifier this UUID is used with",
"title": "Sector Identifier",
"type": "string"
},
"service": {
"description": "The service name this UUID is used with",
"title": "Service",
"type": "string"
},
"username": {
"description": "The username of the user this UUID is for",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"UserOpaqueIdentifiersExport": {
"additionalProperties": false,
"properties": {
"identifiers": {
"description": "The list of opaque identifiers",
"items": {
"$ref": "#/$defs/UserOpaqueIdentifier"
},
"title": "Identifiers",
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/exports.identifiers.json",
"$ref": "#/$defs/UserOpaqueIdentifiersExport",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | c49b973120c7fd755923a2b88afd794c7d320d6e | 2023-11-22T21:20:36 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?umask=[0-7]{3,4})?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"jwt_secret": {
"description": "Used for signing HS256 JWT's for identity verification",
"title": "Secret Key for JWT's",
"type": "string"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled'",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 465d30f415a92e3708914ca14e24e6021935f633 | 2023-10-02T02:50:36 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests. Not relevant to OpenID Connect.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?umask=[0-7]{3,4})?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Used to redirect users when they visit the portal directly, this option has been deprecated in favor of the session multi-cookie domain configuration",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"jwt_secret": {
"description": "Used for signing HS256 JWT's for identity verification",
"title": "Secret Key for JWT's",
"type": "string"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "The domain for the cookie, this option has been deprecated in favor of the session multi-cookie domain configuration",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this cookie domain",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"schema": {
"default": "public",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead."
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"type": "string"
},
"key": {
"type": "string"
},
"mode": {
"deprecated": true,
"type": "string"
},
"root_certificate": {
"deprecated": true,
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 2b9281564070eac6aeafa35024f31e902c214c44 | 2024-03-11T14:35:49 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule.",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests.",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section.",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to.",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to.",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to.",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to."
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to.",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match.",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to.",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to.",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to.",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to.",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to.",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule.",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration.",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration.",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour.",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend.",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia.",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database.",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour.",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database.",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use.",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters.",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters.",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters.",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters.",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters.",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length.",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used.",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used.",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length.",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used.",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used.",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used.",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used.",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used.",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used.",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used.",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used.",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used.",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used.",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used.",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used.",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used.",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used.",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search.",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username.",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups.",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users.",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server.",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations.",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects.",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects.",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values.",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding.",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup.",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals.",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind.",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS.",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties.",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding.",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects.",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of.",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users.",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects.",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups.",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups.",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users.",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL.",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option.",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration.",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration.",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted.",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them.",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration.",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration.",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration.",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration.",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration.",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration.",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration.",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration.",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration.",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration.",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration.",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration.",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration.",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI.",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration.",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration.",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration.",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow.",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard.",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard.",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard.",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing.",
"title": "CORS"
},
"discovery_signed_response_alg": {
"default": "none",
"description": "The Algorithm this provider uses to sign the Discovery and Metadata Document responses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Discovery Response Signing Algorithm",
"type": "string"
},
"discovery_signed_response_key_id": {
"description": "The Key ID this provider uses to sign the Discovery and Metadata Document responses (overrides the 'discovery_signed_response_alg').",
"title": "Discovery Response Signing Key ID",
"type": "string"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients.",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended.",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges.",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients.",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens.",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"deprecated": true,
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens.",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"deprecated": true,
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens.",
"pattern": "^-{5}(BEGIN (RSA )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (RSA )?PRIVATE KEY-{5}\\n?)+$",
"title": "Issuer Private Key",
"type": "string"
},
"jwks": {
"description": "The JWK's which are to be used to sign various objects like ID Tokens.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer JSON Web Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration.",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter.",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"require_pushed_authorization_requests": {
"description": "Requires Pushed Authorization Requests for all clients for this Issuer.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests.",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients.",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for.",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg').",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences.",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client.",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg').",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"client_id": {
"description": "The Client ID.",
"minLength": 1,
"title": "Client ID",
"type": "string"
},
"client_name": {
"description": "The Client Name displayed to End-Users.",
"title": "Client Name",
"type": "string"
},
"client_secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication.",
"title": "Client Secret"
},
"consent_mode": {
"description": "The Consent Mode used for this client.",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints.",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token",
"client_credentials"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg').",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg').",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"jwks": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "JSON Web Keys",
"type": "array"
},
"jwks_uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"format": "uri",
"title": "JSON Web Keys URI",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client.",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client.",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type.",
"title": "Public",
"type": "boolean"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs.",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client.",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"require_pkce": {
"default": false,
"description": "Requires a Proof Key for this client to perform Code Exchange.",
"title": "Require PKCE",
"type": "boolean"
},
"require_pushed_authorization_requests": {
"default": false,
"description": "Requires Pushed Authorization Requests for this client to perform an authorization.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
},
"response_modes": {
"description": "The Response Modes this client is authorized request.",
"items": {
"enum": [
"form_post",
"form_post.jwt",
"query",
"query.jwt",
"fragment",
"fragment.jwt",
"jwt"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request.",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted.",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile",
"authelia.bearer.authz"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"sector_identifier_uri": {
"description": "The Client Sector Identifier URI for Privacy Isolation via Pairwise subject types.",
"format": "uri",
"title": "Sector Identifier URI",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client.",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg').",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"client_id",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types.",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant.",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant.",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant.",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant.",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM).",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows.",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow.",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"elevation_expiration": {
"description": "Duration of time the elevation can exist for after the user performs the validation.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Expiration"
},
"expiration": {
"description": "Duration of time the OTP code is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes.",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods.",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor.",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"expiration": {
"description": "Duration of time the JWT is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"jwt_algorithm": {
"default": "HS256",
"description": "The JWT Algorithm (JWA) used to sign the Reset Password flow JWT's.",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_secret": {
"description": "The JWT secret used to sign the Reset Password flow JWT's.",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK.",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format.",
"pattern": "^-{5}BEGIN (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n?$",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK.",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK.",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled.",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages.",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option.",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log.",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server.",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error.",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely.",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use.",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks.",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier.",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier.",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides.",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications.",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address.",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version.",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS.",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it.",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command.",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP.",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check.",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used.",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties.",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine.",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine.",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length.",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length.",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters.",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters.",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters.",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters.",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed.",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality.",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy.",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy.",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user.",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on.",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside.",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration.",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality.",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration.",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration.",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration.",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration.",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size.",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size.",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints.",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint.",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint.",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use.",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
},
"schemes": {
"default": [
"basic"
],
"description": "The name of the authorization schemes to allow with the header strategies.",
"items": {
"enum": [
"basic",
"bearer"
],
"type": "string"
},
"title": "Authorization Schemes",
"type": "array"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template.",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate.",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS.",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key.",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations.",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration.",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data.",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration.",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration.",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration.",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index.",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host.",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time.",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis.",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password.",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port.",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance.",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode.",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode.",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance.",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port.",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine.",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings.",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings.",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings.",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file.",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use.",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options.",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options.",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options.",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options.",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain.",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted.",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted.",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key.",
"pattern": "^-{5}BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against.",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties.",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys.",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default.",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default.",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default.",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys.",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code.",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys.",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys.",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys.",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys.",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration.",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on.",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server.",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server.",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server.",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials.",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party.",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials.",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 13837b7b84e561981b081f7f67f3775893377d5b | 2024-03-04T09:29:11 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"credential_management": {
"$ref": "#/$defs/IdentityValidationCredentials",
"description": "Identity validation options for the Credential Management flows",
"title": "Credential Management"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity validation options for the Reset Password flow",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationCredentials": {
"additionalProperties": false,
"description": "IdentityValidationCredentials represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"elevation_expiration": {
"description": "Duration of time the elevation can exist for after the user performs the validation",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Expiration"
},
"expiration": {
"description": "Duration of time the OTP code is considered valid",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"otp_characters": {
"description": "Number of characters in the generated OTP codes",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"skip_2fa": {
"description": "Skips 2FA requirement TODO",
"title": "Skip 2FA",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"expiration": {
"description": "Duration of time the JWT is considered valid",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"jwt_algorithm": {
"default": "HS256",
"description": "The JWT Algorithm (JWA) used to sign the Reset Password flow JWT's'",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_secret": {
"description": "The JWT secret used to sign the Reset Password flow JWT's",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled'",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | caf9c61342fdd8c3b2943375e516aa3ab62194a1 | 2024-03-14T10:20:32 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule.",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests.",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section.",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to.",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to.",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to.",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to."
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to.",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match.",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to.",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to.",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to.",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to.",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to.",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule.",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration.",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration.",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour.",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend.",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia.",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database.",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour.",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database.",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use.",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters.",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters.",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters.",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters.",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters.",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length.",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used.",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used.",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length.",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used.",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used.",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used.",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used.",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used.",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used.",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used.",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used.",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used.",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used.",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used.",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used.",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used.",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used.",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search.",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username.",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups.",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users.",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server.",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations.",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects.",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects.",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values.",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding.",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup.",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals.",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind.",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS.",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties.",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding.",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects.",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of.",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users.",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects.",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups.",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups.",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users.",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL.",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option.",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration.",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration.",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted.",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them.",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration.",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration.",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration.",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration.",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration.",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration.",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration.",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration.",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration.",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration.",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration.",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration.",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration.",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI.",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration.",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration.",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration.",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow.",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard.",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard.",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard.",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing.",
"title": "CORS"
},
"discovery_signed_response_alg": {
"default": "none",
"description": "The Algorithm this provider uses to sign the Discovery and Metadata Document responses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Discovery Response Signing Algorithm",
"type": "string"
},
"discovery_signed_response_key_id": {
"description": "The Key ID this provider uses to sign the Discovery and Metadata Document responses (overrides the 'discovery_signed_response_alg').",
"title": "Discovery Response Signing Key ID",
"type": "string"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients.",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended.",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges.",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients.",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens.",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"deprecated": true,
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens.",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"deprecated": true,
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens.",
"pattern": "^-{5}(BEGIN (RSA )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (RSA )?PRIVATE KEY-{5}\\n?)+$",
"title": "Issuer Private Key",
"type": "string"
},
"jwks": {
"description": "The JWK's which are to be used to sign various objects like ID Tokens.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer JSON Web Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration.",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter.",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"require_pushed_authorization_requests": {
"description": "Requires Pushed Authorization Requests for all clients for this Issuer.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests.",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients.",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for.",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg').",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences.",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client.",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg').",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"client_id": {
"description": "The Client ID.",
"minLength": 1,
"title": "Client ID",
"type": "string"
},
"client_name": {
"description": "The Client Name displayed to End-Users.",
"title": "Client Name",
"type": "string"
},
"client_secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication.",
"title": "Client Secret"
},
"consent_mode": {
"description": "The Consent Mode used for this client.",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints.",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token",
"client_credentials"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg').",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg').",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"jwks": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "JSON Web Keys",
"type": "array"
},
"jwks_uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"format": "uri",
"title": "JSON Web Keys URI",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client.",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client.",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type.",
"title": "Public",
"type": "boolean"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs.",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client.",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"require_pkce": {
"default": false,
"description": "Requires a Proof Key for this client to perform Code Exchange.",
"title": "Require PKCE",
"type": "boolean"
},
"require_pushed_authorization_requests": {
"default": false,
"description": "Requires Pushed Authorization Requests for this client to perform an authorization.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
},
"response_modes": {
"description": "The Response Modes this client is authorized request.",
"items": {
"enum": [
"form_post",
"form_post.jwt",
"query",
"query.jwt",
"fragment",
"fragment.jwt",
"jwt"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request.",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted.",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile",
"authelia.bearer.authz"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"sector_identifier_uri": {
"description": "The Client Sector Identifier URI for Privacy Isolation via Pairwise subject types.",
"format": "uri",
"title": "Sector Identifier URI",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client.",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg').",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"client_id",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types.",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant.",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant.",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant.",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant.",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM).",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows.",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow.",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"code_lifespan": {
"description": "The lifespan of the randomly generated One Time Code after which it's considered invalid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Code Lifespan"
},
"elevation_lifespan": {
"description": "The lifespan of the elevation after initially validating the One-Time Code before it expires.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Lifespan"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes.",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods.",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor.",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"jwt_algorithm": {
"default": "HS256",
"description": "The JSON Web Token Algorithm (JWA) used to sign the Reset Password flow JSON Web Token's.",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_lifespan": {
"description": "The lifespan of the JSON Web Token after it's initially generated after which it's considered invalid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JWT Lifespan"
},
"jwt_secret": {
"description": "The secret key used to sign the Reset Password flow JSON Web Token's.",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK.",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format.",
"pattern": "^-{5}BEGIN (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n?$",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK.",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK.",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled.",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages.",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option.",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log.",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server.",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error.",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely.",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use.",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks.",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier.",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier.",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides.",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications.",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address.",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version.",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS.",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it.",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command.",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP.",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check.",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used.",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties.",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine.",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine.",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length.",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length.",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters.",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters.",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters.",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters.",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed.",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality.",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy.",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy.",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user.",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on.",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside.",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration.",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality.",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration.",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration.",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration.",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration.",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size.",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size.",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints.",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint.",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint.",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use.",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
},
"schemes": {
"default": [
"basic"
],
"description": "The name of the authorization schemes to allow with the header strategies.",
"items": {
"enum": [
"basic",
"bearer"
],
"type": "string"
},
"title": "Authorization Schemes",
"type": "array"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template.",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate.",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS.",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key.",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations.",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration.",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data.",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration.",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration.",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration.",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index.",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host.",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time.",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis.",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password.",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port.",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance.",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode.",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode.",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance.",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port.",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine.",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings.",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings.",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings.",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file.",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use.",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options.",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options.",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options.",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options.",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain.",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted.",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted.",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key.",
"pattern": "^-{5}BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against.",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties.",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys.",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default.",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default.",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default.",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys.",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code.",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys.",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys.",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys.",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys.",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration.",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on.",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server.",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server.",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server.",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials.",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party.",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials.",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | c9507368abd3374364cca8e1e7b1cbe8494a7130 | 2023-09-17T02:24:24 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests. Not relevant to OpenID Connect.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?umask=[0-7]{3,4})?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"description": "Used to redirect users when they visit the portal directly",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"jwt_secret": {
"description": "Used for signing HS256 JWT's for identity verification",
"title": "Secret Key for JWT's",
"type": "string"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"DisableRememberMe": {
"type": "boolean"
},
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the cookies options instead.",
"type": "string"
},
"expiration": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"DisableRememberMe": {
"type": "boolean"
},
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"type": "string"
},
"remember_me": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"schema": {
"default": "public",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead."
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"type": "string"
},
"key": {
"type": "string"
},
"mode": {
"deprecated": true,
"type": "string"
},
"root_certificate": {
"deprecated": true,
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 723b02945783b66f455759fc75b9a297dd44c647 | 2024-03-04T09:29:12 | docs/static/schemas/v4.38/json-schema/exports.totp.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"TOTPConfigurationData": {
"additionalProperties": false,
"properties": {
"algorithm": {
"description": "The algorithm this configuration uses.",
"title": "Algorithm",
"type": "string"
},
"created_at": {
"description": "The time the configuration was created.",
"format": "date-time",
"title": "Created At",
"type": "string"
},
"digits": {
"description": "The number of digits this configuration uses.",
"title": "Digits",
"type": "integer"
},
"issuer": {
"description": "The issuer name this was generated with.",
"title": "Issuer",
"type": "string"
},
"last_used_at": {
"description": "The time the configuration was last used at.",
"format": "date-time",
"title": "Last Used At",
"type": "string"
},
"period": {
"description": "The period of time this configuration uses.",
"title": "Period",
"type": "integer"
},
"secret": {
"description": "The secret shared key for this configuration.",
"title": "Secret",
"type": "string"
},
"username": {
"description": "The username of the user this configuration belongs to.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"TOTPConfigurationDataExport": {
"additionalProperties": false,
"properties": {
"totp_configurations": {
"description": "The list of TOTP configurations.",
"items": {
"$ref": "#/$defs/TOTPConfigurationData"
},
"title": "TOTP Configurations",
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/exports.totp.json",
"$ref": "#/$defs/TOTPConfigurationDataExport",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 723b02945783b66f455759fc75b9a297dd44c647 | 2024-03-04T09:29:12 | docs/static/schemas/v4.38/json-schema/user-database.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"FileUserDatabase": {
"additionalProperties": false,
"description": "FileUserDatabase is a user details database that is concurrency safe database and can be reloaded.",
"properties": {
"users": {
"description": "The dictionary of users.",
"patternProperties": {
".*": {
"$ref": "#/$defs/FileUserDatabaseUserDetails"
}
},
"title": "Users",
"type": "object"
}
},
"required": [
"users"
],
"type": "object"
},
"FileUserDatabaseUserDetails": {
"additionalProperties": false,
"description": "FileUserDatabaseUserDetails is the model of user details in the file database.",
"properties": {
"disabled": {
"default": false,
"description": "The disabled status for the user.",
"title": "Disabled",
"type": "boolean"
},
"displayname": {
"description": "The display name for the user.",
"title": "Display Name",
"type": "string"
},
"email": {
"description": "The email for the user.",
"title": "Email",
"type": "string"
},
"groups": {
"description": "The groups list for the user.",
"items": {
"type": "string"
},
"title": "Groups",
"type": "array"
},
"password": {
"$ref": "#/$defs/PasswordDigest",
"description": "The hashed password for the user.",
"title": "Password"
}
},
"required": [
"password",
"displayname"
],
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/user-database.json",
"$ref": "#/$defs/FileUserDatabase",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 40026701fdf604b874334166b9984f6ac003f0fa | 2023-09-03T06:01:46 | docs/static/schemas/v4.38/json-schema/exports.identifiers.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"UUID": {
"items": {
"type": "integer"
},
"maxItems": 16,
"minItems": 16,
"type": "array"
},
"UserOpaqueIdentifier": {
"additionalProperties": false,
"properties": {
"ID": {
"type": "integer"
},
"identifier": {
"$ref": "#/$defs/UUID",
"description": "The random UUID for this opaque identifier",
"title": "Identifier"
},
"sector_id": {
"description": "Sector Identifier this UUID is used with",
"title": "Sector Identifier",
"type": "string"
},
"service": {
"description": "The service name this UUID is used with",
"title": "Service",
"type": "string"
},
"username": {
"description": "The username of the user this UUID is for",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"UserOpaqueIdentifiersExport": {
"additionalProperties": false,
"properties": {
"identifiers": {
"description": "The list of opaque identifiers",
"items": {
"$ref": "#/$defs/UserOpaqueIdentifier"
},
"title": "Identifiers",
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/exports.identifiers.json",
"$ref": "#/$defs/UserOpaqueIdentifiersExport",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 40026701fdf604b874334166b9984f6ac003f0fa | 2023-09-03T06:01:46 | docs/static/schemas/v4.38/json-schema/exports.webauthn.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"WebAuthnDeviceData": {
"additionalProperties": false,
"properties": {
"aaguid": {
"description": "The Authenticator Attestation Global Unique Identifier of this device",
"title": "AAGUID",
"type": "string"
},
"attestation_type": {
"description": "The attestation format type this device uses",
"title": "Attestation Type",
"type": "string"
},
"clone_warning": {
"description": "The clone warning status of the device",
"title": "Clone Warning",
"type": "boolean"
},
"created_at": {
"description": "The time this device was created",
"format": "date-time",
"title": "Created At",
"type": "string"
},
"description": {
"description": "The user description of this device",
"title": "Description",
"type": "string"
},
"id": {
"type": "integer"
},
"kid": {
"description": "The Public Key ID of this device",
"title": "Public Key ID",
"type": "string"
},
"last_used_at": {
"description": "The last time this device was used",
"format": "date-time",
"title": "Last Used At",
"type": "string"
},
"public_key": {
"description": "The device public key",
"title": "Public Key",
"type": "string"
},
"rpid": {
"description": "The Relying Party ID used to register this device",
"title": "Relying Party ID",
"type": "string"
},
"sign_count": {
"description": "The last recorded device sign count",
"title": "Sign Count",
"type": "integer"
},
"transports": {
"description": "The last recorded device transports",
"items": {
"type": "string"
},
"title": "Transports",
"type": "array"
},
"username": {
"description": "The username of the user this device belongs to",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"WebAuthnDeviceDataExport": {
"additionalProperties": false,
"properties": {
"webauthn_devices": {
"description": "The list of WebAuthn devices",
"items": {
"$ref": "#/$defs/WebAuthnDeviceData"
},
"title": "WebAuthn Devices",
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/exports.webauthn.json",
"$ref": "#/$defs/WebAuthnDeviceDataExport",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | fb50f1a70c66d96391a3e9cae5721c9c78c75d8d | 2024-03-05T09:11:16 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule.",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests.",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section.",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to.",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to.",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to.",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to."
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to.",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match.",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to.",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to.",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to.",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to.",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to.",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule.",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group|oauth2:client:):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group|oauth2:client:):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group|oauth2:client:):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration.",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration.",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour.",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend.",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia.",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database.",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour.",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database.",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use.",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters.",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters.",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters.",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters.",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters.",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length.",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used.",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used.",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length.",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used.",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used.",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used.",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used.",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used.",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used.",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used.",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used.",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used.",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used.",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used.",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used.",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used.",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used.",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search.",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username.",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups.",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users.",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server.",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations.",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects.",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects.",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values.",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding.",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup.",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals.",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind.",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS.",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties.",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding.",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects.",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of.",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users.",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects.",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups.",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups.",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users.",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL.",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option.",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration.",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration.",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted.",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them.",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration.",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration.",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration.",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration.",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration.",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration.",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration.",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration.",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration.",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration.",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration.",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration.",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration.",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI.",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration.",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration.",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration.",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow.",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard.",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard.",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard.",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing.",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients.",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended.",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges.",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients.",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens.",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"deprecated": true,
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens.",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"deprecated": true,
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens.",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration.",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter.",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests.",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests.",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients.",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for.",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg').",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences.",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client.",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg').",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client.",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users.",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client.",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client.",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints.",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID.",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg').",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg').",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client.",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client.",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type.",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs.",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client.",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request.",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request.",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted.",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication.",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation.",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client.",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg').",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types.",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant.",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant.",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant.",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant.",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM).",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients.",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows.",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow.",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"elevation_expiration": {
"description": "Duration of time the elevation can exist for after the user performs the validation.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Expiration"
},
"expiration": {
"description": "Duration of time the OTP code is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes.",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods.",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor.",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"expiration": {
"description": "Duration of time the JWT is considered valid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Expiration"
},
"jwt_algorithm": {
"default": "HS256",
"description": "The JWT Algorithm (JWA) used to sign the Reset Password flow JWT's.",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_secret": {
"description": "The JWT secret used to sign the Reset Password flow JWT's.",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK.",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format.",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK.",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK.",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled.",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages.",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option.",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log.",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server.",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error.",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely.",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use.",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks.",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier.",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier.",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides.",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications.",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address.",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version.",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS.",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it.",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command.",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP.",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check.",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used.",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties.",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine.",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine.",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length.",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length.",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters.",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters.",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters.",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters.",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed.",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality.",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy.",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy.",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user.",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on.",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside.",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration.",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality.",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration.",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration.",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration.",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration.",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size.",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size.",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints.",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint.",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint.",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use.",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
},
"schemes": {
"default": [
"basic"
],
"description": "The name of the authorization schemes to allow with the header strategies.",
"items": {
"enum": [
"basic",
"bearer"
],
"type": "string"
},
"title": "Authorization Schemes",
"type": "array"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template.",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate.",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS.",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key.",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations.",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration.",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data.",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration.",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration.",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration.",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index.",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host.",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time.",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis.",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password.",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port.",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance.",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode.",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode.",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance.",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port.",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine.",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings.",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings.",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings.",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file.",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use.",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options.",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options.",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options.",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options.",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain.",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted.",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted.",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key.",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against.",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties.",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys.",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default.",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default.",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default.",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys.",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code.",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys.",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys.",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys.",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys.",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration.",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on.",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server.",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server.",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server.",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials.",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party.",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials.",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | c0dbdd97ab2ac580e3da07a0137dbc7a1b9c9b83 | 2024-03-04T09:28:24 | docs/static/schemas/latest/json-schema/exports.webauthn.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"WebAuthnCredentialData": {
"additionalProperties": false,
"properties": {
"aaguid": {
"description": "The Authenticator Attestation Global Unique Identifier of this credential",
"title": "AAGUID",
"type": "string"
},
"attachment": {
"description": "The last recorded credential attachment type",
"title": "Attachment",
"type": "string"
},
"attestation_type": {
"description": "The attestation format type this credential uses",
"title": "Attestation Type",
"type": "string"
},
"backup_eligible": {
"description": "The backup eligible status of this credential",
"title": "Backup Eligible",
"type": "boolean"
},
"backup_state": {
"description": "The backup eligible status of this credential",
"title": "Backup Eligible",
"type": "boolean"
},
"clone_warning": {
"description": "The clone warning status of the credential",
"title": "Clone Warning",
"type": "boolean"
},
"created_at": {
"description": "The time this credential was created",
"format": "date-time",
"title": "Created At",
"type": "string"
},
"description": {
"description": "The user description of this credential",
"title": "Description",
"type": "string"
},
"discoverable": {
"description": "The discoverable status of this credential",
"title": "Discoverable",
"type": "boolean"
},
"id": {
"type": "integer"
},
"kid": {
"description": "The Public Key ID of this credential",
"title": "Public Key ID",
"type": "string"
},
"last_used_at": {
"description": "The last time this credential was used",
"format": "date-time",
"title": "Last Used At",
"type": "string"
},
"present": {
"description": "The user presence status of this credential",
"title": "Present",
"type": "boolean"
},
"public_key": {
"description": "The credential public key",
"title": "Public Key",
"type": "string"
},
"rpid": {
"description": "The Relying Party ID used to register this credential",
"title": "Relying Party ID",
"type": "string"
},
"sign_count": {
"description": "The last recorded credential sign count",
"title": "Sign Count",
"type": "integer"
},
"transports": {
"description": "The last recorded credential transports",
"items": {
"type": "string"
},
"title": "Transports",
"type": "array"
},
"username": {
"description": "The username of the user this credential belongs to",
"title": "Username",
"type": "string"
},
"verified": {
"description": "The verified status of this credential",
"title": "Verified",
"type": "boolean"
}
},
"type": "object"
},
"WebAuthnCredentialDataExport": {
"additionalProperties": false,
"properties": {
"webauthn_credentials": {
"description": "The list of WebAuthn credentials",
"items": {
"$ref": "#/$defs/WebAuthnCredentialData"
},
"title": "WebAuthn Credentials",
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/exports.webauthn.json",
"$ref": "#/$defs/WebAuthnCredentialDataExport",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | d0cf1c1014d45b34476e6c7ab668506377e4c4ad | 2024-04-25T09:36:47 | docs/static/schemas/v4.39/json-schema/exports.webauthn.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"WebAuthnCredentialData": {
"additionalProperties": false,
"properties": {
"aaguid": {
"description": "The Authenticator Attestation Global Unique Identifier of this credential.",
"title": "AAGUID",
"type": "string"
},
"attachment": {
"description": "The last recorded credential attachment type.",
"title": "Attachment",
"type": "string"
},
"attestation_type": {
"description": "The attestation format type this credential uses.",
"title": "Attestation Type",
"type": "string"
},
"backup_eligible": {
"description": "The backup eligible status of this credential.",
"title": "Backup Eligible",
"type": "boolean"
},
"backup_state": {
"description": "The backup eligible status of this credential.",
"title": "Backup Eligible",
"type": "boolean"
},
"clone_warning": {
"description": "The clone warning status of the credential.",
"title": "Clone Warning",
"type": "boolean"
},
"created_at": {
"description": "The time this credential was created.",
"format": "date-time",
"title": "Created At",
"type": "string"
},
"description": {
"description": "The user description of this credential.",
"title": "Description",
"type": "string"
},
"discoverable": {
"description": "The discoverable status of this credential.",
"title": "Discoverable",
"type": "boolean"
},
"id": {
"type": "integer"
},
"kid": {
"description": "The Public Key ID of this credential.",
"title": "Public Key ID",
"type": "string"
},
"last_used_at": {
"description": "The last time this credential was used.",
"format": "date-time",
"title": "Last Used At",
"type": "string"
},
"legacy": {
"description": "The legacy value indicates this credential may need to be registered again.",
"title": "Legacy",
"type": "boolean"
},
"present": {
"description": "The user presence status of this credential.",
"title": "Present",
"type": "boolean"
},
"public_key": {
"description": "The credential public key.",
"title": "Public Key",
"type": "string"
},
"rpid": {
"description": "The Relying Party ID used to register this credential.",
"title": "Relying Party ID",
"type": "string"
},
"sign_count": {
"description": "The last recorded credential sign count.",
"title": "Sign Count",
"type": "integer"
},
"transports": {
"description": "The last recorded credential transports.",
"items": {
"type": "string"
},
"title": "Transports",
"type": "array"
},
"username": {
"description": "The username of the user this credential belongs to.",
"title": "Username",
"type": "string"
},
"verified": {
"description": "The verified status of this credential.",
"title": "Verified",
"type": "boolean"
}
},
"type": "object"
},
"WebAuthnCredentialDataExport": {
"additionalProperties": false,
"properties": {
"webauthn_credentials": {
"description": "The list of WebAuthn credentials.",
"items": {
"$ref": "#/$defs/WebAuthnCredentialData"
},
"title": "WebAuthn Credentials",
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://www.authelia.com/schemas/v4.39/json-schema/exports.webauthn.json",
"$ref": "#/$defs/WebAuthnCredentialDataExport",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 723b02945783b66f455759fc75b9a297dd44c647 | 2024-03-04T09:29:12 | docs/static/schemas/latest/json-schema/user-database.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"FileUserDatabase": {
"additionalProperties": false,
"description": "FileUserDatabase is a user details database that is concurrency safe database and can be reloaded.",
"properties": {
"users": {
"description": "The dictionary of users.",
"patternProperties": {
".*": {
"$ref": "#/$defs/FileUserDatabaseUserDetails"
}
},
"title": "Users",
"type": "object"
}
},
"required": [
"users"
],
"type": "object"
},
"FileUserDatabaseUserDetails": {
"additionalProperties": false,
"description": "FileUserDatabaseUserDetails is the model of user details in the file database.",
"properties": {
"disabled": {
"default": false,
"description": "The disabled status for the user.",
"title": "Disabled",
"type": "boolean"
},
"displayname": {
"description": "The display name for the user.",
"title": "Display Name",
"type": "string"
},
"email": {
"description": "The email for the user.",
"title": "Email",
"type": "string"
},
"groups": {
"description": "The groups list for the user.",
"items": {
"type": "string"
},
"title": "Groups",
"type": "array"
},
"password": {
"$ref": "#/$defs/PasswordDigest",
"description": "The hashed password for the user.",
"title": "Password"
}
},
"required": [
"password",
"displayname"
],
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/user-database.json",
"$ref": "#/$defs/FileUserDatabase",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | d0cf1c1014d45b34476e6c7ab668506377e4c4ad | 2024-04-25T09:36:47 | docs/static/schemas/v4.39/json-schema/user-database.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"FileUserDatabase": {
"additionalProperties": false,
"description": "FileUserDatabase is a user details database that is concurrency safe database and can be reloaded.",
"properties": {
"users": {
"description": "The dictionary of users.",
"patternProperties": {
".*": {
"$ref": "#/$defs/FileUserDatabaseUserDetails"
}
},
"title": "Users",
"type": "object"
}
},
"required": [
"users"
],
"type": "object"
},
"FileUserDatabaseUserDetails": {
"additionalProperties": false,
"description": "FileUserDatabaseUserDetails is the model of user details in the file database.",
"properties": {
"disabled": {
"default": false,
"description": "The disabled status for the user.",
"title": "Disabled",
"type": "boolean"
},
"displayname": {
"description": "The display name for the user.",
"title": "Display Name",
"type": "string"
},
"email": {
"description": "The email for the user.",
"title": "Email",
"type": "string"
},
"groups": {
"description": "The groups list for the user.",
"items": {
"type": "string"
},
"title": "Groups",
"type": "array"
},
"password": {
"$ref": "#/$defs/PasswordDigest",
"description": "The hashed password for the user.",
"title": "Password"
}
},
"required": [
"password",
"displayname"
],
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.39/json-schema/user-database.json",
"$ref": "#/$defs/FileUserDatabase",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 723b02945783b66f455759fc75b9a297dd44c647 | 2024-03-04T09:29:12 | docs/static/schemas/latest/json-schema/exports.webauthn.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"WebAuthnCredentialData": {
"additionalProperties": false,
"properties": {
"aaguid": {
"description": "The Authenticator Attestation Global Unique Identifier of this credential.",
"title": "AAGUID",
"type": "string"
},
"attachment": {
"description": "The last recorded credential attachment type.",
"title": "Attachment",
"type": "string"
},
"attestation_type": {
"description": "The attestation format type this credential uses.",
"title": "Attestation Type",
"type": "string"
},
"backup_eligible": {
"description": "The backup eligible status of this credential.",
"title": "Backup Eligible",
"type": "boolean"
},
"backup_state": {
"description": "The backup eligible status of this credential.",
"title": "Backup Eligible",
"type": "boolean"
},
"clone_warning": {
"description": "The clone warning status of the credential.",
"title": "Clone Warning",
"type": "boolean"
},
"created_at": {
"description": "The time this credential was created.",
"format": "date-time",
"title": "Created At",
"type": "string"
},
"description": {
"description": "The user description of this credential.",
"title": "Description",
"type": "string"
},
"discoverable": {
"description": "The discoverable status of this credential.",
"title": "Discoverable",
"type": "boolean"
},
"id": {
"type": "integer"
},
"kid": {
"description": "The Public Key ID of this credential.",
"title": "Public Key ID",
"type": "string"
},
"last_used_at": {
"description": "The last time this credential was used.",
"format": "date-time",
"title": "Last Used At",
"type": "string"
},
"legacy": {
"description": "The legacy value indicates this credential may need to be registered again.",
"title": "Legacy",
"type": "boolean"
},
"present": {
"description": "The user presence status of this credential.",
"title": "Present",
"type": "boolean"
},
"public_key": {
"description": "The credential public key.",
"title": "Public Key",
"type": "string"
},
"rpid": {
"description": "The Relying Party ID used to register this credential.",
"title": "Relying Party ID",
"type": "string"
},
"sign_count": {
"description": "The last recorded credential sign count.",
"title": "Sign Count",
"type": "integer"
},
"transports": {
"description": "The last recorded credential transports.",
"items": {
"type": "string"
},
"title": "Transports",
"type": "array"
},
"username": {
"description": "The username of the user this credential belongs to.",
"title": "Username",
"type": "string"
},
"verified": {
"description": "The verified status of this credential.",
"title": "Verified",
"type": "boolean"
}
},
"type": "object"
},
"WebAuthnCredentialDataExport": {
"additionalProperties": false,
"properties": {
"webauthn_credentials": {
"description": "The list of WebAuthn credentials.",
"items": {
"$ref": "#/$defs/WebAuthnCredentialData"
},
"title": "WebAuthn Credentials",
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/exports.webauthn.json",
"$ref": "#/$defs/WebAuthnCredentialDataExport",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 32424bf8c5f0abc7199689d82794e30d85d3abbd | 2024-03-16T11:50:40 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule.",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests.",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section.",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to.",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to.",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to.",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to."
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to.",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match.",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to.",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to.",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to.",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to.",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to.",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule.",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration.",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration.",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour.",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend.",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia.",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database.",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour.",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database.",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use.",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters.",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters.",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters.",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters.",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters.",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length.",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used.",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used.",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length.",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used.",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used.",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used.",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used.",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used.",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used.",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used.",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used.",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used.",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used.",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used.",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used.",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used.",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used.",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search.",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username.",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups.",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users.",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server.",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations.",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects.",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects.",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values.",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding.",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup.",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals.",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind.",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS.",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties.",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding.",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects.",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of.",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users.",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects.",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups.",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups.",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users.",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL.",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option.",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration.",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration.",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted.",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them.",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration.",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration.",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration.",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration.",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration.",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration.",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration.",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration.",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration.",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration.",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration.",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration.",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration.",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI.",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration.",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration.",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration.",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow.",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard.",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard.",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard.",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing.",
"title": "CORS"
},
"discovery_signed_response_alg": {
"default": "none",
"description": "The Algorithm this provider uses to sign the Discovery and Metadata Document responses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Discovery Response Signing Algorithm",
"type": "string"
},
"discovery_signed_response_key_id": {
"description": "The Key ID this provider uses to sign the Discovery and Metadata Document responses (overrides the 'discovery_signed_response_alg').",
"title": "Discovery Response Signing Key ID",
"type": "string"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients.",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended.",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges.",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients.",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens.",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"deprecated": true,
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens.",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"deprecated": true,
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens.",
"pattern": "^-{5}(BEGIN (RSA )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (RSA )?PRIVATE KEY-{5}\\n?)+$",
"title": "Issuer Private Key",
"type": "string"
},
"jwks": {
"description": "The JWK's which are to be used to sign various objects like ID Tokens.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer JSON Web Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration.",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter.",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"require_pushed_authorization_requests": {
"description": "Requires Pushed Authorization Requests for all clients for this Issuer.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests.",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients.",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for.",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg').",
"title": "Access Token Signing Key ID",
"type": "string"
},
"allow_multiple_auth_methods": {
"description": "Permits this registered client to accept misbehaving clients which use a broad authentication approach. This is not standards complaint, use at your own security risk.",
"title": "Allow Multiple Authentication Methods",
"type": "boolean"
},
"audience": {
"description": "List of authorized audiences.",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client.",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg').",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"client_id": {
"description": "The Client ID.",
"minLength": 1,
"title": "Client ID",
"type": "string"
},
"client_name": {
"description": "The Client Name displayed to End-Users.",
"title": "Client Name",
"type": "string"
},
"client_secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication.",
"title": "Client Secret"
},
"consent_mode": {
"description": "The Consent Mode used for this client.",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints.",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token",
"client_credentials"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg').",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg').",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"jwks": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "JSON Web Keys",
"type": "array"
},
"jwks_uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"format": "uri",
"title": "JSON Web Keys URI",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client.",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client.",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type.",
"title": "Public",
"type": "boolean"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs.",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client.",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"require_pkce": {
"default": false,
"description": "Requires a Proof Key for this client to perform Code Exchange.",
"title": "Require PKCE",
"type": "boolean"
},
"require_pushed_authorization_requests": {
"default": false,
"description": "Requires Pushed Authorization Requests for this client to perform an authorization.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
},
"response_modes": {
"description": "The Response Modes this client is authorized request.",
"items": {
"enum": [
"form_post",
"form_post.jwt",
"query",
"query.jwt",
"fragment",
"fragment.jwt",
"jwt"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request.",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted.",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile",
"authelia.bearer.authz"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"sector_identifier_uri": {
"description": "The Client Sector Identifier URI for Privacy Isolation via Pairwise subject types.",
"format": "uri",
"title": "Sector Identifier URI",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client.",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg').",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"client_id",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types.",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant.",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant.",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant.",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant.",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM).",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows.",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow.",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"code_lifespan": {
"description": "The lifespan of the randomly generated One Time Code after which it's considered invalid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Code Lifespan"
},
"elevation_lifespan": {
"description": "The lifespan of the elevation after initially validating the One-Time Code before it expires.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Lifespan"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes.",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods.",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor.",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"jwt_algorithm": {
"default": "HS256",
"description": "The JSON Web Token Algorithm (JWA) used to sign the Reset Password flow JSON Web Token's.",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_lifespan": {
"description": "The lifespan of the JSON Web Token after it's initially generated after which it's considered invalid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JWT Lifespan"
},
"jwt_secret": {
"description": "The secret key used to sign the Reset Password flow JSON Web Token's.",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK.",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format.",
"pattern": "^-{5}BEGIN (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n?$",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK.",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK.",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled.",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages.",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option.",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log.",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server.",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error.",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely.",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use.",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks.",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier.",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier.",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides.",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications.",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address.",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version.",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS.",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it.",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command.",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP.",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check.",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used.",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties.",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine.",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine.",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length.",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length.",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters.",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters.",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters.",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters.",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed.",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality.",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy.",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy.",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user.",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on.",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside.",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration.",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality.",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration.",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration.",
"title": "Headers"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration.",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration.",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size.",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size.",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints.",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint.",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint.",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use.",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
},
"schemes": {
"default": [
"basic"
],
"description": "The name of the authorization schemes to allow with the header strategies.",
"items": {
"enum": [
"basic",
"bearer"
],
"type": "string"
},
"title": "Authorization Schemes",
"type": "array"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template.",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate.",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS.",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key.",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations.",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration.",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data.",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration.",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration.",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration.",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index.",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host.",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time.",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis.",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password.",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port.",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance.",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode.",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode.",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance.",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port.",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine.",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings.",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings.",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings.",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file.",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"schema": {
"default": "public",
"description": "The default schema name to use.",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options.",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options.",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options.",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options.",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain.",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted.",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted.",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key.",
"pattern": "^-{5}BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against.",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties.",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys.",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default.",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default.",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default.",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys.",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code.",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys.",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys.",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys.",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys.",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration.",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on.",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server.",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server.",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server.",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials.",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party.",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials.",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | c9507368abd3374364cca8e1e7b1cbe8494a7130 | 2023-09-17T02:24:24 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests. Not relevant to OpenID Connect.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?umask=[0-7]{3,4})?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"description": "Used to redirect users when they visit the portal directly",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"jwt_secret": {
"description": "Used for signing HS256 JWT's for identity verification",
"title": "Secret Key for JWT's",
"type": "string"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"DisableRememberMe": {
"type": "boolean"
},
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the cookies options instead.",
"type": "string"
},
"expiration": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"DisableRememberMe": {
"type": "boolean"
},
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"type": "string"
},
"remember_me": {
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"schema": {
"default": "public",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead."
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"type": "string"
},
"key": {
"type": "string"
},
"mode": {
"deprecated": true,
"type": "string"
},
"root_certificate": {
"deprecated": true,
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 438e433e5b211512954f3c6ae5255269883f65e3 | 2024-03-16T08:07:54 | docs/static/schemas/latest/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule.",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests.",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section.",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to.",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to.",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to.",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to."
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to.",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match.",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to.",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to.",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to.",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to.",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to.",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule.",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration.",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration.",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour.",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend.",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia.",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database.",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour.",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database.",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use.",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters.",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters.",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters.",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters.",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters.",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length.",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used.",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used.",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length.",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used.",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used.",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used.",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used.",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used.",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used.",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used.",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used.",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used.",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used.",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used.",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used.",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used.",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used.",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search.",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username.",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups.",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users.",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server.",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations.",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects.",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects.",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values.",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding.",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup.",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals.",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind.",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS.",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties.",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding.",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects.",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of.",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users.",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects.",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups.",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups.",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users.",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL.",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option.",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration.",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration.",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted.",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them.",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration.",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration.",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration.",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration.",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration.",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration.",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration.",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration.",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration.",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration.",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration.",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration.",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration.",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI.",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration.",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration.",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration.",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow.",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard.",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard.",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard.",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing.",
"title": "CORS"
},
"discovery_signed_response_alg": {
"default": "none",
"description": "The Algorithm this provider uses to sign the Discovery and Metadata Document responses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Discovery Response Signing Algorithm",
"type": "string"
},
"discovery_signed_response_key_id": {
"description": "The Key ID this provider uses to sign the Discovery and Metadata Document responses (overrides the 'discovery_signed_response_alg').",
"title": "Discovery Response Signing Key ID",
"type": "string"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients.",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended.",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges.",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients.",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens.",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"deprecated": true,
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens.",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"deprecated": true,
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens.",
"pattern": "^-{5}(BEGIN (RSA )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (RSA )?PRIVATE KEY-{5}\\n?)+$",
"title": "Issuer Private Key",
"type": "string"
},
"jwks": {
"description": "The JWK's which are to be used to sign various objects like ID Tokens.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer JSON Web Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration.",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter.",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"require_pushed_authorization_requests": {
"description": "Requires Pushed Authorization Requests for all clients for this Issuer.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests.",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients.",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for.",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg').",
"title": "Access Token Signing Key ID",
"type": "string"
},
"allow_multiple_auth_methods": {
"description": "Permits this registered client to accept misbehaving clients which use a broad authentication approach. This is not standards complaint, use at your own security risk.",
"title": "Allow Multiple Authentication Methods",
"type": "boolean"
},
"audience": {
"description": "List of authorized audiences.",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client.",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg').",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"client_id": {
"description": "The Client ID.",
"minLength": 1,
"title": "Client ID",
"type": "string"
},
"client_name": {
"description": "The Client Name displayed to End-Users.",
"title": "Client Name",
"type": "string"
},
"client_secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication.",
"title": "Client Secret"
},
"consent_mode": {
"description": "The Consent Mode used for this client.",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints.",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token",
"client_credentials"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg').",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg').",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"jwks": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "JSON Web Keys",
"type": "array"
},
"jwks_uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"format": "uri",
"title": "JSON Web Keys URI",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client.",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client.",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type.",
"title": "Public",
"type": "boolean"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs.",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client.",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"require_pkce": {
"default": false,
"description": "Requires a Proof Key for this client to perform Code Exchange.",
"title": "Require PKCE",
"type": "boolean"
},
"require_pushed_authorization_requests": {
"default": false,
"description": "Requires Pushed Authorization Requests for this client to perform an authorization.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
},
"response_modes": {
"description": "The Response Modes this client is authorized request.",
"items": {
"enum": [
"form_post",
"form_post.jwt",
"query",
"query.jwt",
"fragment",
"fragment.jwt",
"jwt"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request.",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted.",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile",
"authelia.bearer.authz"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"sector_identifier_uri": {
"description": "The Client Sector Identifier URI for Privacy Isolation via Pairwise subject types.",
"format": "uri",
"title": "Sector Identifier URI",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client.",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg').",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"client_id",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types.",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant.",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant.",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant.",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant.",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM).",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows.",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow.",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"code_lifespan": {
"description": "The lifespan of the randomly generated One Time Code after which it's considered invalid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Code Lifespan"
},
"elevation_lifespan": {
"description": "The lifespan of the elevation after initially validating the One-Time Code before it expires.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Lifespan"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes.",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods.",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor.",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"jwt_algorithm": {
"default": "HS256",
"description": "The JSON Web Token Algorithm (JWA) used to sign the Reset Password flow JSON Web Token's.",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_lifespan": {
"description": "The lifespan of the JSON Web Token after it's initially generated after which it's considered invalid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JWT Lifespan"
},
"jwt_secret": {
"description": "The secret key used to sign the Reset Password flow JSON Web Token's.",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK.",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format.",
"pattern": "^-{5}BEGIN (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n?$",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK.",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK.",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled.",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages.",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option.",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log.",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server.",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error.",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely.",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use.",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks.",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier.",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier.",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides.",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications.",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address.",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version.",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS.",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it.",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command.",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP.",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check.",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used.",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties.",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine.",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine.",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length.",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length.",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters.",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters.",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters.",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters.",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed.",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality.",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy.",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy.",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user.",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on.",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside.",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration.",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality.",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration.",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration.",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration.",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration.",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size.",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size.",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints.",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint.",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint.",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use.",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
},
"schemes": {
"default": [
"basic"
],
"description": "The name of the authorization schemes to allow with the header strategies.",
"items": {
"enum": [
"basic",
"bearer"
],
"type": "string"
},
"title": "Authorization Schemes",
"type": "array"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template.",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate.",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS.",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key.",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations.",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration.",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data.",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration.",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration.",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration.",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index.",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host.",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time.",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis.",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password.",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port.",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance.",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode.",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode.",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance.",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port.",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine.",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings.",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings.",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings.",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file.",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use.",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options.",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options.",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options.",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options.",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain.",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted.",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted.",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key.",
"pattern": "^-{5}BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against.",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties.",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys.",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default.",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default.",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default.",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys.",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code.",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys.",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys.",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys.",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys.",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration.",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on.",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server.",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server.",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server.",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials.",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party.",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials.",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | 465d30f415a92e3708914ca14e24e6021935f633 | 2023-10-02T02:50:36 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests. Not relevant to OpenID Connect.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?umask=[0-7]{3,4})?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Used to redirect users when they visit the portal directly, this option has been deprecated in favor of the session multi-cookie domain configuration",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"jwt_secret": {
"description": "Used for signing HS256 JWT's for identity verification",
"title": "Secret Key for JWT's",
"type": "string"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "The domain for the cookie, this option has been deprecated in favor of the session multi-cookie domain configuration",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this cookie domain",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"schema": {
"default": "public",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead."
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"type": "string"
},
"key": {
"type": "string"
},
"mode": {
"deprecated": true,
"type": "string"
},
"root_certificate": {
"deprecated": true,
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | ab4d14c890bc2f79a1f7e684746bc5659c819356 | 2024-03-27T11:25:35 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule.",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests.",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section.",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to.",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to.",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to.",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to."
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to.",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match.",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to.",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to.",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to.",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to.",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to.",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule.",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration.",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration.",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour.",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend.",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia.",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database.",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour.",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database.",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use.",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters.",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters.",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters.",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters.",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters.",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length.",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used.",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used.",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length.",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used.",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used.",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used.",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used.",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used.",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used.",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used.",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used.",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used.",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used.",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used.",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used.",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used.",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used.",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search.",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username.",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups.",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users.",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server.",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations.",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects.",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects.",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values.",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding.",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup.",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals.",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind.",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS.",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties.",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding.",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects.",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of.",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users.",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects.",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups.",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups.",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users.",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL.",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option.",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration.",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration.",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted.",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them.",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration.",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration.",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration.",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration.",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration.",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration.",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration.",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration.",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration.",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration.",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration.",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration.",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration.",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI.",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration.",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration.",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration.",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow.",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard.",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard.",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard.",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing.",
"title": "CORS"
},
"discovery_signed_response_alg": {
"default": "none",
"description": "The Algorithm this provider uses to sign the Discovery and Metadata Document responses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Discovery Response Signing Algorithm",
"type": "string"
},
"discovery_signed_response_key_id": {
"description": "The Key ID this provider uses to sign the Discovery and Metadata Document responses (overrides the 'discovery_signed_response_alg').",
"title": "Discovery Response Signing Key ID",
"type": "string"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients.",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended.",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges.",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients.",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens.",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"deprecated": true,
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens.",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"deprecated": true,
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens.",
"pattern": "^-{5}(BEGIN (RSA )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (RSA )?PRIVATE KEY-{5}\\n?)+$",
"title": "Issuer Private Key",
"type": "string"
},
"jwks": {
"description": "The JWK's which are to be used to sign various objects like ID Tokens.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer JSON Web Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration.",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter.",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"require_pushed_authorization_requests": {
"description": "Requires Pushed Authorization Requests for all clients for this Issuer.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests.",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients.",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for.",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg').",
"title": "Access Token Signing Key ID",
"type": "string"
},
"allow_multiple_auth_methods": {
"description": "Permits this registered client to accept misbehaving clients which use a broad authentication approach. This is not standards complaint, use at your own security risk.",
"title": "Allow Multiple Authentication Methods",
"type": "boolean"
},
"audience": {
"description": "List of authorized audiences.",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client.",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg').",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"client_id": {
"description": "The Client ID.",
"minLength": 1,
"title": "Client ID",
"type": "string"
},
"client_name": {
"description": "The Client Name displayed to End-Users.",
"title": "Client Name",
"type": "string"
},
"client_secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication.",
"title": "Client Secret"
},
"consent_mode": {
"description": "The Consent Mode used for this client.",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints.",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token",
"client_credentials"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg').",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg').",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"jwks": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "JSON Web Keys",
"type": "array"
},
"jwks_uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"format": "uri",
"title": "JSON Web Keys URI",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client.",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client.",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type.",
"title": "Public",
"type": "boolean"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientURIs",
"description": "List of whitelisted redirect URIs.",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"request_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientURIs",
"description": "List of whitelisted request URIs.",
"title": "Request URIs"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client.",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"require_pkce": {
"default": false,
"description": "Requires a Proof Key for this client to perform Code Exchange.",
"title": "Require PKCE",
"type": "boolean"
},
"require_pushed_authorization_requests": {
"default": false,
"description": "Requires Pushed Authorization Requests for this client to perform an authorization.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
},
"response_modes": {
"description": "The Response Modes this client is authorized request.",
"items": {
"enum": [
"form_post",
"form_post.jwt",
"query",
"query.jwt",
"fragment",
"fragment.jwt",
"jwt"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request.",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted.",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile",
"authelia.bearer.authz"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"sector_identifier_uri": {
"description": "The Client Sector Identifier URI for Privacy Isolation via Pairwise subject types.",
"format": "uri",
"title": "Sector Identifier URI",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client.",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg').",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"client_id",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types.",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant.",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant.",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant.",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant.",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM).",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows.",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow.",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"code_lifespan": {
"description": "The lifespan of the randomly generated One Time Code after which it's considered invalid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Code Lifespan"
},
"elevation_lifespan": {
"description": "The lifespan of the elevation after initially validating the One-Time Code before it expires.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Lifespan"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes.",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods.",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor.",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"jwt_algorithm": {
"default": "HS256",
"description": "The JSON Web Token Algorithm (JWA) used to sign the Reset Password flow JSON Web Token's.",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_lifespan": {
"description": "The lifespan of the JSON Web Token after it's initially generated after which it's considered invalid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JWT Lifespan"
},
"jwt_secret": {
"description": "The secret key used to sign the Reset Password flow JSON Web Token's.",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK.",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format.",
"pattern": "^-{5}BEGIN (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n?$",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK.",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK.",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled.",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages.",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option.",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log.",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server.",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error.",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely.",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use.",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks.",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier.",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier.",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides.",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications.",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address.",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version.",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS.",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it.",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command.",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP.",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check.",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used.",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties.",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine.",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine.",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length.",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length.",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters.",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters.",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters.",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters.",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed.",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality.",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy.",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy.",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user.",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on.",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside.",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration.",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality.",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration.",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration.",
"title": "Headers"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration.",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration.",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size.",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size.",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints.",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint.",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint.",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use.",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
},
"schemes": {
"default": [
"basic"
],
"description": "The name of the authorization schemes to allow with the header strategies.",
"items": {
"enum": [
"basic",
"bearer"
],
"type": "string"
},
"title": "Authorization Schemes",
"type": "array"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template.",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate.",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS.",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key.",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations.",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration.",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data.",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration.",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration.",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration.",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index.",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host.",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time.",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis.",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password.",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port.",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance.",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode.",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode.",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance.",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port.",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine.",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings.",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings.",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings.",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file.",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"schema": {
"default": "public",
"description": "The default schema name to use.",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options.",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options.",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options.",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options.",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain.",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted.",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted.",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key.",
"pattern": "^-{5}BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against.",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties.",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys.",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default.",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default.",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default.",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys.",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code.",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys.",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys.",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys.",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys.",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration.",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on.",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server.",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server.",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server.",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials.",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party.",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials.",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | e4bf1d73f529d4aa5c158e91e65a59a991ce00cc | 2023-11-20T10:19:30 | docs/static/schemas/v4.38/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to"
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?umask=[0-7]{3,4})?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp(4|6)?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour",
"title": "Password Reset"
},
"refresh_interval": {
"description": "How frequently the user details are refreshed from the backend",
"title": "Refresh Interval",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration",
"title": "Identity Providers"
},
"jwt_secret": {
"description": "Used for signing HS256 JWT's for identity verification",
"title": "Secret Key for JWT's",
"type": "string"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing",
"title": "CORS"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens",
"title": "Issuer Private Key",
"type": "string"
},
"issuer_private_keys": {
"description": "The Private Keys used to sign ID Tokens",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer Private Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"pushed_authorizations": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPAR",
"description": "Configuration options for Pushed Authorization Requests",
"title": "Pushed Authorizations"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg')",
"title": "Access Token Signing Key ID",
"type": "string"
},
"audience": {
"description": "List of authorized audiences",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg')",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"consent_mode": {
"description": "The Consent Mode used for this client",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"description": {
"description": "The Client Description for End-Users",
"title": "Description",
"type": "string"
},
"enforce_par": {
"default": false,
"description": "Enforces Pushed Authorization Requests for this client",
"title": "Enforce PAR",
"type": "boolean"
},
"enforce_pkce": {
"default": false,
"description": "Enforces Proof Key for Code Exchange for this client",
"title": "Enforce PKCE",
"type": "boolean"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id": {
"description": "The Client ID",
"minLength": 1,
"title": "ID",
"type": "string"
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg')",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg')",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type",
"title": "Public",
"type": "boolean"
},
"public_keys": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientPublicKeys",
"description": "Public Key options used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"title": "Public Keys"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientRedirectURIs",
"description": "List of authorized redirect URIs",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"response_modes": {
"description": "The Response Modes this client is authorized request",
"items": {
"enum": [
"form_post",
"query",
"fragment"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication",
"title": "Secret"
},
"sector_identifier": {
"description": "The Client Sector Identifier for Privacy Isolation",
"format": "uri",
"title": "Sector Identifier",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg')",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"id",
"redirect_uris",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientPublicKeys": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClientPublicKeys represents the Client Public Keys configuration for an OpenID Connect 1.0 client.",
"oneOf": [
{
"required": [
"uri"
],
"title": "URI"
},
{
"required": [
"values"
],
"title": "Values"
}
],
"properties": {
"uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"format": "uri",
"title": "URI",
"type": "string"
},
"values": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Values",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClientRedirectURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM)",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPAR": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPAR represents an OpenID Connect 1.0 PAR config.",
"properties": {
"context_lifespan": {
"description": "How long a PAR context is valid for",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Context Lifespan"
},
"enforce": {
"default": false,
"description": "Enforce the use of PAR for all requests on all clients",
"title": "Enforce",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant",
"title": "Subject"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled'",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log'",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it'",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded'",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration",
"title": "Headers"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"path": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Path",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Port",
"type": "integer"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection",
"title": "Database",
"type": "string"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "string"
},
"password": {
"description": "The password to use to authenticate",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"title": "Host",
"type": "integer"
},
"schema": {
"default": "public",
"description": "The default schema name to use",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key",
"pattern": "^-{5}(BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?)+$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9/+]{1,64}\\n)+([a-zA-Z0-9/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | d0cf1c1014d45b34476e6c7ab668506377e4c4ad | 2024-04-25T09:36:47 | docs/static/schemas/v4.39/json-schema/configuration.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"AccessControl": {
"additionalProperties": false,
"description": "AccessControl represents the configuration related to ACLs.",
"properties": {
"default_policy": {
"default": "deny",
"description": "The default policy applied to all authorization requests unrelated to OpenID Connect 1.0.",
"enum": [
"deny",
"one_factor",
"two_factor"
],
"title": "Default Authorization Policy",
"type": "string"
},
"networks": {
"description": "The list of named networks which can be reused in any ACL rule.",
"items": {
"$ref": "#/$defs/AccessControlNetwork"
},
"title": "Named Networks",
"type": "array"
},
"rules": {
"description": "The list of ACL rules to enumerate for requests.",
"items": {
"$ref": "#/$defs/AccessControlRule"
},
"title": "Rules List",
"type": "array"
}
},
"type": "object"
},
"AccessControlNetwork": {
"additionalProperties": false,
"description": "AccessControlNetwork represents one ACL network group entry.",
"properties": {
"name": {
"description": "The name of this network to be used in the networks section of the rules section.",
"title": "Network Name",
"type": "string"
},
"networks": {
"$ref": "#/$defs/AccessControlNetworkNetworks",
"description": "The remote IP's or network ranges in CIDR notation that this rule applies to.",
"title": "Networks"
}
},
"required": [
"name",
"networks"
],
"type": "object"
},
"AccessControlNetworkNetworks": {
"oneOf": [
{
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
{
"items": {
"pattern": "((^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))(\\/([0-2]?[0-9]|3[0-2]))?$)|(^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))?(\\/(12[0-8]|1[0-1][0-9]|[0-9]{1,2}))?$))",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRule": {
"additionalProperties": false,
"description": "AccessControlRule represents one ACL rule entry.",
"oneOf": [
{
"required": [
"domain"
],
"title": "Domain"
},
{
"required": [
"domain_regex"
],
"title": "Domain Regex"
}
],
"properties": {
"domain": {
"$ref": "#/$defs/AccessControlRuleDomains",
"description": "The literal domains to match the domain against that this rule applies to.",
"title": "Domain Literals"
},
"domain_regex": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the domain against that this rule applies to.",
"title": "Domain Regex Patterns"
},
"methods": {
"$ref": "#/$defs/AccessControlRuleMethods",
"description": "The list of request methods this rule applies to."
},
"networks": {
"$ref": "#/$defs/AccessControlRuleNetworks",
"description": "The remote IP's, network ranges in CIDR notation, or network names that this rule applies to.",
"title": "Networks"
},
"policy": {
"description": "The policy this rule applies when all criteria match.",
"enum": [
"bypass",
"deny",
"one_factor",
"two_factor"
],
"title": "Rule Policy",
"type": "string"
},
"query": {
"description": "The list of query parameter rules this rule applies to.",
"items": {
"items": {
"$ref": "#/$defs/AccessControlRuleQuery"
},
"type": "array"
},
"title": "Query Rules",
"type": "array"
},
"resources": {
"$ref": "#/$defs/AccessControlRuleRegex",
"description": "The regex patterns to match the resource paths that this rule applies to.",
"title": "Resources or Paths"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "The users or groups that this rule applies to.",
"title": "AccessControlRuleSubjects"
}
},
"required": [
"policy"
],
"type": "object"
},
"AccessControlRuleDomains": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleMethods": {
"oneOf": [
{
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
{
"items": {
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"TRACE",
"CONNECT",
"OPTIONS",
"COPY",
"LOCK",
"MKCOL",
"MOVE",
"PROPFIND",
"PROPPATCH",
"UNLOCK"
],
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleNetworks": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleQuery": {
"additionalProperties": false,
"description": "AccessControlRuleQuery represents the ACL query criteria.",
"properties": {
"key": {
"description": "The Query Parameter key this rule applies to.",
"title": "Key",
"type": "string"
},
"operator": {
"description": "The list of query parameter rules this rule applies to.",
"enum": [
"equal",
"not equal",
"present",
"absent",
"pattern",
"not pattern"
],
"title": "Operator",
"type": "string"
},
"value": {
"description": "The Query Parameter value for this rule.",
"title": "Value"
}
},
"required": [
"key"
],
"type": "object"
},
"AccessControlRuleRegex": {
"oneOf": [
{
"format": "regex",
"type": "string"
},
{
"items": {
"format": "regex",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"AccessControlRuleSubjects": {
"oneOf": [
{
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
{
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
{
"items": {
"items": {
"pattern": "^(user|group|oauth2:client):.+$",
"type": "string"
},
"type": "array"
},
"type": "array",
"uniqueItems": true
}
]
},
"AddressLDAP": {
"format": "uri",
"pattern": "^((ldaps?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?|ldapi:\\/\\/(\\/[^?\\n]+)?)$",
"type": "string"
},
"AddressSMTP": {
"format": "uri",
"pattern": "^((smtp|submissions?):\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)?$",
"type": "string"
},
"AddressTCP": {
"format": "uri",
"pattern": "^((tcp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?|unix:\\/\\/\\/[^?\\n]+(\\?(umask=[0-7]{3,4}|path=[a-z]+)(&(umask=[0-7]{3,4}|path=[a-zA-Z0-9.~_-]+))?)?)$",
"type": "string"
},
"AddressUDP": {
"format": "uri",
"pattern": "^(udp[46]?:\\/\\/)?([^:\\/]*(:\\d+)|[^:\\/]+(:\\d+)?)(\\/.*)?$",
"type": "string"
},
"AuthenticationBackend": {
"additionalProperties": false,
"description": "AuthenticationBackend represents the configuration related to the authentication backend.",
"properties": {
"file": {
"$ref": "#/$defs/AuthenticationBackendFile",
"description": "The file authentication backend configuration.",
"title": "File Backend"
},
"ldap": {
"$ref": "#/$defs/AuthenticationBackendLDAP",
"description": "The LDAP authentication backend configuration.",
"title": "LDAP Backend"
},
"password_reset": {
"$ref": "#/$defs/AuthenticationBackendPasswordReset",
"description": "Allows configuration of the password reset behaviour.",
"title": "Password Reset"
},
"refresh_interval": {
"$ref": "#/$defs/RefreshIntervalDuration",
"description": "How frequently the user details are refreshed from the backend.",
"title": "Refresh Interval"
}
},
"type": "object"
},
"AuthenticationBackendFile": {
"additionalProperties": false,
"description": "AuthenticationBackendFile represents the configuration related to file-based backend.",
"properties": {
"password": {
"$ref": "#/$defs/AuthenticationBackendFilePassword",
"description": "Allows configuration of the password hashing options when the user passwords are changed directly by Authelia.",
"title": "Password Options"
},
"path": {
"description": "The file path to the user database.",
"title": "Path",
"type": "string"
},
"search": {
"$ref": "#/$defs/AuthenticationBackendFileSearch",
"description": "Configures the user searching behaviour.",
"title": "Search"
},
"watch": {
"default": false,
"description": "Enables watching the file for external changes and dynamically reloading the database.",
"title": "Watch",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendFilePassword": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePassword represents the configuration related to password hashing.",
"properties": {
"algorithm": {
"default": "argon2",
"description": "The password hashing algorithm to use.",
"enum": [
"argon2",
"sha2crypt",
"pbkdf2",
"bcrypt",
"scrypt"
],
"title": "Algorithm",
"type": "string"
},
"argon2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordArgon2",
"description": "Configure the Argon2 password hashing parameters.",
"title": "Argon2"
},
"bcrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordBCrypt",
"description": "Configure the BCrypt password hashing parameters.",
"title": "BCrypt"
},
"iterations": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Key Length",
"type": "integer"
},
"memory": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Memory",
"type": "integer"
},
"parallelism": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Parallelism",
"type": "integer"
},
"pbkdf2": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordPBKDF2",
"description": "Configure the PBKDF2 password hashing parameters.",
"title": "PBKDF2"
},
"salt_length": {
"deprecated": true,
"description": "Deprecated: Use individual password options instead.",
"title": "Salt Length",
"type": "integer"
},
"scrypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSCrypt",
"description": "Configure the SCrypt password hashing parameters.",
"title": "SCrypt"
},
"sha2crypt": {
"$ref": "#/$defs/AuthenticationBackendFilePasswordSHA2Crypt",
"description": "Configure the SHA2Crypt password hashing parameters.",
"title": "SHA2Crypt"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordArgon2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.",
"properties": {
"iterations": {
"default": 3,
"description": "The number of Argon2 iterations (parameter t) to be used.",
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The Argon2 key output length.",
"maximum": 2147483647,
"minimum": 4,
"title": "Key Length",
"type": "integer"
},
"memory": {
"default": 65536,
"description": "The Argon2 amount of memory in kibibytes (parameter m) to be used.",
"maximum": 4294967295,
"minimum": 8,
"title": "Memory",
"type": "integer"
},
"parallelism": {
"default": 4,
"description": "The Argon2 degree of parallelism (parameter p) to be used.",
"maximum": 16777215,
"minimum": 1,
"title": "Parallelism",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The Argon2 salt length.",
"maximum": 2147483647,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "argon2id",
"description": "The Argon2 variant to be used.",
"enum": [
"argon2id",
"argon2i",
"argon2d"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordBCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.",
"properties": {
"cost": {
"default": 12,
"description": "The BCrypt cost to be used.",
"maximum": 31,
"minimum": 10,
"title": "Cost",
"type": "integer"
},
"variant": {
"default": "standard",
"description": "The BCrypt variant to be used.",
"enum": [
"standard",
"sha256"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordPBKDF2": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.",
"properties": {
"iterations": {
"default": 310000,
"description": "The PBKDF2 iterations to be used.",
"maximum": 2147483647,
"minimum": 100000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The PBKDF2 salt length to be used.",
"maximum": 2147483647,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The PBKDF2 variant to be used.",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSCrypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.",
"properties": {
"block_size": {
"default": 8,
"description": "The SCrypt block size to be used.",
"maximum": 36028797018963967,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"iterations": {
"default": 16,
"description": "The SCrypt iterations to be used.",
"maximum": 58,
"minimum": 1,
"title": "Iterations",
"type": "integer"
},
"key_length": {
"default": 32,
"description": "The SCrypt key length to be used.",
"maximum": 137438953440,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"parallelism": {
"default": 1,
"description": "The SCrypt parallelism factor to be used.",
"maximum": 1073741823,
"minimum": 1,
"title": "Key Length",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SCrypt salt length to be used.",
"maximum": 1024,
"minimum": 8,
"title": "Salt Length",
"type": "integer"
}
},
"type": "object"
},
"AuthenticationBackendFilePasswordSHA2Crypt": {
"additionalProperties": false,
"description": "AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.",
"properties": {
"iterations": {
"default": 50000,
"description": "The SHA2Crypt iterations (parameter rounds) to be used.",
"maximum": 999999999,
"minimum": 1000,
"title": "Iterations",
"type": "integer"
},
"salt_length": {
"default": 16,
"description": "The SHA2Crypt salt length to be used.",
"maximum": 16,
"minimum": 1,
"title": "Salt Length",
"type": "integer"
},
"variant": {
"default": "sha512",
"description": "The SHA2Crypt variant to be used.",
"enum": [
"sha256",
"sha512"
],
"title": "Variant",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendFileSearch": {
"additionalProperties": false,
"description": "AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.",
"properties": {
"case_insensitive": {
"default": false,
"description": "Allows usernames to be any case during the search.",
"title": "Case Insensitive Searching",
"type": "boolean"
},
"email": {
"default": false,
"description": "Allows users to either use their username or their configured email as a username.",
"title": "Email Searching",
"type": "boolean"
}
},
"type": "object"
},
"AuthenticationBackendLDAP": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAP represents the configuration related to LDAP server.",
"properties": {
"additional_groups_dn": {
"description": "The base in addition to the Base DN for all directory server operations for groups.",
"title": "Additional Group Base",
"type": "string"
},
"additional_users_dn": {
"description": "The base in addition to the Base DN for all directory server operations for users.",
"title": "Additional User Base",
"type": "string"
},
"address": {
"$ref": "#/$defs/AddressLDAP",
"description": "The address of the LDAP directory server.",
"title": "Address"
},
"attributes": {
"$ref": "#/$defs/AuthenticationBackendLDAPAttributes"
},
"base_dn": {
"description": "The base for all directory server operations.",
"title": "Base DN",
"type": "string"
},
"group_search_mode": {
"default": "filter",
"description": "The LDAP group search mode used to search for group objects.",
"enum": [
"filter",
"memberof"
],
"title": "Groups Search Mode",
"type": "string"
},
"groups_filter": {
"description": "The LDAP filter used to search for group objects.",
"title": "Groups Filter",
"type": "string"
},
"implementation": {
"default": "custom",
"description": "The implementation which mostly decides the default values.",
"enum": [
"custom",
"activedirectory",
"rfc2307bis",
"freeipa",
"lldap",
"glauth"
],
"title": "Implementation",
"type": "string"
},
"password": {
"description": "The password for LDAP authenticated binding.",
"title": "Password",
"type": "string"
},
"permit_feature_detection_failure": {
"default": false,
"description": "Enables failures when detecting directory server features using the Root DSE lookup.",
"title": "Permit Feature Detection Failure",
"type": "boolean"
},
"permit_referrals": {
"default": false,
"description": "Enables chasing LDAP referrals.",
"title": "Permit Referrals",
"type": "boolean"
},
"permit_unauthenticated_bind": {
"default": false,
"description": "Enables omission of the password to perform an unauthenticated bind.",
"title": "Permit Unauthenticated Bind",
"type": "boolean"
},
"start_tls": {
"default": false,
"description": "Enables the use of StartTLS.",
"title": "StartTLS",
"type": "boolean"
},
"timeout": {
"description": "The LDAP directory server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The LDAP directory server TLS connection properties.",
"title": "TLS"
},
"user": {
"description": "The user distinguished name for LDAP binding.",
"title": "User",
"type": "string"
},
"users_filter": {
"description": "The LDAP filter used to search for user objects.",
"title": "Users Filter",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendLDAPAttributes": {
"additionalProperties": false,
"description": "AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.",
"properties": {
"MemberOf": {
"description": "The directory server attribute which contains the objects that an object is a member of.",
"title": "Attribute: Member Of",
"type": "string"
},
"display_name": {
"description": "The directory server attribute which contains the display name for all users.",
"title": "Attribute: User Display Name",
"type": "string"
},
"distinguished_name": {
"description": "The directory server attribute which contains the distinguished name for all objects.",
"title": "Attribute: Distinguished Name",
"type": "string"
},
"group_name": {
"description": "The directory server attribute which contains the group name for all groups.",
"title": "Attribute: Group Name",
"type": "string"
},
"mail": {
"description": "The directory server attribute which contains the mail address for all users and groups.",
"title": "Attribute: User Mail",
"type": "string"
},
"username": {
"description": "The directory server attribute which contains the username for all users.",
"title": "Attribute: User Username",
"type": "string"
}
},
"type": "object"
},
"AuthenticationBackendPasswordReset": {
"additionalProperties": false,
"description": "AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.",
"properties": {
"custom_url": {
"description": "Disables the internal Password Reset option and instead redirects users to this specified URL.",
"format": "uri",
"title": "Custom URL",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the Password Reset option.",
"title": "Disable",
"type": "boolean"
}
},
"type": "object"
},
"Configuration": {
"additionalProperties": false,
"description": "Configuration object extracted from YAML configuration file.",
"properties": {
"access_control": {
"$ref": "#/$defs/AccessControl",
"description": "Access Control Configuration.",
"title": "Access Control"
},
"authentication_backend": {
"$ref": "#/$defs/AuthenticationBackend",
"description": "Authentication Backend Configuration.",
"title": "Authentication Backend"
},
"certificates_directory": {
"description": "The path to a directory which is used to determine the certificates that are trusted.",
"title": "Certificates Directory Path",
"type": "string"
},
"default_2fa_method": {
"description": "When a user logs in for the first time this is the 2FA method configured for them.",
"enum": [
"totp",
"webauthn",
"mobile_push"
],
"title": "Default 2FA method",
"type": "string"
},
"default_redirection_url": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"format": "uri",
"title": "The default redirection URL",
"type": "string"
},
"duo_api": {
"$ref": "#/$defs/DuoAPI",
"description": "Duo API Configuration.",
"title": "Duo API"
},
"identity_providers": {
"$ref": "#/$defs/IdentityProviders",
"description": "Identity Providers Configuration.",
"title": "Identity Providers"
},
"identity_validation": {
"$ref": "#/$defs/IdentityValidation",
"description": "Identity Validation Configuration.",
"title": "Identity Validation"
},
"log": {
"$ref": "#/$defs/Log",
"description": "Logging Configuration.",
"title": "Log"
},
"notifier": {
"$ref": "#/$defs/Notifier",
"description": "Notifier Configuration.",
"title": "Notifier"
},
"ntp": {
"$ref": "#/$defs/NTP",
"description": "Network Time Protocol Configuration.",
"title": "NTP"
},
"password_policy": {
"$ref": "#/$defs/PasswordPolicy",
"description": "Password Policy Configuration.",
"title": "Password Policy"
},
"privacy_policy": {
"$ref": "#/$defs/PrivacyPolicy",
"description": "Privacy Policy Configuration.",
"title": "Privacy Policy"
},
"regulation": {
"$ref": "#/$defs/Regulation",
"description": "Regulation Configuration.",
"title": "Regulation"
},
"server": {
"$ref": "#/$defs/Server",
"description": "Server Configuration.",
"title": "Server"
},
"session": {
"$ref": "#/$defs/Session",
"description": "Session Configuration.",
"title": "Session"
},
"storage": {
"$ref": "#/$defs/Storage",
"description": "Storage Configuration.",
"title": "Storage"
},
"telemetry": {
"$ref": "#/$defs/Telemetry",
"description": "Telemetry Configuration.",
"title": "Telemetry"
},
"theme": {
"default": "light",
"description": "The name of the theme to apply to the web UI.",
"enum": [
"auto",
"light",
"dark",
"grey"
],
"title": "Theme Name",
"type": "string"
},
"totp": {
"$ref": "#/$defs/TOTP",
"description": "Time-based One-Time Password Configuration.",
"title": "TOTP"
},
"webauthn": {
"$ref": "#/$defs/WebAuthn",
"description": "WebAuthn Configuration.",
"title": "WebAuthn"
}
},
"type": "object"
},
"DuoAPI": {
"additionalProperties": false,
"description": "DuoAPI represents the configuration related to Duo API.",
"properties": {
"disable": {
"default": false,
"description": "Disable the Duo API integration.",
"title": "Disable",
"type": "boolean"
},
"enable_self_enrollment": {
"default": false,
"description": "Enable the Self Enrollment flow.",
"title": "Enable Self Enrollment",
"type": "boolean"
},
"hostname": {
"description": "The Hostname provided by your Duo API dashboard.",
"format": "hostname",
"title": "Hostname",
"type": "string"
},
"integration_key": {
"description": "The Integration Key provided by your Duo API dashboard.",
"title": "Integration Key",
"type": "string"
},
"secret_key": {
"description": "The Secret Key provided by your Duo API dashboard.",
"title": "Secret Key",
"type": "string"
}
},
"type": "object"
},
"IdentityProviders": {
"additionalProperties": false,
"description": "IdentityProviders represents the Identity Providers configuration for Authelia.",
"properties": {
"oidc": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnect"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnect": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.",
"properties": {
"authorization_policies": {
"description": "Custom client authorization policies.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicy"
}
},
"title": "Authorization Policies",
"type": "object"
},
"clients": {
"description": "OpenID Connect 1.0 clients registry.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClient"
},
"title": "Clients",
"type": "array"
},
"cors": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectCORS",
"description": "Configuration options for Cross-Origin Request Sharing.",
"title": "CORS"
},
"discovery_signed_response_alg": {
"default": "none",
"description": "The Algorithm this provider uses to sign the Discovery and Metadata Document responses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Discovery Response Signing Algorithm",
"type": "string"
},
"discovery_signed_response_key_id": {
"description": "The Key ID this provider uses to sign the Discovery and Metadata Document responses (overrides the 'discovery_signed_response_alg').",
"title": "Discovery Response Signing Key ID",
"type": "string"
},
"enable_client_debug_messages": {
"default": false,
"description": "Enables additional debug messages for clients.",
"title": "Enable Client Debug Messages",
"type": "boolean"
},
"enable_jwt_access_token_stateless_introspection": {
"description": "Allows the use of stateless introspection of JWT Access Tokens which is not recommended.",
"title": "Enable JWT Access Token Stateless Introspection",
"type": "boolean"
},
"enable_pkce_plain_challenge": {
"default": false,
"description": "Enables use of the discouraged plain Proof Key for Code Exchange challenges.",
"title": "Enable PKCE Plain Challenge",
"type": "boolean"
},
"enforce_pkce": {
"default": "public_clients_only",
"description": "Controls enforcement of the use of Proof Key for Code Exchange on all clients.",
"enum": [
"public_clients_only",
"never",
"always"
],
"title": "Enforce PKCE",
"type": "string"
},
"hmac_secret": {
"description": "The HMAC Secret used to sign Access Tokens.",
"title": "HMAC Secret",
"type": "string"
},
"issuer_certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"deprecated": true,
"description": "The Issuer Certificate Chain with an RSA Public Key used to sign ID Tokens.",
"title": "Issuer Certificate Chain"
},
"issuer_private_key": {
"deprecated": true,
"description": "The Issuer Private Key with an RSA Private Key used to sign ID Tokens.",
"pattern": "^-{5}(BEGIN (RSA )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (RSA )?PRIVATE KEY-{5}\\n?)+$",
"title": "Issuer Private Key",
"type": "string"
},
"jwks": {
"description": "The JWK's which are to be used to sign various objects like ID Tokens.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "Issuer JSON Web Keys",
"type": "array"
},
"lifespans": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespans",
"description": "Token lifespans configuration.",
"title": "Lifespans"
},
"minimum_parameter_entropy": {
"default": 8,
"description": "The minimum entropy of the nonce parameter.",
"minimum": -1,
"title": "Minimum Parameter Entropy",
"type": "integer"
},
"require_pushed_authorization_requests": {
"description": "Requires Pushed Authorization Requests for all clients for this Issuer.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectCORS": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.",
"properties": {
"allowed_origins": {
"description": "List of arbitrary allowed origins for CORS requests.",
"items": {
"format": "uri",
"type": "string"
},
"title": "Allowed Origins",
"type": "array"
},
"allowed_origins_from_client_redirect_uris": {
"default": false,
"description": "Automatically include the redirect URIs from the registered clients.",
"title": "Allowed Origins From Client Redirect URIs",
"type": "boolean"
},
"endpoints": {
"description": "List of endpoints to enable CORS handling for.",
"items": {
"enum": [
"authorization",
"pushed-authorization-request",
"token",
"introspection",
"revocation",
"userinfo"
],
"type": "string"
},
"title": "Endpoints",
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectClient": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.",
"properties": {
"access_token_signed_response_alg": {
"default": "none",
"description": "The algorithm (JWA) this client uses to sign Access Tokens.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Access Token Signing Algorithm",
"type": "string"
},
"access_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign Access Tokens (overrides the 'access_token_signed_response_alg').",
"title": "Access Token Signing Key ID",
"type": "string"
},
"allow_multiple_auth_methods": {
"description": "Permits this registered client to accept misbehaving clients which use a broad authentication approach. This is not standards complaint, use at your own security risk.",
"title": "Allow Multiple Authentication Methods",
"type": "boolean"
},
"audience": {
"description": "List of authorized audiences.",
"items": {
"type": "string"
},
"title": "Audience",
"type": "array",
"uniqueItems": true
},
"authorization_policy": {
"description": "The Authorization Policy to apply to this client.",
"title": "Authorization Policy",
"type": "string"
},
"authorization_signed_response_alg": {
"default": "none",
"description": "The Authorization Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Authorization Response Signing Algorithm",
"type": "string"
},
"authorization_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Authorization responses (overrides the 'authorization_signed_response_alg').",
"title": "Authorization Response Signing Key ID",
"type": "string"
},
"client_id": {
"description": "The Client ID.",
"minLength": 1,
"title": "Client ID",
"type": "string"
},
"client_name": {
"description": "The Client Name displayed to End-Users.",
"title": "Client Name",
"type": "string"
},
"client_secret": {
"$ref": "#/$defs/PasswordDigest",
"description": "The Client Secret for Client Authentication.",
"title": "Client Secret"
},
"consent_mode": {
"description": "The Consent Mode used for this client.",
"enum": [
"auto",
"explicit",
"implicit",
"pre-configured"
],
"title": "Consent Mode",
"type": "string"
},
"grant_types": {
"description": "The Grant Types this client is allowed to use for the protected endpoints.",
"items": {
"enum": [
"authorization_code",
"implicit",
"refresh_token",
"client_credentials"
],
"type": "string"
},
"title": "Grant Types",
"type": "array",
"uniqueItems": true
},
"id_token_signed_response_alg": {
"default": "RS256",
"description": "The algorithm (JWA) this client uses to sign ID Tokens.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "ID Token Signing Algorithm",
"type": "string"
},
"id_token_signed_response_key_id": {
"description": "The Key ID this client uses to sign ID Tokens (overrides the 'id_token_signing_alg').",
"title": "ID Token Signing Key ID",
"type": "string"
},
"introspection_signed_response_alg": {
"default": "none",
"description": "The Introspection Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Introspection Response Signing Algorithm",
"type": "string"
},
"introspection_signed_response_key_id": {
"description": "The Key ID this client uses to sign the Introspection responses (overrides the 'introspection_signed_response_alg').",
"title": "Introspection Response Signing Key ID",
"type": "string"
},
"jwks": {
"description": "List of arbitrary Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"items": {
"$ref": "#/$defs/JWK"
},
"title": "JSON Web Keys",
"type": "array"
},
"jwks_uri": {
"description": "URI of the JWKS endpoint which contains the Public Keys used to validate request objects and the 'private_key_jwt' client authentication method for this client.",
"format": "uri",
"title": "JSON Web Keys URI",
"type": "string"
},
"lifespan": {
"description": "The name of the custom lifespan to utilize for this client.",
"title": "Lifespan Name",
"type": "string"
},
"pkce_challenge_method": {
"description": "The PKCE Challenge Method enforced on this client.",
"enum": [
"plain",
"S256"
],
"title": "PKCE Challenge Method",
"type": "string"
},
"pre_configured_consent_duration": {
"description": "The Pre-Configured Consent Duration when using Consent Mode pre-configured for this client.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Pre-Configured Consent Duration"
},
"public": {
"default": false,
"description": "Enables the Public Client Type.",
"title": "Public",
"type": "boolean"
},
"redirect_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientURIs",
"description": "List of whitelisted redirect URIs.",
"title": "Redirect URIs"
},
"request_object_signing_alg": {
"description": "The Request Object Signing Algorithm the provider accepts for this client.",
"enum": [
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Request Object Signing Algorithm",
"type": "string"
},
"request_uris": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectClientURIs",
"description": "List of whitelisted request URIs.",
"title": "Request URIs"
},
"requested_audience_mode": {
"description": "The Requested Audience Mode used for this client.",
"enum": [
"explicit",
"implicit"
],
"title": "Requested Audience Mode",
"type": "string"
},
"require_pkce": {
"default": false,
"description": "Requires a Proof Key for this client to perform Code Exchange.",
"title": "Require PKCE",
"type": "boolean"
},
"require_pushed_authorization_requests": {
"default": false,
"description": "Requires Pushed Authorization Requests for this client to perform an authorization.",
"title": "Require Pushed Authorization Requests",
"type": "boolean"
},
"response_modes": {
"description": "The Response Modes this client is authorized request.",
"items": {
"enum": [
"form_post",
"form_post.jwt",
"query",
"query.jwt",
"fragment",
"fragment.jwt",
"jwt"
],
"type": "string"
},
"title": "Response Modes",
"type": "array",
"uniqueItems": true
},
"response_types": {
"description": "The Response Types the client is authorized to request.",
"items": {
"enum": [
"code",
"id_token token",
"id_token",
"token",
"code token",
"code id_token",
"code id_token token"
],
"type": "string"
},
"title": "Response Types",
"type": "array",
"uniqueItems": true
},
"scopes": {
"description": "The Scopes this client is allowed request and be granted.",
"items": {
"enum": [
"openid",
"offline_access",
"groups",
"email",
"profile",
"authelia.bearer.authz"
],
"type": "string"
},
"title": "Scopes",
"type": "array",
"uniqueItems": true
},
"sector_identifier_uri": {
"description": "The Client Sector Identifier URI for Privacy Isolation via Pairwise subject types.",
"format": "uri",
"title": "Sector Identifier URI",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "The Token Endpoint Auth Method enforced by the provider for this client.",
"enum": [
"none",
"client_secret_post",
"client_secret_basic",
"private_key_jwt",
"client_secret_jwt"
],
"title": "Token Endpoint Auth Method",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "The Token Endpoint Auth Signing Algorithm the provider accepts for this client.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Token Endpoint Auth Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_alg": {
"default": "none",
"description": "The UserInfo Endpoint Signing Algorithm this client uses.",
"enum": [
"none",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "UserInfo Response Signing Algorithm",
"type": "string"
},
"userinfo_signed_response_key_id": {
"description": "The Key ID this client uses to sign the UserInfo responses (overrides the 'userinfo_signed_response_alg').",
"title": "UserInfo Response Signing Key ID",
"type": "string"
}
},
"required": [
"client_id",
"scopes"
],
"type": "object"
},
"IdentityProvidersOpenIDConnectClientURIs": {
"oneOf": [
{
"format": "uri",
"type": "string"
},
{
"items": {
"format": "uri",
"type": "string"
},
"type": "array",
"uniqueItems": true
}
]
},
"IdentityProvidersOpenIDConnectLifespan": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"grants": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanGrants",
"description": "Allows tuning the token lifespans for individual grant types.",
"title": "Grant Types"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanGrants": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.",
"properties": {
"authorize_code": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Authorize Code Grant"
},
"client_credentials": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the client credentials grant.",
"title": "Client Credentials Grant"
},
"implicit": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the implicit flow and grant.",
"title": "Implicit Grant"
},
"jwt_bearer": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the JWT bearer grant.",
"title": "JWT Bearer Grant"
},
"refresh_token": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespanToken",
"description": "Allows tuning the token lifespans for the refresh token grant.",
"title": "Refresh Token Grant"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespanToken": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.",
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectLifespans": {
"additionalProperties": false,
"properties": {
"access_token": {
"description": "The duration an Access Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Access Token Lifespan"
},
"authorize_code": {
"description": "The duration an Authorization Code is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Authorize Code Lifespan"
},
"custom": {
"description": "Allows creating custom lifespans to be used by individual clients.",
"patternProperties": {
".*": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectLifespan"
}
},
"title": "Custom Lifespans",
"type": "object"
},
"id_token": {
"description": "The duration an ID Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "ID Token Lifespan"
},
"jwt_secured_authorization": {
"description": "Allows tuning the token lifespan for the JWT Secured Authorization Response Mode (JARM).",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JARM"
},
"refresh_token": {
"description": "The duration a Refresh Token is valid for.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Refresh Token Lifespan"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicy": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.",
"properties": {
"default_policy": {
"description": "The default policy action for this policy.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Default Policy",
"type": "string"
},
"rules": {
"description": "The list of rules for this policy.",
"items": {
"$ref": "#/$defs/IdentityProvidersOpenIDConnectPolicyRule"
},
"title": "Rules",
"type": "array"
}
},
"type": "object"
},
"IdentityProvidersOpenIDConnectPolicyRule": {
"additionalProperties": false,
"description": "IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.",
"properties": {
"policy": {
"description": "The policy to apply to this rule.",
"enum": [
"one_factor",
"two_factor",
"deny"
],
"title": "Policy",
"type": "string"
},
"subject": {
"$ref": "#/$defs/AccessControlRuleSubjects",
"description": "Allows tuning the token lifespans for the authorize code grant.",
"title": "Subject"
}
},
"type": "object"
},
"IdentityValidation": {
"additionalProperties": false,
"description": "IdentityValidation represents the configuration for identity verification actions/flows.",
"properties": {
"elevated_session": {
"$ref": "#/$defs/IdentityValidationElevatedSession",
"description": "Identity Validation options for obtaining an Elevated Session for flows such as the Credential Management flows.",
"title": "Elevated Session"
},
"reset_password": {
"$ref": "#/$defs/IdentityValidationResetPassword",
"description": "Identity Validation options for the Reset Password flow.",
"title": "Reset Password"
}
},
"type": "object"
},
"IdentityValidationElevatedSession": {
"additionalProperties": false,
"description": "IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.",
"properties": {
"code_lifespan": {
"description": "The lifespan of the randomly generated One Time Code after which it's considered invalid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Code Lifespan"
},
"elevation_lifespan": {
"description": "The lifespan of the elevation after initially validating the One-Time Code before it expires.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Elevation Lifespan"
},
"otp_characters": {
"default": 8,
"description": "Number of characters in the generated OTP codes.",
"maximum": 12,
"minimum": 6,
"title": "OTP Characters",
"type": "integer"
},
"require_second_factor": {
"default": false,
"description": "Requires the user use a second factor if they have any known second factor methods.",
"title": "Require Second Factor",
"type": "boolean"
},
"skip_second_factor": {
"default": false,
"description": "Skips the primary identity verification process if the user has authenticated with a second factor.",
"title": "Skip Second Factor",
"type": "boolean"
}
},
"type": "object"
},
"IdentityValidationResetPassword": {
"additionalProperties": false,
"description": "IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.",
"properties": {
"jwt_algorithm": {
"default": "HS256",
"description": "The JSON Web Token Algorithm (JWA) used to sign the Reset Password flow JSON Web Token's.",
"enum": [
"HS256",
"HS384",
"HS512"
],
"title": "JWT Algorithm",
"type": "string"
},
"jwt_lifespan": {
"description": "The lifespan of the JSON Web Token after it's initially generated after which it's considered invalid.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "JWT Lifespan"
},
"jwt_secret": {
"description": "The secret key used to sign the Reset Password flow JSON Web Token's.",
"title": "JWT Secret",
"type": "string"
}
},
"type": "object"
},
"JWK": {
"additionalProperties": false,
"description": "JWK represents a JWK.",
"properties": {
"algorithm": {
"description": "The Algorithm of this JWK.",
"enum": [
"HS256",
"HS384",
"HS512",
"RS256",
"RS384",
"RS512",
"ES256",
"ES384",
"ES512",
"PS256",
"PS384",
"PS512"
],
"title": "Algorithm",
"type": "string"
},
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The optional associated certificate which matches the Key public key portion for this JWK.",
"title": "Certificate Chain"
},
"key": {
"description": "The Private/Public key material of this JWK in Base64 PEM format.",
"pattern": "^-{5}BEGIN (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END (((RSA|EC) )?(PRIVATE|PUBLIC) KEY|CERTIFICATE)-{5}\\n?$",
"type": "string"
},
"key_id": {
"description": "The ID of this JWK.",
"maxLength": 100,
"title": "Key ID",
"type": "string"
},
"use": {
"default": "sig",
"description": "The Use of this JWK.",
"enum": [
"sig"
],
"title": "Use",
"type": "string"
}
},
"type": "object"
},
"Log": {
"additionalProperties": false,
"description": "Log represents the logging configuration.",
"properties": {
"file_path": {
"description": "The File Path to save the logs to instead of sending them to stdout, it's strongly recommended this option is only enabled with 'keep_stdout' also enabled.",
"title": "File Path",
"type": "string"
},
"format": {
"description": "The Format of Log messages.",
"enum": [
"json",
"text"
],
"title": "Format",
"type": "string"
},
"keep_stdout": {
"default": false,
"description": "Enables keeping stdout when using the File Path option.",
"title": "Keep Stdout",
"type": "boolean"
},
"level": {
"description": "The minimum Level a Log message must be before it's added to the log.",
"enum": [
"error",
"warn",
"info",
"debug",
"trace"
],
"title": "Level",
"type": "string"
}
},
"type": "object"
},
"NTP": {
"additionalProperties": false,
"description": "NTP represents the configuration related to ntp server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressUDP",
"description": "The remote address of the NTP server.",
"title": "NTP Address"
},
"disable_failure": {
"default": false,
"description": "Disables complete failure whe the Startup Check fails and instead just logs the error.",
"title": "Disable Failure",
"type": "boolean"
},
"disable_startup_check": {
"default": false,
"description": "Disables the NTP Startup Check entirely.",
"title": "Disable Startup Check",
"type": "boolean"
},
"max_desync": {
"description": "The maximum amount of time that the server can be out of sync.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Maximum Desync"
},
"version": {
"description": "The NTP Version to use.",
"enum": [
3,
4
],
"title": "NTP Version",
"type": "integer"
}
},
"type": "object"
},
"Notifier": {
"additionalProperties": false,
"description": "Notifier represents the configuration of the notifier to use when sending notifications to users.",
"properties": {
"disable_startup_check": {
"default": false,
"description": "Disables the notifier startup checks.",
"title": "Disable Startup Check",
"type": "boolean"
},
"filesystem": {
"$ref": "#/$defs/NotifierFileSystem",
"description": "The File System notifier.",
"title": "File System"
},
"smtp": {
"$ref": "#/$defs/NotifierSMTP",
"description": "The SMTP notifier.",
"title": "SMTP"
},
"template_path": {
"description": "The path for notifier template overrides.",
"title": "Template Path",
"type": "string"
}
},
"type": "object"
},
"NotifierFileSystem": {
"additionalProperties": false,
"description": "NotifierFileSystem represents the configuration of the notifier writing emails in a file.",
"properties": {
"filename": {
"description": "The file path of the notifications.",
"title": "Filename",
"type": "string"
}
},
"type": "object"
},
"NotifierSMTP": {
"additionalProperties": false,
"description": "NotifierSMTP represents the configuration of the SMTP server to send emails with.",
"properties": {
"address": {
"$ref": "#/$defs/AddressSMTP",
"description": "The SMTP server address.",
"title": "Address"
},
"disable_html_emails": {
"default": false,
"description": "Disables the mixed content type of emails and only sends the plaintext version.",
"title": "Disable HTML Emails",
"type": "boolean"
},
"disable_require_tls": {
"default": false,
"description": "Disables the requirement to use TLS.",
"title": "Disable Require TLS",
"type": "boolean"
},
"disable_starttls": {
"default": false,
"description": "Disables the opportunistic StartTLS functionality which is useful for bad SMTP servers which advertise support for it but don't actually support it.",
"title": "Disable StartTLS",
"type": "boolean"
},
"host": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "string"
},
"identifier": {
"default": "localhost",
"description": "The identifier used during the HELO/EHLO command.",
"title": "Identifier",
"type": "string"
},
"password": {
"description": "The password for SMTP authentication.",
"title": "Password",
"type": "string"
},
"port": {
"deprecated": true,
"description": "Deprecated: use address instead.",
"type": "integer"
},
"sender": {
"description": "The sender used for SMTP.",
"format": "email",
"title": "Sender",
"type": "string"
},
"startup_check_address": {
"default": "Authelia Test <[email protected]>",
"description": "The address used for the recipient in the startup check.",
"format": "email",
"title": "Startup Check Address",
"type": "string"
},
"subject": {
"default": "[Authelia] {title}",
"description": "The subject format used.",
"title": "Subject",
"type": "string"
},
"timeout": {
"description": "The SMTP server connection timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS",
"description": "The SMTP server TLS connection properties.",
"title": "TLS"
},
"username": {
"description": "The username for SMTP authentication.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"PasswordDigest": {
"pattern": "^\\$((argon2(id|i|d)\\$v=19\\$m=\\d+,t=\\d+,p=\\d+|scrypt\\$ln=\\d+,r=\\d+,p=\\d+)\\$[a-zA-Z0-9\\/+]+\\$[a-zA-Z0-9\\/+]+|pbkdf2(-sha(224|256|384|512))?\\$\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|bcrypt-sha256\\$v=2,t=2b,r=\\d+\\$[a-zA-Z0-9\\/.]+\\$[a-zA-Z0-9\\/.]+|2(a|b|y)?\\$\\d+\\$[a-zA-Z0-9.\\/]+|(5|6)\\$rounds=\\d+\\$[a-zA-Z0-9.\\/]+\\$[a-zA-Z0-9.\\/]+|plaintext\\$.+|base64\\$[a-zA-Z0-9.=\\/]+)$",
"type": "string"
},
"PasswordPolicy": {
"additionalProperties": false,
"description": "PasswordPolicy represents the configuration related to password policy.",
"properties": {
"standard": {
"$ref": "#/$defs/PasswordPolicyStandard",
"description": "The standard password policy engine.",
"title": "Standard"
},
"zxcvbn": {
"$ref": "#/$defs/PasswordPolicyZXCVBN",
"description": "The ZXCVBN password policy engine.",
"title": "ZXCVBN"
}
},
"type": "object"
},
"PasswordPolicyStandard": {
"additionalProperties": false,
"description": "PasswordPolicyStandard represents the configuration related to standard parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the standard password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"max_length": {
"default": 8,
"description": "Maximum password length.",
"title": "Maximum Length",
"type": "integer"
},
"min_length": {
"description": "Minimum password length.",
"title": "Minimum Length",
"type": "integer"
},
"require_lowercase": {
"default": false,
"description": "Require lowercase characters.",
"title": "Require Lowercase",
"type": "boolean"
},
"require_number": {
"default": false,
"description": "Require numeric characters.",
"title": "Require Number",
"type": "boolean"
},
"require_special": {
"default": false,
"description": "Require symbolic characters.",
"title": "Require Special",
"type": "boolean"
},
"require_uppercase": {
"default": false,
"description": "Require uppercase characters.",
"title": "Require Uppercase",
"type": "boolean"
}
},
"type": "object"
},
"PasswordPolicyZXCVBN": {
"additionalProperties": false,
"description": "PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the ZXCVBN password policy engine.",
"title": "Enabled",
"type": "boolean"
},
"min_score": {
"default": 3,
"description": "The minimum ZXCVBN score allowed.",
"title": "Minimum Score",
"type": "integer"
}
},
"type": "object"
},
"PrivacyPolicy": {
"additionalProperties": false,
"description": "PrivacyPolicy is the privacy policy configuration.",
"properties": {
"enabled": {
"default": false,
"description": "Enables the Privacy Policy functionality.",
"title": "Enabled",
"type": "boolean"
},
"policy_url": {
"description": "The URL of the privacy policy.",
"format": "uri",
"title": "Policy URL",
"type": "string"
},
"require_user_acceptance": {
"default": false,
"description": "Enables the requirement for users to accept the policy.",
"title": "Require User Acceptance",
"type": "boolean"
}
},
"type": "object"
},
"RefreshIntervalDuration": {
"default": "5 minutes",
"oneOf": [
{
"enum": [
"always",
"never"
],
"type": "string"
},
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"Regulation": {
"additionalProperties": false,
"description": "Regulation represents the configuration related to regulation.",
"properties": {
"ban_time": {
"description": "The amount of time to ban the user for when it's determined the maximum retries has been exceeded.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Ban Time"
},
"find_time": {
"description": "The amount of time to consider when determining the number of failed attempts.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Find Time"
},
"max_retries": {
"default": 3,
"description": "The maximum number of failed attempts permitted before banning a user.",
"title": "Maximum Retries",
"type": "integer"
}
},
"type": "object"
},
"Server": {
"additionalProperties": false,
"description": "Server represents the configuration of the http server.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address to listen on.",
"title": "Address"
},
"asset_path": {
"description": "The directory where the server asset overrides reside.",
"title": "Asset Path",
"type": "string"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration.",
"title": "Buffers"
},
"disable_healthcheck": {
"default": false,
"description": "Disables the healthcheck functionality.",
"title": "Disable Healthcheck",
"type": "boolean"
},
"endpoints": {
"$ref": "#/$defs/ServerEndpoints",
"description": "The server endpoints configuration.",
"title": "Endpoints"
},
"headers": {
"$ref": "#/$defs/ServerHeaders",
"description": "The server headers configuration.",
"title": "Headers"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration.",
"title": "Timeouts"
},
"tls": {
"$ref": "#/$defs/ServerTLS",
"description": "The server TLS configuration.",
"title": "TLS"
}
},
"type": "object"
},
"ServerBuffers": {
"additionalProperties": false,
"description": "ServerBuffers represents server buffer configurations.",
"properties": {
"read": {
"default": 4096,
"description": "The read buffer size.",
"title": "Read",
"type": "integer"
},
"write": {
"default": 4096,
"description": "The write buffer size.",
"title": "Write",
"type": "integer"
}
},
"type": "object"
},
"ServerEndpoints": {
"additionalProperties": false,
"description": "ServerEndpoints is the endpoints configuration for the HTTP server.",
"properties": {
"authz": {
"description": "Configures the Authorization endpoints.",
"patternProperties": {
".*": {
"$ref": "#/$defs/ServerEndpointsAuthz"
}
},
"title": "Authz",
"type": "object"
},
"enable_expvars": {
"default": false,
"description": "Enables the developer specific ExpVars endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable ExpVars",
"type": "boolean"
},
"enable_pprof": {
"default": false,
"description": "Enables the developer specific pprof endpoints which should not be used in production and only used for debugging purposes.",
"title": "Enable PProf",
"type": "boolean"
}
},
"type": "object"
},
"ServerEndpointsAuthz": {
"additionalProperties": false,
"description": "ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.",
"properties": {
"authn_strategies": {
"description": "The specific Authorization strategies to use for this endpoint.",
"items": {
"$ref": "#/$defs/ServerEndpointsAuthzAuthnStrategy"
},
"title": "Authn Strategies",
"type": "array"
},
"implementation": {
"description": "The specific Authorization implementation to use for this endpoint.",
"enum": [
"ForwardAuth",
"AuthRequest",
"ExtAuthz",
"Legacy"
],
"title": "Implementation",
"type": "string"
}
},
"type": "object"
},
"ServerEndpointsAuthzAuthnStrategy": {
"additionalProperties": false,
"description": "ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.",
"properties": {
"name": {
"description": "The name of the Authorization strategy to use.",
"enum": [
"HeaderAuthorization",
"HeaderProxyAuthorization",
"HeaderAuthRequestProxyAuthorization",
"HeaderLegacy",
"CookieSession"
],
"title": "Name",
"type": "string"
},
"schemes": {
"default": [
"basic"
],
"description": "The name of the authorization schemes to allow with the header strategies.",
"items": {
"enum": [
"basic",
"bearer"
],
"type": "string"
},
"title": "Authorization Schemes",
"type": "array"
}
},
"type": "object"
},
"ServerHeaders": {
"additionalProperties": false,
"description": "ServerHeaders represents the customization of the http server headers.",
"properties": {
"csp_template": {
"default": "default-src 'self'; frame-src 'none'; object-src 'none'; style-src 'self' 'nonce-%s'; frame-ancestors 'none'; base-uri 'self'",
"description": "The Content Security Policy template.",
"title": "CSP Template",
"type": "string"
}
},
"type": "object"
},
"ServerTLS": {
"additionalProperties": false,
"description": "ServerTLS represents the configuration of the http servers TLS options.",
"properties": {
"certificate": {
"description": "Path to the Certificate.",
"title": "Certificate",
"type": "string"
},
"client_certificates": {
"description": "Path to the Client Certificates to trust for mTLS.",
"items": {
"type": "string"
},
"title": "Client Certificates",
"type": "array",
"uniqueItems": true
},
"key": {
"description": "Path to the Private Key.",
"title": "Key",
"type": "string"
}
},
"type": "object"
},
"ServerTimeouts": {
"additionalProperties": false,
"description": "ServerTimeouts represents server timeout configurations.",
"properties": {
"idle": {
"description": "The idle timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Idle"
},
"read": {
"description": "The read timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Read"
},
"write": {
"description": "The write timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Write"
}
},
"type": "object"
},
"Session": {
"additionalProperties": false,
"description": "Session represents the configuration related to user sessions.",
"properties": {
"cookies": {
"description": "List of cookie domain configurations.",
"items": {
"$ref": "#/$defs/SessionCookie"
},
"title": "Cookies",
"type": "array"
},
"domain": {
"deprecated": true,
"description": "Deprecated: Use the session cookies option with the same name instead.",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"redis": {
"$ref": "#/$defs/SessionRedis",
"description": "Redis Session Provider configuration.",
"title": "Redis"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
},
"secret": {
"description": "Secret used to encrypt the session data.",
"title": "Secret",
"type": "string"
}
},
"type": "object"
},
"SessionCookie": {
"additionalProperties": false,
"description": "SessionCookie represents the configuration for a cookie domain.",
"properties": {
"authelia_url": {
"description": "The Root Authelia URL to redirect users to for this session cookie configuration.",
"format": "uri",
"title": "Authelia URL",
"type": "string"
},
"default_redirection_url": {
"description": "The default redirection URL for this session cookie configuration.",
"format": "uri",
"title": "Default Redirection URL",
"type": "string"
},
"domain": {
"description": "The domain for this session cookie configuration.",
"format": "hostname",
"title": "Domain",
"type": "string"
},
"expiration": {
"description": "The session cookie expiration when remember me is not checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"inactivity": {
"description": "The session inactivity timeout.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"name": {
"default": "authelia_session",
"description": "The session cookie name.",
"type": "string"
},
"remember_me": {
"description": "The session cookie expiration when remember me is checked.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
]
},
"same_site": {
"default": "lax",
"description": "The session cookie same site value.",
"enum": [
"lax",
"strict",
"none"
],
"type": "string"
}
},
"type": "object"
},
"SessionRedis": {
"additionalProperties": false,
"description": "SessionRedis represents the configuration related to redis session store.",
"properties": {
"database_index": {
"default": 0,
"description": "The redis database index.",
"title": "Database Index",
"type": "integer"
},
"high_availability": {
"$ref": "#/$defs/SessionRedisHighAvailability"
},
"host": {
"description": "The redis server host.",
"title": "Host",
"type": "string"
},
"maximum_active_connections": {
"default": 8,
"description": "The maximum connections that can be made to redis at one time.",
"title": "Maximum Active Connections",
"type": "integer"
},
"minimum_idle_connections": {
"description": "The minimum idle connections that should be open to redis.",
"title": "Minimum Idle Connections",
"type": "integer"
},
"password": {
"description": "The redis password.",
"title": "Password",
"type": "string"
},
"port": {
"default": 6379,
"description": "The redis server port.",
"title": "Host",
"type": "integer"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The redis username.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailability": {
"additionalProperties": false,
"description": "SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.",
"properties": {
"nodes": {
"description": "The pre-populated list of nodes for the sentinel instance.",
"items": {
"$ref": "#/$defs/SessionRedisHighAvailabilityNode"
},
"title": "Nodes",
"type": "array"
},
"route_by_latency": {
"default": false,
"description": "Uses the Route by Latency mode.",
"title": "Route by Latency",
"type": "boolean"
},
"route_randomly": {
"default": false,
"description": "Uses the Route Randomly mode.",
"title": "Route Randomly",
"type": "boolean"
},
"sentinel_name": {
"description": "The name of the sentinel instance.",
"title": "Sentinel Name",
"type": "string"
},
"sentinel_password": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
},
"sentinel_username": {
"description": "The username for the sentinel instance.",
"title": "Sentinel Username",
"type": "string"
}
},
"type": "object"
},
"SessionRedisHighAvailabilityNode": {
"additionalProperties": false,
"description": "SessionRedisHighAvailabilityNode Represents a Node.",
"properties": {
"host": {
"description": "The redis sentinel node host.",
"title": "Host",
"type": "string"
},
"port": {
"default": 26379,
"description": "The redis sentinel node port.",
"title": "Port",
"type": "integer"
}
},
"type": "object"
},
"Storage": {
"additionalProperties": false,
"description": "Storage represents the configuration of the storage backend.",
"properties": {
"encryption_key": {
"description": "The Storage Encryption Key used to secure security sensitive values in the storage engine.",
"title": "Encryption Key",
"type": "string"
},
"local": {
"$ref": "#/$defs/StorageLocal",
"description": "The Local SQLite3 Storage configuration settings.",
"title": "Local"
},
"mysql": {
"$ref": "#/$defs/StorageMySQL",
"description": "The MySQL/MariaDB Storage configuration settings.",
"title": "MySQL"
},
"postgres": {
"$ref": "#/$defs/StoragePostgreSQL",
"description": "The PostgreSQL Storage configuration settings.",
"title": "PostgreSQL"
}
},
"type": "object"
},
"StorageLocal": {
"additionalProperties": false,
"description": "StorageLocal represents the configuration when using local storage.",
"properties": {
"path": {
"description": "The Path for the SQLite3 database file.",
"title": "Path",
"type": "string"
}
},
"type": "object"
},
"StorageMySQL": {
"additionalProperties": false,
"description": "StorageMySQL represents the configuration of a MySQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQL": {
"additionalProperties": false,
"description": "StoragePostgreSQL represents the configuration of a PostgreSQL database.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address of the database.",
"title": "Address"
},
"database": {
"description": "The database name to use upon a successful connection.",
"title": "Database",
"type": "string"
},
"password": {
"description": "The password to use to authenticate.",
"title": "Password",
"type": "string"
},
"schema": {
"default": "public",
"description": "The default schema name to use.",
"title": "Schema",
"type": "string"
},
"ssl": {
"$ref": "#/$defs/StoragePostgreSQLSSL",
"deprecated": true,
"description": "Deprecated: Use the TLS configuration instead.",
"title": "SSL"
},
"timeout": {
"description": "The timeout for the database connection.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"tls": {
"$ref": "#/$defs/TLS"
},
"username": {
"description": "The username to use to authenticate.",
"title": "Username",
"type": "string"
}
},
"type": "object"
},
"StoragePostgreSQLSSL": {
"additionalProperties": false,
"description": "StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.",
"properties": {
"certificate": {
"deprecated": true,
"description": "Path to the Certificate to use, deprecated and replaced with the TLS options.",
"title": "Certificate",
"type": "string"
},
"key": {
"deprecated": true,
"description": "Path to the Private Key to use, deprecated and replaced with the TLS options.",
"title": "Key",
"type": "string"
},
"mode": {
"deprecated": true,
"description": "The SSL mode to use, deprecated and replaced with the TLS options.",
"enum": [
"disable",
"verify-ca",
"require",
"verify-full"
],
"title": "Mode",
"type": "string"
},
"root_certificate": {
"deprecated": true,
"description": "Path to the Root Certificate to use, deprecated and replaced with the TLS options.",
"title": "Root Certificate",
"type": "string"
}
},
"type": "object"
},
"TLS": {
"additionalProperties": false,
"description": "TLS is a representation of the TLS configuration.",
"properties": {
"certificate_chain": {
"$ref": "#/$defs/X509CertificateChain",
"description": "The certificate chain.",
"title": "Certificate Chain"
},
"maximum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The maximum TLS version accepted.",
"title": "Maximum Version"
},
"minimum_version": {
"$ref": "#/$defs/TLSVersion",
"description": "The minimum TLS version accepted.",
"title": "Minimum Version"
},
"private_key": {
"description": "The private key.",
"pattern": "^-{5}BEGIN ((RSA|EC) )?PRIVATE KEY-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END ((RSA|EC) )?PRIVATE KEY-{5}\\n?$",
"title": "Private Key",
"type": "string"
},
"server_name": {
"description": "The expected server name to match the certificate against.",
"format": "hostname",
"title": "Server Name",
"type": "string"
},
"skip_verify": {
"default": false,
"description": "Disable all verification of the TLS properties.",
"title": "Skip Verify",
"type": "boolean"
}
},
"type": "object"
},
"TLSVersion": {
"enum": [
"TLS1.0",
"TLS1.1",
"TLS1.2",
"TLS1.3"
],
"type": "string"
},
"TOTP": {
"additionalProperties": false,
"description": "TOTP represents the configuration related to TOTP options.",
"properties": {
"algorithm": {
"default": "SHA1",
"description": "The algorithm value for generated TOTP keys.",
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"title": "Algorithm",
"type": "string"
},
"allowed_algorithms": {
"default": [
"SHA1"
],
"description": "List of algorithms the user is allowed to select in addition to the default.",
"items": {
"enum": [
"SHA1",
"SHA256",
"SHA512"
],
"type": "string"
},
"title": "Allowed Algorithms",
"type": "array"
},
"allowed_digits": {
"default": [
6
],
"description": "List of digits the user is allowed to select in addition to the default.",
"items": {
"enum": [
6,
8
],
"type": "integer"
},
"title": "Allowed Digits",
"type": "array"
},
"allowed_periods": {
"default": [
30
],
"description": "List of periods the user is allowed to select in addition to the default.",
"items": {
"type": "integer"
},
"title": "Allowed Periods",
"type": "array"
},
"digits": {
"default": 6,
"description": "The digits value for generated TOTP keys.",
"enum": [
6,
8
],
"title": "Digits",
"type": "integer"
},
"disable": {
"default": false,
"description": "Disables the TOTP 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"disable_reuse_security_policy": {
"default": false,
"description": "Disables the security policy that prevents reuse of a TOTP code.",
"title": "Disable Reuse Security Policy",
"type": "boolean"
},
"issuer": {
"default": "Authelia",
"description": "The issuer value for generated TOTP keys.",
"title": "Issuer",
"type": "string"
},
"period": {
"default": 30,
"description": "The period value for generated TOTP keys.",
"title": "Period",
"type": "integer"
},
"secret_size": {
"default": 32,
"description": "The secret size for generated TOTP keys.",
"minimum": 20,
"title": "Secret Size",
"type": "integer"
},
"skew": {
"default": 1,
"description": "The permitted skew for generated TOTP keys.",
"title": "Skew",
"type": "integer"
}
},
"type": "object"
},
"Telemetry": {
"additionalProperties": false,
"description": "Telemetry represents the telemetry config.",
"properties": {
"metrics": {
"$ref": "#/$defs/TelemetryMetrics",
"description": "The telemetry metrics server configuration.",
"title": "Metrics"
}
},
"type": "object"
},
"TelemetryMetrics": {
"additionalProperties": false,
"description": "TelemetryMetrics represents the telemetry metrics config.",
"properties": {
"address": {
"$ref": "#/$defs/AddressTCP",
"description": "The address for the metrics server to listen on.",
"title": "Address"
},
"buffers": {
"$ref": "#/$defs/ServerBuffers",
"description": "The server buffers configuration for the metrics server.",
"title": "Buffers"
},
"enabled": {
"default": false,
"description": "Enables the metrics server.",
"title": "Enabled",
"type": "boolean"
},
"timeouts": {
"$ref": "#/$defs/ServerTimeouts",
"description": "The server timeouts configuration for the metrics server.",
"title": "Timeouts"
}
},
"type": "object"
},
"WebAuthn": {
"additionalProperties": false,
"description": "WebAuthn represents the webauthn config.",
"properties": {
"attestation_conveyance_preference": {
"default": "indirect",
"description": "The default conveyance preference for all WebAuthn credentials.",
"enum": [
"none",
"indirect",
"direct"
],
"title": "Conveyance Preference",
"type": "string"
},
"disable": {
"default": false,
"description": "Disables the WebAuthn 2FA functionality.",
"title": "Disable",
"type": "boolean"
},
"display_name": {
"default": "Authelia",
"description": "The display name attribute for the WebAuthn relying party.",
"title": "Display Name",
"type": "string"
},
"timeout": {
"description": "The default timeout for all WebAuthn ceremonies.",
"oneOf": [
{
"pattern": "^\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?))(\\s*\\d+\\s*(y|M|w|d|h|m|s|ms|((year|month|week|day|hour|minute|second|millisecond)s?)))*$",
"type": "string"
},
{
"description": "The duration in seconds",
"type": "integer"
}
],
"title": "Timeout"
},
"user_verification": {
"default": "preferred",
"description": "The default user verification preference for all WebAuthn credentials.",
"enum": [
"discouraged",
"preferred",
"required"
],
"title": "User Verification",
"type": "string"
}
},
"type": "object"
},
"X509CertificateChain": {
"pattern": "^(-{5}BEGIN CERTIFICATE-{5}\\n([a-zA-Z0-9\\/+]{1,64}\\n)+([a-zA-Z0-9\\/+]{1,64}[=]{0,2})\\n-{5}END CERTIFICATE-{5}\\n?)+$",
"type": "string"
}
},
"$id": "https://www.authelia.com/schemas/v4.39/json-schema/configuration.json",
"$ref": "#/$defs/Configuration",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
authelia/authelia | f89778272cd35ffd7afae036c1eccbbecba19144 | 2024-03-04T09:29:12 | docs/static/schemas/v4.38/json-schema/exports.webauthn.json | 20,080 | 2024-05-28T05:33:51.266413Z | {
"$defs": {
"WebAuthnCredentialData": {
"additionalProperties": false,
"properties": {
"aaguid": {
"description": "The Authenticator Attestation Global Unique Identifier of this credential",
"title": "AAGUID",
"type": "string"
},
"attachment": {
"description": "The last recorded credential attachment type",
"title": "Attachment",
"type": "string"
},
"attestation_type": {
"description": "The attestation format type this credential uses",
"title": "Attestation Type",
"type": "string"
},
"backup_eligible": {
"description": "The backup eligible status of this credential",
"title": "Backup Eligible",
"type": "boolean"
},
"backup_state": {
"description": "The backup eligible status of this credential",
"title": "Backup Eligible",
"type": "boolean"
},
"clone_warning": {
"description": "The clone warning status of the credential",
"title": "Clone Warning",
"type": "boolean"
},
"created_at": {
"description": "The time this credential was created",
"format": "date-time",
"title": "Created At",
"type": "string"
},
"description": {
"description": "The user description of this credential",
"title": "Description",
"type": "string"
},
"discoverable": {
"description": "The discoverable status of this credential",
"title": "Discoverable",
"type": "boolean"
},
"id": {
"type": "integer"
},
"kid": {
"description": "The Public Key ID of this credential",
"title": "Public Key ID",
"type": "string"
},
"last_used_at": {
"description": "The last time this credential was used",
"format": "date-time",
"title": "Last Used At",
"type": "string"
},
"legacy": {
"description": "The legacy value indicates this credential may need to be registered again",
"title": "Legacy",
"type": "boolean"
},
"present": {
"description": "The user presence status of this credential",
"title": "Present",
"type": "boolean"
},
"public_key": {
"description": "The credential public key",
"title": "Public Key",
"type": "string"
},
"rpid": {
"description": "The Relying Party ID used to register this credential",
"title": "Relying Party ID",
"type": "string"
},
"sign_count": {
"description": "The last recorded credential sign count",
"title": "Sign Count",
"type": "integer"
},
"transports": {
"description": "The last recorded credential transports",
"items": {
"type": "string"
},
"title": "Transports",
"type": "array"
},
"username": {
"description": "The username of the user this credential belongs to",
"title": "Username",
"type": "string"
},
"verified": {
"description": "The verified status of this credential",
"title": "Verified",
"type": "boolean"
}
},
"type": "object"
},
"WebAuthnCredentialDataExport": {
"additionalProperties": false,
"properties": {
"webauthn_credentials": {
"description": "The list of WebAuthn credentials",
"items": {
"$ref": "#/$defs/WebAuthnCredentialData"
},
"title": "WebAuthn Credentials",
"type": "array"
}
},
"type": "object"
}
},
"$id": "https://www.authelia.com/schemas/v4.38/json-schema/exports.webauthn.json",
"$ref": "#/$defs/WebAuthnCredentialDataExport",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
onflow/flow-cli | e11b589a383b81f19a605394192666e27b67810e | 2024-01-26T00:04:18 | flowkit/schema.json | 204 | 2024-05-28T05:21:06.066526Z | {
"$defs": {
"account": {
"oneOf": [
{
"$ref": "#/$defs/simpleAccount"
},
{
"$ref": "#/$defs/advancedAccount"
},
{
"$ref": "#/$defs/simpleAccountPre022"
},
{
"$ref": "#/$defs/advanceAccountPre022"
}
]
},
"advanceAccountPre022": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"keys": {
"items": {
"$ref": "#/$defs/advanceKey"
},
"type": "array"
}
},
"required": [
"address",
"keys"
],
"type": "object"
},
"advanceKey": {
"additionalProperties": false,
"properties": {
"context": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"derivationPath": {
"type": "string"
},
"hashAlgorithm": {
"type": "string"
},
"index": {
"type": "integer"
},
"location": {
"type": "string"
},
"mnemonic": {
"type": "string"
},
"privateKey": {
"type": "string"
},
"resourceID": {
"type": "string"
},
"signatureAlgorithm": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"advancedAccount": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"key": {
"$ref": "#/$defs/advanceKey"
}
},
"required": [
"address",
"key"
],
"type": "object"
},
"advancedNetwork": {
"additionalProperties": false,
"properties": {
"host": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"host",
"key"
],
"type": "object"
},
"contractDeployment": {
"additionalProperties": false,
"properties": {
"args": {
"items": {
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"args"
],
"type": "object"
},
"deployment": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/contractDeployment"
}
]
},
"jsonAccounts": {
"patternProperties": {
".*": {
"$ref": "#/$defs/account"
}
},
"type": "object"
},
"jsonConfig": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/jsonAccounts"
},
"contracts": {
"$ref": "#/$defs/jsonContracts"
},
"dependencies": {
"$ref": "#/$defs/jsonDependencies"
},
"deployments": {
"$ref": "#/$defs/jsonDeployments"
},
"emulators": {
"$ref": "#/$defs/jsonEmulators"
},
"networks": {
"$ref": "#/$defs/jsonNetworks"
}
},
"type": "object"
},
"jsonContract": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/jsonContractAdvanced"
}
]
},
"jsonContractAdvanced": {
"additionalProperties": false,
"properties": {
"aliases": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"source": {
"type": "string"
}
},
"required": [
"source",
"aliases"
],
"type": "object"
},
"jsonContracts": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonContract"
}
},
"type": "object"
},
"jsonDependencies": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonDependency"
}
},
"type": "object"
},
"jsonDependency": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/jsonDependencyExtended"
}
]
},
"jsonDependencyExtended": {
"additionalProperties": false,
"properties": {
"aliases": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"hash": {
"type": "string"
},
"source": {
"type": "string"
}
},
"required": [
"source",
"hash",
"aliases"
],
"type": "object"
},
"jsonDeployment": {
"patternProperties": {
".*": {
"items": {
"$ref": "#/$defs/deployment"
},
"type": "array"
}
},
"type": "object"
},
"jsonDeployments": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonDeployment"
}
},
"type": "object"
},
"jsonEmulator": {
"additionalProperties": false,
"properties": {
"port": {
"type": "integer"
},
"serviceAccount": {
"type": "string"
}
},
"required": [
"port",
"serviceAccount"
],
"type": "object"
},
"jsonEmulators": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonEmulator"
}
},
"type": "object"
},
"jsonNetwork": {
"oneOf": [
{
"$ref": "#/$defs/simpleNetwork"
},
{
"$ref": "#/$defs/advancedNetwork"
}
]
},
"jsonNetworks": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonNetwork"
}
},
"type": "object"
},
"simpleAccount": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"address",
"key"
],
"type": "object"
},
"simpleAccountPre022": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"keys": {
"type": "string"
}
},
"required": [
"address",
"keys"
],
"type": "object"
},
"simpleNetwork": {
"type": "string"
}
},
"$id": "https://github.com/onflow/flow-cli/flowkit/config/json/json-config",
"$ref": "#/$defs/jsonConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
onflow/flow-cli | 64cb973d38f5e1bb5bdbae44b1fc46b9162c85e1 | 2024-01-02T22:34:29 | flowkit/schema.json | 204 | 2024-05-28T05:21:06.066526Z | {
"$defs": {
"account": {
"oneOf": [
{
"$ref": "#/$defs/simpleAccount"
},
{
"$ref": "#/$defs/advancedAccount"
},
{
"$ref": "#/$defs/simpleAccountPre022"
},
{
"$ref": "#/$defs/advanceAccountPre022"
}
]
},
"advanceAccountPre022": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"keys": {
"items": {
"$ref": "#/$defs/advanceKey"
},
"type": "array"
}
},
"required": [
"address",
"keys"
],
"type": "object"
},
"advanceKey": {
"additionalProperties": false,
"properties": {
"context": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"derivationPath": {
"type": "string"
},
"hashAlgorithm": {
"type": "string"
},
"index": {
"type": "integer"
},
"location": {
"type": "string"
},
"mnemonic": {
"type": "string"
},
"privateKey": {
"type": "string"
},
"resourceID": {
"type": "string"
},
"signatureAlgorithm": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"advancedAccount": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"key": {
"$ref": "#/$defs/advanceKey"
}
},
"required": [
"address",
"key"
],
"type": "object"
},
"advancedNetwork": {
"additionalProperties": false,
"properties": {
"host": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"host",
"key"
],
"type": "object"
},
"contractDeployment": {
"additionalProperties": false,
"properties": {
"args": {
"items": {
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"args"
],
"type": "object"
},
"deployment": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/contractDeployment"
}
]
},
"jsonAccounts": {
"patternProperties": {
".*": {
"$ref": "#/$defs/account"
}
},
"type": "object"
},
"jsonConfig": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/jsonAccounts"
},
"contracts": {
"$ref": "#/$defs/jsonContracts"
},
"dependencies": {
"$ref": "#/$defs/jsonDependencies"
},
"deployments": {
"$ref": "#/$defs/jsonDeployments"
},
"emulators": {
"$ref": "#/$defs/jsonEmulators"
},
"networks": {
"$ref": "#/$defs/jsonNetworks"
}
},
"type": "object"
},
"jsonContract": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/jsonContractAdvanced"
}
]
},
"jsonContractAdvanced": {
"additionalProperties": false,
"properties": {
"aliases": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"source": {
"type": "string"
}
},
"required": [
"source",
"aliases"
],
"type": "object"
},
"jsonContracts": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonContract"
}
},
"type": "object"
},
"jsonDependencies": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonDependency"
}
},
"type": "object"
},
"jsonDependency": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/jsonDependencyExtended"
}
]
},
"jsonDependencyExtended": {
"additionalProperties": false,
"properties": {
"aliases": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"remoteSource": {
"type": "string"
}
},
"required": [
"remoteSource",
"aliases"
],
"type": "object"
},
"jsonDeployment": {
"patternProperties": {
".*": {
"items": {
"$ref": "#/$defs/deployment"
},
"type": "array"
}
},
"type": "object"
},
"jsonDeployments": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonDeployment"
}
},
"type": "object"
},
"jsonEmulator": {
"additionalProperties": false,
"properties": {
"port": {
"type": "integer"
},
"serviceAccount": {
"type": "string"
}
},
"required": [
"port",
"serviceAccount"
],
"type": "object"
},
"jsonEmulators": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonEmulator"
}
},
"type": "object"
},
"jsonNetwork": {
"oneOf": [
{
"$ref": "#/$defs/simpleNetwork"
},
{
"$ref": "#/$defs/advancedNetwork"
}
]
},
"jsonNetworks": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonNetwork"
}
},
"type": "object"
},
"simpleAccount": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"address",
"key"
],
"type": "object"
},
"simpleAccountPre022": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"keys": {
"type": "string"
}
},
"required": [
"address",
"keys"
],
"type": "object"
},
"simpleNetwork": {
"type": "string"
}
},
"$id": "https://github.com/onflow/flow-cli/flowkit/config/json/json-config",
"$ref": "#/$defs/jsonConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
onflow/flow-cli | adeeaf1b4f05fb4c2e0cf0c68158260e83eefeae | 2024-01-10T18:49:46 | flowkit/schema.json | 204 | 2024-05-28T05:21:06.066526Z | {
"$defs": {
"account": {
"oneOf": [
{
"$ref": "#/$defs/simpleAccount"
},
{
"$ref": "#/$defs/advancedAccount"
},
{
"$ref": "#/$defs/simpleAccountPre022"
},
{
"$ref": "#/$defs/advanceAccountPre022"
}
]
},
"advanceAccountPre022": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"keys": {
"items": {
"$ref": "#/$defs/advanceKey"
},
"type": "array"
}
},
"required": [
"address",
"keys"
],
"type": "object"
},
"advanceKey": {
"additionalProperties": false,
"properties": {
"context": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"derivationPath": {
"type": "string"
},
"hashAlgorithm": {
"type": "string"
},
"index": {
"type": "integer"
},
"location": {
"type": "string"
},
"mnemonic": {
"type": "string"
},
"privateKey": {
"type": "string"
},
"resourceID": {
"type": "string"
},
"signatureAlgorithm": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"advancedAccount": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"key": {
"$ref": "#/$defs/advanceKey"
}
},
"required": [
"address",
"key"
],
"type": "object"
},
"advancedNetwork": {
"additionalProperties": false,
"properties": {
"host": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"host",
"key"
],
"type": "object"
},
"contractDeployment": {
"additionalProperties": false,
"properties": {
"args": {
"items": {
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"args"
],
"type": "object"
},
"deployment": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/contractDeployment"
}
]
},
"jsonAccounts": {
"patternProperties": {
".*": {
"$ref": "#/$defs/account"
}
},
"type": "object"
},
"jsonConfig": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/jsonAccounts"
},
"contracts": {
"$ref": "#/$defs/jsonContracts"
},
"dependencies": {
"$ref": "#/$defs/jsonDependencies"
},
"deployments": {
"$ref": "#/$defs/jsonDeployments"
},
"emulators": {
"$ref": "#/$defs/jsonEmulators"
},
"networks": {
"$ref": "#/$defs/jsonNetworks"
}
},
"type": "object"
},
"jsonContract": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/jsonContractAdvanced"
}
]
},
"jsonContractAdvanced": {
"additionalProperties": false,
"properties": {
"aliases": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"source": {
"type": "string"
}
},
"required": [
"source",
"aliases"
],
"type": "object"
},
"jsonContracts": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonContract"
}
},
"type": "object"
},
"jsonDependencies": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonDependency"
}
},
"type": "object"
},
"jsonDependency": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/jsonDependencyExtended"
}
]
},
"jsonDependencyExtended": {
"additionalProperties": false,
"properties": {
"aliases": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"remoteSource": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"remoteSource",
"version",
"aliases"
],
"type": "object"
},
"jsonDeployment": {
"patternProperties": {
".*": {
"items": {
"$ref": "#/$defs/deployment"
},
"type": "array"
}
},
"type": "object"
},
"jsonDeployments": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonDeployment"
}
},
"type": "object"
},
"jsonEmulator": {
"additionalProperties": false,
"properties": {
"port": {
"type": "integer"
},
"serviceAccount": {
"type": "string"
}
},
"required": [
"port",
"serviceAccount"
],
"type": "object"
},
"jsonEmulators": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonEmulator"
}
},
"type": "object"
},
"jsonNetwork": {
"oneOf": [
{
"$ref": "#/$defs/simpleNetwork"
},
{
"$ref": "#/$defs/advancedNetwork"
}
]
},
"jsonNetworks": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonNetwork"
}
},
"type": "object"
},
"simpleAccount": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"address",
"key"
],
"type": "object"
},
"simpleAccountPre022": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"keys": {
"type": "string"
}
},
"required": [
"address",
"keys"
],
"type": "object"
},
"simpleNetwork": {
"type": "string"
}
},
"$id": "https://github.com/onflow/flow-cli/flowkit/config/json/json-config",
"$ref": "#/$defs/jsonConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
onflow/flow-cli | cf58b644de81d367836e20fc96821404fa8b4f98 | 2023-11-30T23:38:10 | flowkit/schema.json | 204 | 2024-05-28T05:21:06.066526Z | {
"$defs": {
"account": {
"oneOf": [
{
"$ref": "#/$defs/simpleAccount"
},
{
"$ref": "#/$defs/advancedAccount"
},
{
"$ref": "#/$defs/simpleAccountPre022"
},
{
"$ref": "#/$defs/advanceAccountPre022"
}
]
},
"advanceAccountPre022": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"keys": {
"items": {
"$ref": "#/$defs/advanceKey"
},
"type": "array"
}
},
"required": [
"address",
"keys"
],
"type": "object"
},
"advanceKey": {
"additionalProperties": false,
"properties": {
"context": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"derivationPath": {
"type": "string"
},
"hashAlgorithm": {
"type": "string"
},
"index": {
"type": "integer"
},
"location": {
"type": "string"
},
"mnemonic": {
"type": "string"
},
"privateKey": {
"type": "string"
},
"resourceID": {
"type": "string"
},
"signatureAlgorithm": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"advancedAccount": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"key": {
"$ref": "#/$defs/advanceKey"
}
},
"required": [
"address",
"key"
],
"type": "object"
},
"advancedNetwork": {
"additionalProperties": false,
"properties": {
"host": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"host",
"key"
],
"type": "object"
},
"contractDeployment": {
"additionalProperties": false,
"properties": {
"args": {
"items": {
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"args"
],
"type": "object"
},
"deployment": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/contractDeployment"
}
]
},
"jsonAccounts": {
"patternProperties": {
".*": {
"$ref": "#/$defs/account"
}
},
"type": "object"
},
"jsonConfig": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/jsonAccounts"
},
"contracts": {
"$ref": "#/$defs/jsonContracts"
},
"dependencies": {
"$ref": "#/$defs/jsonDependencies"
},
"deployments": {
"$ref": "#/$defs/jsonDeployments"
},
"emulators": {
"$ref": "#/$defs/jsonEmulators"
},
"networks": {
"$ref": "#/$defs/jsonNetworks"
}
},
"type": "object"
},
"jsonContract": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/jsonContractAdvanced"
}
]
},
"jsonContractAdvanced": {
"additionalProperties": false,
"properties": {
"aliases": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"source": {
"type": "string"
}
},
"required": [
"source",
"aliases"
],
"type": "object"
},
"jsonContracts": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonContract"
}
},
"type": "object"
},
"jsonDependencies": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonDependencies"
}
},
"type": "object"
},
"jsonDeployment": {
"patternProperties": {
".*": {
"items": {
"$ref": "#/$defs/deployment"
},
"type": "array"
}
},
"type": "object"
},
"jsonDeployments": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonDeployment"
}
},
"type": "object"
},
"jsonEmulator": {
"additionalProperties": false,
"properties": {
"port": {
"type": "integer"
},
"serviceAccount": {
"type": "string"
}
},
"required": [
"port",
"serviceAccount"
],
"type": "object"
},
"jsonEmulators": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonEmulator"
}
},
"type": "object"
},
"jsonNetwork": {
"oneOf": [
{
"$ref": "#/$defs/simpleNetwork"
},
{
"$ref": "#/$defs/advancedNetwork"
}
]
},
"jsonNetworks": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonNetwork"
}
},
"type": "object"
},
"simpleAccount": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"address",
"key"
],
"type": "object"
},
"simpleAccountPre022": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"keys": {
"type": "string"
}
},
"required": [
"address",
"keys"
],
"type": "object"
},
"simpleNetwork": {
"type": "string"
}
},
"$id": "https://github.com/onflow/flow-cli/flowkit/config/json/json-config",
"$ref": "#/$defs/jsonConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
onflow/flow-cli | 75054c645df22da8fc1b329162541b17ad2733cb | 2024-01-25T23:51:21 | flowkit/schema.json | 204 | 2024-05-28T05:21:06.066526Z | {
"$defs": {
"account": {
"oneOf": [
{
"$ref": "#/$defs/simpleAccount"
},
{
"$ref": "#/$defs/advancedAccount"
},
{
"$ref": "#/$defs/simpleAccountPre022"
},
{
"$ref": "#/$defs/advanceAccountPre022"
}
]
},
"advanceAccountPre022": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"keys": {
"items": {
"$ref": "#/$defs/advanceKey"
},
"type": "array"
}
},
"required": [
"address",
"keys"
],
"type": "object"
},
"advanceKey": {
"additionalProperties": false,
"properties": {
"context": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"derivationPath": {
"type": "string"
},
"hashAlgorithm": {
"type": "string"
},
"index": {
"type": "integer"
},
"location": {
"type": "string"
},
"mnemonic": {
"type": "string"
},
"privateKey": {
"type": "string"
},
"resourceID": {
"type": "string"
},
"signatureAlgorithm": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"advancedAccount": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"key": {
"$ref": "#/$defs/advanceKey"
}
},
"required": [
"address",
"key"
],
"type": "object"
},
"advancedNetwork": {
"additionalProperties": false,
"properties": {
"host": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"host",
"key"
],
"type": "object"
},
"contractDeployment": {
"additionalProperties": false,
"properties": {
"args": {
"items": {
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"args"
],
"type": "object"
},
"deployment": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/contractDeployment"
}
]
},
"jsonAccounts": {
"patternProperties": {
".*": {
"$ref": "#/$defs/account"
}
},
"type": "object"
},
"jsonConfig": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/jsonAccounts"
},
"contracts": {
"$ref": "#/$defs/jsonContracts"
},
"dependencies": {
"$ref": "#/$defs/jsonDependencies"
},
"deployments": {
"$ref": "#/$defs/jsonDeployments"
},
"emulators": {
"$ref": "#/$defs/jsonEmulators"
},
"networks": {
"$ref": "#/$defs/jsonNetworks"
}
},
"type": "object"
},
"jsonContract": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/jsonContractAdvanced"
}
]
},
"jsonContractAdvanced": {
"additionalProperties": false,
"properties": {
"aliases": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"source": {
"type": "string"
}
},
"required": [
"source",
"aliases"
],
"type": "object"
},
"jsonContracts": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonContract"
}
},
"type": "object"
},
"jsonDependencies": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonDependency"
}
},
"type": "object"
},
"jsonDependency": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/jsonDependencyExtended"
}
]
},
"jsonDependencyExtended": {
"additionalProperties": false,
"properties": {
"aliases": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"source": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"source",
"version",
"aliases"
],
"type": "object"
},
"jsonDeployment": {
"patternProperties": {
".*": {
"items": {
"$ref": "#/$defs/deployment"
},
"type": "array"
}
},
"type": "object"
},
"jsonDeployments": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonDeployment"
}
},
"type": "object"
},
"jsonEmulator": {
"additionalProperties": false,
"properties": {
"port": {
"type": "integer"
},
"serviceAccount": {
"type": "string"
}
},
"required": [
"port",
"serviceAccount"
],
"type": "object"
},
"jsonEmulators": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonEmulator"
}
},
"type": "object"
},
"jsonNetwork": {
"oneOf": [
{
"$ref": "#/$defs/simpleNetwork"
},
{
"$ref": "#/$defs/advancedNetwork"
}
]
},
"jsonNetworks": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonNetwork"
}
},
"type": "object"
},
"simpleAccount": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"address",
"key"
],
"type": "object"
},
"simpleAccountPre022": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"keys": {
"type": "string"
}
},
"required": [
"address",
"keys"
],
"type": "object"
},
"simpleNetwork": {
"type": "string"
}
},
"$id": "https://github.com/onflow/flow-cli/flowkit/config/json/json-config",
"$ref": "#/$defs/jsonConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
onflow/flow-cli | daa1550168a7310426dc24d3b6e805766f470442 | 2023-07-03T23:08:13 | flowkit/schema.json | 204 | 2024-05-28T05:21:06.066526Z | {
"$defs": {
"account": {
"oneOf": [
{
"$ref": "#/$defs/simpleAccount"
},
{
"$ref": "#/$defs/advancedAccount"
},
{
"$ref": "#/$defs/simpleAccountPre022"
},
{
"$ref": "#/$defs/advanceAccountPre022"
}
]
},
"advanceAccountPre022": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"keys": {
"items": {
"$ref": "#/$defs/advanceKey"
},
"type": "array"
}
},
"required": [
"address",
"keys"
],
"type": "object"
},
"advanceKey": {
"additionalProperties": false,
"properties": {
"context": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"derivationPath": {
"type": "string"
},
"hashAlgorithm": {
"type": "string"
},
"index": {
"type": "integer"
},
"location": {
"type": "string"
},
"mnemonic": {
"type": "string"
},
"privateKey": {
"type": "string"
},
"resourceID": {
"type": "string"
},
"signatureAlgorithm": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"advancedAccount": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"key": {
"$ref": "#/$defs/advanceKey"
}
},
"required": [
"address",
"key"
],
"type": "object"
},
"advancedNetwork": {
"additionalProperties": false,
"properties": {
"host": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"host",
"key"
],
"type": "object"
},
"contractDeployment": {
"additionalProperties": false,
"properties": {
"args": {
"items": {
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"args"
],
"type": "object"
},
"deployment": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/contractDeployment"
}
]
},
"jsonAccounts": {
"patternProperties": {
".*": {
"$ref": "#/$defs/account"
}
},
"type": "object"
},
"jsonConfig": {
"additionalProperties": false,
"properties": {
"accounts": {
"$ref": "#/$defs/jsonAccounts"
},
"contracts": {
"$ref": "#/$defs/jsonContracts"
},
"deployments": {
"$ref": "#/$defs/jsonDeployments"
},
"emulators": {
"$ref": "#/$defs/jsonEmulators"
},
"networks": {
"$ref": "#/$defs/jsonNetworks"
}
},
"type": "object"
},
"jsonContract": {
"oneOf": [
{
"type": "string"
},
{
"$ref": "#/$defs/jsonContractAdvanced"
}
]
},
"jsonContractAdvanced": {
"additionalProperties": false,
"properties": {
"aliases": {
"patternProperties": {
".*": {
"type": "string"
}
},
"type": "object"
},
"source": {
"type": "string"
}
},
"required": [
"source",
"aliases"
],
"type": "object"
},
"jsonContracts": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonContract"
}
},
"type": "object"
},
"jsonDeployment": {
"patternProperties": {
".*": {
"items": {
"$ref": "#/$defs/deployment"
},
"type": "array"
}
},
"type": "object"
},
"jsonDeployments": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonDeployment"
}
},
"type": "object"
},
"jsonEmulator": {
"additionalProperties": false,
"properties": {
"port": {
"type": "integer"
},
"serviceAccount": {
"type": "string"
}
},
"required": [
"port",
"serviceAccount"
],
"type": "object"
},
"jsonEmulators": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonEmulator"
}
},
"type": "object"
},
"jsonNetwork": {
"oneOf": [
{
"$ref": "#/$defs/simpleNetwork"
},
{
"$ref": "#/$defs/advancedNetwork"
}
]
},
"jsonNetworks": {
"patternProperties": {
".*": {
"$ref": "#/$defs/jsonNetwork"
}
},
"type": "object"
},
"simpleAccount": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"address",
"key"
],
"type": "object"
},
"simpleAccountPre022": {
"additionalProperties": false,
"properties": {
"address": {
"type": "string"
},
"keys": {
"type": "string"
}
},
"required": [
"address",
"keys"
],
"type": "object"
},
"simpleNetwork": {
"type": "string"
}
},
"$id": "https://github.com/onflow/flow-cli/flowkit/config/json/json-config",
"$ref": "#/$defs/jsonConfig",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
onflow/cadence | 9ab2b685903d1208d32ae7eacf537d00c622c9a9 | 2022-12-16T00:10:09 | tools/update/config.schema.json | 525 | 2024-05-29T08:24:54.457264Z | {
"$defs": {
"mod": {
"additionalProperties": false,
"properties": {
"deps": {
"description": "The dependencies that should be updated",
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"description": "The path of the module",
"type": "string"
}
},
"required": [
"path",
"deps"
],
"type": "object"
},
"repo": {
"additionalProperties": false,
"properties": {
"mods": {
"description": "The modules of the repository",
"items": {
"$ref": "#/$defs/mod"
},
"type": "array"
},
"needsRelease": {
"description": "Indicates if a released version of this repo should be used, or if the latest commit should be used instead",
"type": "boolean"
},
"repo": {
"description": "The repository name",
"type": "string"
},
"updateLabels": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"repo",
"mods",
"needsRelease"
],
"type": "object"
}
},
"$id": "github.com/onflow/cadence/tools/update/config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"repo": {
"description": "The repository name",
"type": "string"
},
"repos": {
"items": {
"$ref": "#/$defs/repo"
},
"type": "array"
}
},
"required": [
"repo",
"repos"
],
"title": "Cadence update tool config schema",
"type": "object"
} | Apache-2.0 | en |
onflow/cadence | 747c3a196053332c3b7e9b27bd5ce309f3bcb0c1 | 2024-02-02T22:10:36 | tools/update/config.schema.json | 525 | 2024-05-29T08:24:54.457264Z | {
"$defs": {
"mod": {
"additionalProperties": false,
"properties": {
"deps": {
"description": "The dependencies that should be updated",
"items": {
"type": "string"
},
"type": "array"
},
"path": {
"description": "The path of the module",
"type": "string"
}
},
"required": [
"path",
"deps"
],
"type": "object"
},
"repo": {
"additionalProperties": false,
"properties": {
"branch": {
"description": "The branch name",
"type": "string"
},
"mods": {
"description": "The modules of the repository",
"items": {
"$ref": "#/$defs/mod"
},
"type": "array"
},
"needsRelease": {
"description": "Indicates if a released version of this repo should be used, or if the latest commit should be used instead",
"type": "boolean"
},
"prefixPRTitle": {
"description": "Prefix the PR title with the mod(s)",
"type": "boolean"
},
"repo": {
"description": "The repository name",
"type": "string"
},
"updateLabels": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"repo",
"mods",
"needsRelease"
],
"type": "object"
}
},
"$id": "github.com/onflow/cadence/tools/update/config.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"repo": {
"description": "The repository name",
"type": "string"
},
"repos": {
"items": {
"$ref": "#/$defs/repo"
},
"type": "array"
}
},
"required": [
"repo",
"repos"
],
"title": "Cadence update tool config schema",
"type": "object"
} | Apache-2.0 | en |
eclipse-basyx/basyx-rust-sdk | f7a00395856e014b98c50fb18dd7914d3f972758 | 2023-05-31T05:10:51 | schema/aas.json | 6 | 2024-05-27T05:38:12.778257Z | {
"$id": "https://admin-shell.io/aas/3/0",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"allOf": [
{
"$ref": "#/definitions/Environment"
}
],
"definitions": {
"AasSubmodelElements": {
"enum": [
"AnnotatedRelationshipElement",
"BasicEventElement",
"Blob",
"Capability",
"DataElement",
"Entity",
"EventElement",
"File",
"MultiLanguageProperty",
"Operation",
"Property",
"Range",
"ReferenceElement",
"RelationshipElement",
"SubmodelElement",
"SubmodelElementCollection",
"SubmodelElementList"
],
"type": "string"
},
"AbstractLangString": {
"properties": {
"language": {
"pattern": "^(([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){2})?|[a-zA-Z]{4}|[a-zA-Z]{5,8})(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-(([a-zA-Z0-9]){5,8}|[0-9]([a-zA-Z0-9]){3}))*(-[0-9A-WY-Za-wy-z](-([a-zA-Z0-9]){2,8})+)*(-[xX](-([a-zA-Z0-9]){1,8})+)?|[xX](-([a-zA-Z0-9]){1,8})+|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$",
"type": "string"
},
"text": {
"minLength": 1,
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$",
"type": "string"
}
},
"required": [
"language",
"text"
],
"type": "object"
},
"AdministrativeInformation": {
"allOf": [
{
"$ref": "#/definitions/HasDataSpecification"
},
{
"properties": {
"creator": {
"$ref": "#/definitions/Reference"
},
"revision": {
"allOf": [
{
"maxLength": 4,
"minLength": 1
},
{
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"
},
{
"pattern": "^(0|[1-9][0-9]*)$"
}
],
"type": "string"
},
"templateId": {
"maxLength": 2000,
"minLength": 1,
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$",
"type": "string"
},
"version": {
"allOf": [
{
"maxLength": 4,
"minLength": 1
},
{
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"
},
{
"pattern": "^(0|[1-9][0-9]*)$"
}
],
"type": "string"
}
}
}
]
},
"AnnotatedRelationshipElement": {
"allOf": [
{
"$ref": "#/definitions/RelationshipElement_abstract"
},
{
"properties": {
"annotations": {
"items": {
"$ref": "#/definitions/DataElement_choice"
},
"minItems": 1,
"type": "array"
},
"modelType": {
"const": "AnnotatedRelationshipElement"
}
}
}
]
},
"AssetAdministrationShell": {
"allOf": [
{
"$ref": "#/definitions/Identifiable"
},
{
"$ref": "#/definitions/HasDataSpecification"
},
{
"properties": {
"assetInformation": {
"$ref": "#/definitions/AssetInformation"
},
"derivedFrom": {
"$ref": "#/definitions/Reference"
},
"modelType": {
"const": "AssetAdministrationShell"
},
"submodels": {
"items": {
"$ref": "#/definitions/Reference"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"assetInformation"
]
}
]
},
"AssetInformation": {
"properties": {
"assetKind": {
"$ref": "#/definitions/AssetKind"
},
"assetType": {
"maxLength": 2000,
"minLength": 1,
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$",
"type": "string"
},
"defaultThumbnail": {
"$ref": "#/definitions/Resource"
},
"globalAssetId": {
"maxLength": 2000,
"minLength": 1,
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$",
"type": "string"
},
"specificAssetIds": {
"items": {
"$ref": "#/definitions/SpecificAssetId"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"assetKind"
],
"type": "object"
},
"AssetKind": {
"enum": [
"Instance",
"NotApplicable",
"Type"
],
"type": "string"
},
"BasicEventElement": {
"allOf": [
{
"$ref": "#/definitions/EventElement"
},
{
"properties": {
"direction": {
"$ref": "#/definitions/Direction"
},
"lastUpdate": {
"pattern": "^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\\.[0-9]+)?)|24:00:00(\\.0+)?)(Z|\\+00:00|-00:00)$",
"type": "string"
},
"maxInterval": {
"pattern": "^-?P((([0-9]+Y([0-9]+M)?([0-9]+D)?|([0-9]+M)([0-9]+D)?|([0-9]+D))(T(([0-9]+H)([0-9]+M)?([0-9]+(\\.[0-9]+)?S)?|([0-9]+M)([0-9]+(\\.[0-9]+)?S)?|([0-9]+(\\.[0-9]+)?S)))?)|(T(([0-9]+H)([0-9]+M)?([0-9]+(\\.[0-9]+)?S)?|([0-9]+M)([0-9]+(\\.[0-9]+)?S)?|([0-9]+(\\.[0-9]+)?S))))$",
"type": "string"
},
"messageBroker": {
"$ref": "#/definitions/Reference"
},
"messageTopic": {
"maxLength": 255,
"minLength": 1,
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$",
"type": "string"
},
"minInterval": {
"pattern": "^-?P((([0-9]+Y([0-9]+M)?([0-9]+D)?|([0-9]+M)([0-9]+D)?|([0-9]+D))(T(([0-9]+H)([0-9]+M)?([0-9]+(\\.[0-9]+)?S)?|([0-9]+M)([0-9]+(\\.[0-9]+)?S)?|([0-9]+(\\.[0-9]+)?S)))?)|(T(([0-9]+H)([0-9]+M)?([0-9]+(\\.[0-9]+)?S)?|([0-9]+M)([0-9]+(\\.[0-9]+)?S)?|([0-9]+(\\.[0-9]+)?S))))$",
"type": "string"
},
"modelType": {
"const": "BasicEventElement"
},
"observed": {
"$ref": "#/definitions/Reference"
},
"state": {
"$ref": "#/definitions/StateOfEvent"
}
},
"required": [
"observed",
"direction",
"state"
]
}
]
},
"Blob": {
"allOf": [
{
"$ref": "#/definitions/DataElement"
},
{
"properties": {
"contentType": {
"allOf": [
{
"maxLength": 100,
"minLength": 1
},
{
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"
},
{
"pattern": "^([!#$%&'*+\\-.^_`|~0-9a-zA-Z])+/([!#$%&'*+\\-.^_`|~0-9a-zA-Z])+([ \\t]*;[ \\t]*([!#$%&'*+\\-.^_`|~0-9a-zA-Z])+=(([!#$%&'*+\\-.^_`|~0-9a-zA-Z])+|\"(([\\t !#-\\[\\]-~]|[\u0080-\u00ff])|\\\\([\\t !-~]|[\u0080-\u00ff]))*\"))*$"
}
],
"type": "string"
},
"modelType": {
"const": "Blob"
},
"value": {
"contentEncoding": "base64",
"type": "string"
}
},
"required": [
"contentType"
]
}
]
},
"Capability": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"modelType": {
"const": "Capability"
}
}
}
]
},
"ConceptDescription": {
"allOf": [
{
"$ref": "#/definitions/Identifiable"
},
{
"$ref": "#/definitions/HasDataSpecification"
},
{
"properties": {
"isCaseOf": {
"items": {
"$ref": "#/definitions/Reference"
},
"minItems": 1,
"type": "array"
},
"modelType": {
"const": "ConceptDescription"
}
}
}
]
},
"DataElement": {
"$ref": "#/definitions/SubmodelElement"
},
"DataElement_choice": {
"oneOf": [
{
"$ref": "#/definitions/Blob"
},
{
"$ref": "#/definitions/File"
},
{
"$ref": "#/definitions/MultiLanguageProperty"
},
{
"$ref": "#/definitions/Property"
},
{
"$ref": "#/definitions/Range"
},
{
"$ref": "#/definitions/ReferenceElement"
}
]
},
"DataSpecificationContent": {
"properties": {
"modelType": {
"$ref": "#/definitions/ModelType"
}
},
"required": [
"modelType"
],
"type": "object"
},
"DataSpecificationContent_choice": {
"oneOf": [
{
"$ref": "#/definitions/DataSpecificationIec61360"
}
]
},
"DataSpecificationIec61360": {
"allOf": [
{
"$ref": "#/definitions/DataSpecificationContent"
},
{
"properties": {
"dataType": {
"$ref": "#/definitions/DataTypeIec61360"
},
"definition": {
"items": {
"$ref": "#/definitions/LangStringDefinitionTypeIec61360"
},
"minItems": 1,
"type": "array"
},
"levelType": {
"$ref": "#/definitions/LevelType"
},
"modelType": {
"const": "DataSpecificationIec61360"
},
"preferredName": {
"items": {
"$ref": "#/definitions/LangStringPreferredNameTypeIec61360"
},
"minItems": 1,
"type": "array"
},
"shortName": {
"items": {
"$ref": "#/definitions/LangStringShortNameTypeIec61360"
},
"minItems": 1,
"type": "array"
},
"sourceOfDefinition": {
"minLength": 1,
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$",
"type": "string"
},
"symbol": {
"minLength": 1,
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$",
"type": "string"
},
"unit": {
"minLength": 1,
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$",
"type": "string"
},
"unitId": {
"$ref": "#/definitions/Reference"
},
"value": {
"maxLength": 2000,
"minLength": 1,
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$",
"type": "string"
},
"valueFormat": {
"minLength": 1,
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$",
"type": "string"
},
"valueList": {
"$ref": "#/definitions/ValueList"
}
},
"required": [
"preferredName"
]
}
]
},
"DataTypeDefXsd": {
"enum": [
"xs:anyURI",
"xs:base64Binary",
"xs:boolean",
"xs:byte",
"xs:date",
"xs:dateTime",
"xs:decimal",
"xs:double",
"xs:duration",
"xs:float",
"xs:gDay",
"xs:gMonth",
"xs:gMonthDay",
"xs:gYear",
"xs:gYearMonth",
"xs:hexBinary",
"xs:int",
"xs:integer",
"xs:long",
"xs:negativeInteger",
"xs:nonNegativeInteger",
"xs:nonPositiveInteger",
"xs:positiveInteger",
"xs:short",
"xs:string",
"xs:time",
"xs:unsignedByte",
"xs:unsignedInt",
"xs:unsignedLong",
"xs:unsignedShort"
],
"type": "string"
},
"DataTypeIec61360": {
"enum": [
"BLOB",
"BOOLEAN",
"DATE",
"FILE",
"HTML",
"INTEGER_COUNT",
"INTEGER_CURRENCY",
"INTEGER_MEASURE",
"IRDI",
"IRI",
"RATIONAL",
"RATIONAL_MEASURE",
"REAL_COUNT",
"REAL_CURRENCY",
"REAL_MEASURE",
"STRING",
"STRING_TRANSLATABLE",
"TIME",
"TIMESTAMP"
],
"type": "string"
},
"Direction": {
"enum": [
"input",
"output"
],
"type": "string"
},
"EmbeddedDataSpecification": {
"properties": {
"dataSpecification": {
"$ref": "#/definitions/Reference"
},
"dataSpecificationContent": {
"$ref": "#/definitions/DataSpecificationContent_choice"
}
},
"required": [
"dataSpecification",
"dataSpecificationContent"
],
"type": "object"
},
"Entity": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"entityType": {
"$ref": "#/definitions/EntityType"
},
"globalAssetId": {
"maxLength": 2000,
"minLength": 1,
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$",
"type": "string"
},
"modelType": {
"const": "Entity"
},
"specificAssetIds": {
"items": {
"$ref": "#/definitions/SpecificAssetId"
},
"minItems": 1,
"type": "array"
},
"statements": {
"items": {
"$ref": "#/definitions/SubmodelElement_choice"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"entityType"
]
}
]
},
"EntityType": {
"enum": [
"CoManagedEntity",
"SelfManagedEntity"
],
"type": "string"
},
"Environment": {
"properties": {
"assetAdministrationShells": {
"items": {
"$ref": "#/definitions/AssetAdministrationShell"
},
"minItems": 1,
"type": "array"
},
"conceptDescriptions": {
"items": {
"$ref": "#/definitions/ConceptDescription"
},
"minItems": 1,
"type": "array"
},
"submodels": {
"items": {
"$ref": "#/definitions/Submodel"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
},
"EventElement": {
"$ref": "#/definitions/SubmodelElement"
},
"EventPayload": {
"properties": {
"observableReference": {
"$ref": "#/definitions/Reference"
},
"observableSemanticId": {
"$ref": "#/definitions/Reference"
},
"payload": {
"contentEncoding": "base64",
"type": "string"
},
"source": {
"$ref": "#/definitions/Reference"
},
"sourceSemanticId": {
"$ref": "#/definitions/Reference"
},
"subjectId": {
"$ref": "#/definitions/Reference"
},
"timeStamp": {
"pattern": "^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\\.[0-9]+)?)|24:00:00(\\.0+)?)(Z|\\+00:00|-00:00)$",
"type": "string"
},
"topic": {
"maxLength": 255,
"minLength": 1,
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$",
"type": "string"
}
},
"required": [
"source",
"observableReference",
"timeStamp"
],
"type": "object"
},
"Extension": {
"allOf": [
{
"$ref": "#/definitions/HasSemantics"
},
{
"properties": {
"name": {
"maxLength": 128,
"minLength": 1,
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$",
"type": "string"
},
"refersTo": {
"items": {
"$ref": "#/definitions/Reference"
},
"minItems": 1,
"type": "array"
},
"value": {
"type": "string"
},
"valueType": {
"$ref": "#/definitions/DataTypeDefXsd"
}
},
"required": [
"name"
]
}
]
},
"File": {
"allOf": [
{
"$ref": "#/definitions/DataElement"
},
{
"properties": {
"contentType": {
"allOf": [
{
"maxLength": 100,
"minLength": 1
},
{
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"
},
{
"pattern": "^([!#$%&'*+\\-.^_`|~0-9a-zA-Z])+/([!#$%&'*+\\-.^_`|~0-9a-zA-Z])+([ \\t]*;[ \\t]*([!#$%&'*+\\-.^_`|~0-9a-zA-Z])+=(([!#$%&'*+\\-.^_`|~0-9a-zA-Z])+|\"(([\\t !#-\\[\\]-~]|[\u0080-\u00ff])|\\\\([\\t !-~]|[\u0080-\u00ff]))*\"))*$"
}
],
"type": "string"
},
"modelType": {
"const": "File"
},
"value": {
"allOf": [
{
"maxLength": 2000,
"minLength": 1
},
{
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"
},
{
"pattern": "^file:(//((localhost|(\\[((([0-9A-Fa-f]{1,4}:){6}([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))|::([0-9A-Fa-f]{1,4}:){5}([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))|([0-9A-Fa-f]{1,4})?::([0-9A-Fa-f]{1,4}:){4}([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))|(([0-9A-Fa-f]{1,4}:)?[0-9A-Fa-f]{1,4})?::([0-9A-Fa-f]{1,4}:){3}([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))|(([0-9A-Fa-f]{1,4}:){2}[0-9A-Fa-f]{1,4})?::([0-9A-Fa-f]{1,4}:){2}([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))|(([0-9A-Fa-f]{1,4}:){3}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))|(([0-9A-Fa-f]{1,4}:){4}[0-9A-Fa-f]{1,4})?::([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))|(([0-9A-Fa-f]{1,4}:){5}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}|(([0-9A-Fa-f]{1,4}:){6}[0-9A-Fa-f]{1,4})?::)|[vV][0-9A-Fa-f]+\\.([a-zA-Z0-9\\-._~]|[!$&'()*+,;=]|:)+)\\]|([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])|([a-zA-Z0-9\\-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=])*)))?/((([a-zA-Z0-9\\-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@]))+(/(([a-zA-Z0-9\\-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@]))*)*)?|/((([a-zA-Z0-9\\-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@]))+(/(([a-zA-Z0-9\\-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@]))*)*)?)$"
}
],
"type": "string"
}
},
"required": [
"contentType"
]
}
]
},
"HasDataSpecification": {
"properties": {
"embeddedDataSpecifications": {
"items": {
"$ref": "#/definitions/EmbeddedDataSpecification"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
},
"HasExtensions": {
"properties": {
"extensions": {
"items": {
"$ref": "#/definitions/Extension"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
},
"HasKind": {
"properties": {
"kind": {
"$ref": "#/definitions/ModellingKind"
}
},
"type": "object"
},
"HasSemantics": {
"properties": {
"semanticId": {
"$ref": "#/definitions/Reference"
},
"supplementalSemanticIds": {
"items": {
"$ref": "#/definitions/Reference"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
},
"Identifiable": {
"allOf": [
{
"$ref": "#/definitions/Referable"
},
{
"properties": {
"administration": {
"$ref": "#/definitions/AdministrativeInformation"
},
"id": {
"maxLength": 2000,
"minLength": 1,
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$",
"type": "string"
}
},
"required": [
"id"
]
}
]
},
"Key": {
"properties": {
"type": {
"$ref": "#/definitions/KeyTypes"
},
"value": {
"maxLength": 2000,
"minLength": 1,
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$",
"type": "string"
}
},
"required": [
"type",
"value"
],
"type": "object"
},
"KeyTypes": {
"enum": [
"AnnotatedRelationshipElement",
"AssetAdministrationShell",
"BasicEventElement",
"Blob",
"Capability",
"ConceptDescription",
"DataElement",
"Entity",
"EventElement",
"File",
"FragmentReference",
"GlobalReference",
"Identifiable",
"MultiLanguageProperty",
"Operation",
"Property",
"Range",
"Referable",
"ReferenceElement",
"RelationshipElement",
"Submodel",
"SubmodelElement",
"SubmodelElementCollection",
"SubmodelElementList"
],
"type": "string"
},
"LangStringDefinitionTypeIec61360": {
"allOf": [
{
"$ref": "#/definitions/AbstractLangString"
},
{
"properties": {
"text": {
"maxLength": 1023
}
}
}
]
},
"LangStringNameType": {
"allOf": [
{
"$ref": "#/definitions/AbstractLangString"
},
{
"properties": {
"text": {
"maxLength": 128
}
}
}
]
},
"LangStringPreferredNameTypeIec61360": {
"allOf": [
{
"$ref": "#/definitions/AbstractLangString"
},
{
"properties": {
"text": {
"maxLength": 255
}
}
}
]
},
"LangStringShortNameTypeIec61360": {
"allOf": [
{
"$ref": "#/definitions/AbstractLangString"
},
{
"properties": {
"text": {
"maxLength": 18
}
}
}
]
},
"LangStringTextType": {
"allOf": [
{
"$ref": "#/definitions/AbstractLangString"
},
{
"properties": {
"text": {
"maxLength": 1023
}
}
}
]
},
"LevelType": {
"properties": {
"max": {
"type": "boolean"
},
"min": {
"type": "boolean"
},
"nom": {
"type": "boolean"
},
"typ": {
"type": "boolean"
}
},
"required": [
"min",
"nom",
"typ",
"max"
],
"type": "object"
},
"ModelType": {
"enum": [
"AnnotatedRelationshipElement",
"AssetAdministrationShell",
"BasicEventElement",
"Blob",
"Capability",
"ConceptDescription",
"DataSpecificationIec61360",
"Entity",
"File",
"MultiLanguageProperty",
"Operation",
"Property",
"Range",
"ReferenceElement",
"RelationshipElement",
"Submodel",
"SubmodelElementCollection",
"SubmodelElementList"
],
"type": "string"
},
"ModellingKind": {
"enum": [
"Instance",
"Template"
],
"type": "string"
},
"MultiLanguageProperty": {
"allOf": [
{
"$ref": "#/definitions/DataElement"
},
{
"properties": {
"modelType": {
"const": "MultiLanguageProperty"
},
"value": {
"items": {
"$ref": "#/definitions/LangStringTextType"
},
"minItems": 1,
"type": "array"
},
"valueId": {
"$ref": "#/definitions/Reference"
}
}
}
]
},
"Operation": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"inoutputVariables": {
"items": {
"$ref": "#/definitions/OperationVariable"
},
"minItems": 1,
"type": "array"
},
"inputVariables": {
"items": {
"$ref": "#/definitions/OperationVariable"
},
"minItems": 1,
"type": "array"
},
"modelType": {
"const": "Operation"
},
"outputVariables": {
"items": {
"$ref": "#/definitions/OperationVariable"
},
"minItems": 1,
"type": "array"
}
}
}
]
},
"OperationVariable": {
"properties": {
"value": {
"$ref": "#/definitions/SubmodelElement_choice"
}
},
"required": [
"value"
],
"type": "object"
},
"Property": {
"allOf": [
{
"$ref": "#/definitions/DataElement"
},
{
"properties": {
"modelType": {
"const": "Property"
},
"value": {
"type": "string"
},
"valueId": {
"$ref": "#/definitions/Reference"
},
"valueType": {
"$ref": "#/definitions/DataTypeDefXsd"
}
},
"required": [
"valueType"
]
}
]
},
"Qualifiable": {
"properties": {
"modelType": {
"$ref": "#/definitions/ModelType"
},
"qualifiers": {
"items": {
"$ref": "#/definitions/Qualifier"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"modelType"
],
"type": "object"
},
"Qualifier": {
"allOf": [
{
"$ref": "#/definitions/HasSemantics"
},
{
"properties": {
"kind": {
"$ref": "#/definitions/QualifierKind"
},
"type": {
"maxLength": 128,
"minLength": 1,
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$",
"type": "string"
},
"value": {
"type": "string"
},
"valueId": {
"$ref": "#/definitions/Reference"
},
"valueType": {
"$ref": "#/definitions/DataTypeDefXsd"
}
},
"required": [
"type",
"valueType"
]
}
]
},
"QualifierKind": {
"enum": [
"ConceptQualifier",
"TemplateQualifier",
"ValueQualifier"
],
"type": "string"
},
"Range": {
"allOf": [
{
"$ref": "#/definitions/DataElement"
},
{
"properties": {
"max": {
"type": "string"
},
"min": {
"type": "string"
},
"modelType": {
"const": "Range"
},
"valueType": {
"$ref": "#/definitions/DataTypeDefXsd"
}
},
"required": [
"valueType"
]
}
]
},
"Referable": {
"allOf": [
{
"$ref": "#/definitions/HasExtensions"
},
{
"properties": {
"category": {
"maxLength": 128,
"minLength": 1,
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$",
"type": "string"
},
"description": {
"items": {
"$ref": "#/definitions/LangStringTextType"
},
"minItems": 1,
"type": "array"
},
"displayName": {
"items": {
"$ref": "#/definitions/LangStringNameType"
},
"minItems": 1,
"type": "array"
},
"idShort": {
"allOf": [
{
"maxLength": 128,
"minLength": 1
},
{
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"
},
{
"pattern": "^[a-zA-Z][a-zA-Z0-9_]*$"
}
],
"type": "string"
},
"modelType": {
"$ref": "#/definitions/ModelType"
}
},
"required": [
"modelType"
]
}
]
},
"Reference": {
"properties": {
"keys": {
"items": {
"$ref": "#/definitions/Key"
},
"minItems": 1,
"type": "array"
},
"referredSemanticId": {
"$ref": "#/definitions/Reference"
},
"type": {
"$ref": "#/definitions/ReferenceTypes"
}
},
"required": [
"type",
"keys"
],
"type": "object"
},
"ReferenceElement": {
"allOf": [
{
"$ref": "#/definitions/DataElement"
},
{
"properties": {
"modelType": {
"const": "ReferenceElement"
},
"value": {
"$ref": "#/definitions/Reference"
}
}
}
]
},
"ReferenceTypes": {
"enum": [
"ExternalReference",
"ModelReference"
],
"type": "string"
},
"RelationshipElement": {
"allOf": [
{
"$ref": "#/definitions/RelationshipElement_abstract"
},
{
"properties": {
"modelType": {
"const": "RelationshipElement"
}
}
}
]
},
"RelationshipElement_abstract": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"first": {
"$ref": "#/definitions/Reference"
},
"second": {
"$ref": "#/definitions/Reference"
}
},
"required": [
"first",
"second"
]
}
]
},
"RelationshipElement_choice": {
"oneOf": [
{
"$ref": "#/definitions/RelationshipElement"
},
{
"$ref": "#/definitions/AnnotatedRelationshipElement"
}
]
},
"Resource": {
"properties": {
"contentType": {
"allOf": [
{
"maxLength": 100,
"minLength": 1
},
{
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"
},
{
"pattern": "^([!#$%&'*+\\-.^_`|~0-9a-zA-Z])+/([!#$%&'*+\\-.^_`|~0-9a-zA-Z])+([ \\t]*;[ \\t]*([!#$%&'*+\\-.^_`|~0-9a-zA-Z])+=(([!#$%&'*+\\-.^_`|~0-9a-zA-Z])+|\"(([\\t !#-\\[\\]-~]|[\u0080-\u00ff])|\\\\([\\t !-~]|[\u0080-\u00ff]))*\"))*$"
}
],
"type": "string"
},
"path": {
"allOf": [
{
"maxLength": 2000,
"minLength": 1
},
{
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$"
},
{
"pattern": "^file:(//((localhost|(\\[((([0-9A-Fa-f]{1,4}:){6}([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))|::([0-9A-Fa-f]{1,4}:){5}([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))|([0-9A-Fa-f]{1,4})?::([0-9A-Fa-f]{1,4}:){4}([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))|(([0-9A-Fa-f]{1,4}:)?[0-9A-Fa-f]{1,4})?::([0-9A-Fa-f]{1,4}:){3}([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))|(([0-9A-Fa-f]{1,4}:){2}[0-9A-Fa-f]{1,4})?::([0-9A-Fa-f]{1,4}:){2}([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))|(([0-9A-Fa-f]{1,4}:){3}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))|(([0-9A-Fa-f]{1,4}:){4}[0-9A-Fa-f]{1,4})?::([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))|(([0-9A-Fa-f]{1,4}:){5}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}|(([0-9A-Fa-f]{1,4}:){6}[0-9A-Fa-f]{1,4})?::)|[vV][0-9A-Fa-f]+\\.([a-zA-Z0-9\\-._~]|[!$&'()*+,;=]|:)+)\\]|([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])|([a-zA-Z0-9\\-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=])*)))?/((([a-zA-Z0-9\\-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@]))+(/(([a-zA-Z0-9\\-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@]))*)*)?|/((([a-zA-Z0-9\\-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@]))+(/(([a-zA-Z0-9\\-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@]))*)*)?)$"
}
],
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
},
"SpecificAssetId": {
"allOf": [
{
"$ref": "#/definitions/HasSemantics"
},
{
"properties": {
"externalSubjectId": {
"$ref": "#/definitions/Reference"
},
"name": {
"maxLength": 64,
"minLength": 1,
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$",
"type": "string"
},
"value": {
"maxLength": 2000,
"minLength": 1,
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$",
"type": "string"
}
},
"required": [
"name",
"value"
]
}
]
},
"StateOfEvent": {
"enum": [
"off",
"on"
],
"type": "string"
},
"Submodel": {
"allOf": [
{
"$ref": "#/definitions/Identifiable"
},
{
"$ref": "#/definitions/HasKind"
},
{
"$ref": "#/definitions/HasSemantics"
},
{
"$ref": "#/definitions/Qualifiable"
},
{
"$ref": "#/definitions/HasDataSpecification"
},
{
"properties": {
"modelType": {
"const": "Submodel"
},
"submodelElements": {
"items": {
"$ref": "#/definitions/SubmodelElement_choice"
},
"minItems": 1,
"type": "array"
}
}
}
]
},
"SubmodelElement": {
"allOf": [
{
"$ref": "#/definitions/Referable"
},
{
"$ref": "#/definitions/HasSemantics"
},
{
"$ref": "#/definitions/Qualifiable"
},
{
"$ref": "#/definitions/HasDataSpecification"
}
]
},
"SubmodelElementCollection": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"modelType": {
"const": "SubmodelElementCollection"
},
"value": {
"items": {
"$ref": "#/definitions/SubmodelElement_choice"
},
"minItems": 1,
"type": "array"
}
}
}
]
},
"SubmodelElementList": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"modelType": {
"const": "SubmodelElementList"
},
"orderRelevant": {
"type": "boolean"
},
"semanticIdListElement": {
"$ref": "#/definitions/Reference"
},
"typeValueListElement": {
"$ref": "#/definitions/AasSubmodelElements"
},
"value": {
"items": {
"$ref": "#/definitions/SubmodelElement_choice"
},
"minItems": 1,
"type": "array"
},
"valueTypeListElement": {
"$ref": "#/definitions/DataTypeDefXsd"
}
},
"required": [
"typeValueListElement"
]
}
]
},
"SubmodelElement_choice": {
"oneOf": [
{
"$ref": "#/definitions/RelationshipElement"
},
{
"$ref": "#/definitions/AnnotatedRelationshipElement"
},
{
"$ref": "#/definitions/BasicEventElement"
},
{
"$ref": "#/definitions/Blob"
},
{
"$ref": "#/definitions/Capability"
},
{
"$ref": "#/definitions/Entity"
},
{
"$ref": "#/definitions/File"
},
{
"$ref": "#/definitions/MultiLanguageProperty"
},
{
"$ref": "#/definitions/Operation"
},
{
"$ref": "#/definitions/Property"
},
{
"$ref": "#/definitions/Range"
},
{
"$ref": "#/definitions/ReferenceElement"
},
{
"$ref": "#/definitions/SubmodelElementCollection"
},
{
"$ref": "#/definitions/SubmodelElementList"
}
]
},
"ValueList": {
"properties": {
"valueReferencePairs": {
"items": {
"$ref": "#/definitions/ValueReferencePair"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"valueReferencePairs"
],
"type": "object"
},
"ValueReferencePair": {
"properties": {
"value": {
"maxLength": 2000,
"minLength": 1,
"pattern": "^([\\t\\n\\r -\ud7ff\ue000-\ufffd]|\\ud800[\\udc00-\\udfff]|[\\ud801-\\udbfe][\\udc00-\\udfff]|\\udbff[\\udc00-\\udfff])*$",
"type": "string"
},
"valueId": {
"$ref": "#/definitions/Reference"
}
},
"required": [
"value",
"valueId"
],
"type": "object"
}
},
"title": "AssetAdministrationShellEnvironment",
"type": "object"
} | MIT | en |
eclipse-basyx/basyx-rust-sdk | 13cbd24b63a29a18d80058df1446fdc0c76edf4c | 2021-11-02T14:09:04 | schema/aas.json | 6 | 2024-05-27T05:38:12.778257Z | {
"$id": "http://www.admin-shell.io/schema/json/V3.0RC01",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"definitions": {
"AccessControl": {
"properties": {
"accessPermissionRule": {
"items": {
"$ref": "#/definitions/AccessPermissionRule"
},
"type": "array"
},
"defaultEnvironmentAttributes": {
"$ref": "#/definitions/Reference"
},
"defaultPermissions": {
"$ref": "#/definitions/Reference"
},
"defaultSubjectAttributes": {
"$ref": "#/definitions/Reference"
},
"selectableEnvironmentAttributes": {
"$ref": "#/definitions/Reference"
},
"selectablePermissions": {
"$ref": "#/definitions/Reference"
},
"selectableSubjectAttributes": {
"$ref": "#/definitions/Reference"
}
},
"type": "object"
},
"AccessControlPolicyPoints": {
"properties": {
"policyAdministrationPoint": {
"$ref": "#/definitions/PolicyAdministrationPoint"
},
"policyDecisionPoint": {
"$ref": "#/definitions/PolicyDecisionPoint"
},
"policyEnforcementPoint": {
"$ref": "#/definitions/PolicyEnforcementPoint"
},
"policyInformationPoints": {
"$ref": "#/definitions/PolicyInformationPoints"
}
},
"required": [
"policyAdministrationPoint",
"policyDecisionPoint",
"policyEnforcementPoint"
],
"type": "object"
},
"AccessPermissionRule": {
"allOf": [
{
"$ref": "#/definitions/Referable"
},
{
"$ref": "#/definitions/Qualifiable"
},
{
"properties": {
"permissionsPerObject": {
"items": {
"$ref": "#/definitions/PermissionsPerObject"
},
"type": "array"
},
"targetSubjectAttributes": {
"items": {
"$ref": "#/definitions/SubjectAttributes"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"targetSubjectAttributes"
]
}
]
},
"AdministrativeInformation": {
"properties": {
"revision": {
"type": "string"
},
"version": {
"type": "string"
}
},
"type": "object"
},
"AnnotatedRelationshipElement": {
"allOf": [
{
"$ref": "#/definitions/RelationshipElement"
},
{
"properties": {
"annotation": {
"items": {
"oneOf": [
{
"$ref": "#/definitions/Blob"
},
{
"$ref": "#/definitions/File"
},
{
"$ref": "#/definitions/MultiLanguageProperty"
},
{
"$ref": "#/definitions/Property"
},
{
"$ref": "#/definitions/Range"
},
{
"$ref": "#/definitions/ReferenceElement"
}
]
},
"type": "array"
}
}
}
]
},
"Asset": {
"allOf": [
{
"$ref": "#/definitions/Identifiable"
},
{
"$ref": "#/definitions/HasDataSpecification"
}
]
},
"AssetAdministrationShell": {
"allOf": [
{
"$ref": "#/definitions/Identifiable"
},
{
"$ref": "#/definitions/HasDataSpecification"
},
{
"properties": {
"assetInformation": {
"$ref": "#/definitions/AssetInformation"
},
"derivedFrom": {
"$ref": "#/definitions/Reference"
},
"security": {
"$ref": "#/definitions/Security"
},
"submodels": {
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"views": {
"items": {
"$ref": "#/definitions/View"
},
"type": "array"
}
},
"required": [
"assetInformation"
]
}
]
},
"AssetInformation": {
"allOf": [
{
"properties": {
"assetKind": {
"$ref": "#/definitions/AssetKind"
},
"billOfMaterial": {
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"globalAssetId": {
"$ref": "#/definitions/Reference"
},
"specificAssetIds": {
"items": {
"$ref": "#/definitions/IdentifierKeyValuePair"
},
"type": "array"
},
"thumbnail": {
"$ref": "#/definitions/File"
}
},
"required": [
"assetKind"
]
}
]
},
"AssetKind": {
"enum": [
"Type",
"Instance"
],
"type": "string"
},
"BasicEvent": {
"allOf": [
{
"$ref": "#/definitions/Event"
},
{
"properties": {
"observed": {
"$ref": "#/definitions/Reference"
}
},
"required": [
"observed"
]
}
]
},
"Blob": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"mimeType": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"mimeType"
]
}
]
},
"BlobCertificate": {
"allOf": [
{
"$ref": "#/definitions/Certificate"
},
{
"properties": {
"blobCertificate": {
"$ref": "#/definitions/Blob"
},
"containedExtension": {
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"lastCertificate": {
"type": "boolean"
}
}
}
]
},
"Capability": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
}
]
},
"Certificate": {
"type": "object"
},
"ConceptDescription": {
"allOf": [
{
"$ref": "#/definitions/Identifiable"
},
{
"$ref": "#/definitions/HasDataSpecification"
},
{
"properties": {
"isCaseOf": {
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
}
}
}
]
},
"Constraint": {
"properties": {
"modelType": {
"$ref": "#/definitions/ModelType"
}
},
"required": [
"modelType"
],
"type": "object"
},
"DataSpecificationContent": {
"oneOf": [
{
"$ref": "#/definitions/DataSpecificationIEC61360Content"
},
{
"$ref": "#/definitions/DataSpecificationPhysicalUnitContent"
}
]
},
"DataSpecificationIEC61360Content": {
"allOf": [
{
"$ref": "#/definitions/ValueObject"
},
{
"properties": {
"dataType": {
"enum": [
"DATE",
"STRING",
"STRING_TRANSLATABLE",
"REAL_MEASURE",
"REAL_COUNT",
"REAL_CURRENCY",
"BOOLEAN",
"URL",
"RATIONAL",
"RATIONAL_MEASURE",
"TIME",
"TIMESTAMP",
"INTEGER_COUNT",
"INTEGER_MEASURE",
"INTEGER_CURRENCY"
]
},
"definition": {
"items": {
"$ref": "#/definitions/LangString"
},
"type": "array"
},
"levelType": {
"items": {
"$ref": "#/definitions/LevelType"
},
"type": "array"
},
"preferredName": {
"items": {
"$ref": "#/definitions/LangString"
},
"type": "array"
},
"shortName": {
"items": {
"$ref": "#/definitions/LangString"
},
"type": "array"
},
"sourceOfDefinition": {
"type": "string"
},
"symbol": {
"type": "string"
},
"unit": {
"type": "string"
},
"unitId": {
"$ref": "#/definitions/Reference"
},
"valueFormat": {
"type": "string"
},
"valueList": {
"$ref": "#/definitions/ValueList"
}
},
"required": [
"preferredName"
],
"type": "object"
}
]
},
"DataSpecificationPhysicalUnitContent": {
"properties": {
"conversionFactor": {
"type": "string"
},
"definition": {
"items": {
"$ref": "#/definitions/LangString"
},
"type": "array"
},
"dinNotation": {
"type": "string"
},
"eceCode": {
"type": "string"
},
"eceName": {
"type": "string"
},
"nistName": {
"type": "string"
},
"registrationAuthorityId": {
"type": "string"
},
"siName": {
"type": "string"
},
"siNotation": {
"type": "string"
},
"sourceOfDefinition": {
"type": "string"
},
"supplier": {
"type": "string"
},
"unitName": {
"type": "string"
},
"unitSymbol": {
"type": "string"
}
},
"required": [
"unitName",
"unitSymbol",
"definition"
],
"type": "object"
},
"EmbeddedDataSpecification": {
"properties": {
"dataSpecification": {
"$ref": "#/definitions/Reference"
},
"dataSpecificationContent": {
"$ref": "#/definitions/DataSpecificationContent"
}
},
"required": [
"dataSpecification",
"dataSpecificationContent"
],
"type": "object"
},
"Entity": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"entityType": {
"$ref": "#/definitions/EntityType"
},
"globalAssetId": {
"$ref": "#/definitions/Reference"
},
"specificAssetIds": {
"$ref": "#/definitions/IdentifierKeyValuePair"
},
"statements": {
"items": {
"$ref": "#/definitions/SubmodelElement"
},
"type": "array"
}
},
"required": [
"entityType"
]
}
]
},
"EntityType": {
"enum": [
"CoManagedEntity",
"SelfManagedEntity"
],
"type": "string"
},
"Event": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
}
]
},
"Extension": {
"allOf": [
{
"$ref": "#/definitions/HasSemantics"
},
{
"properties": {
"name": {
"type": "string"
},
"refersTo": {
"$ref": "#/definitions/Reference"
},
"value": {
"type": "string"
},
"valueType": {
"enum": [
"anyUri",
"base64Binary",
"boolean",
"date",
"dateTime",
"dateTimeStamp",
"decimal",
"integer",
"long",
"int",
"short",
"byte",
"nonNegativeInteger",
"positiveInteger",
"unsignedLong",
"unsignedInt",
"unsignedShort",
"unsignedByte",
"nonPositiveInteger",
"negativeInteger",
"double",
"duration",
"dayTimeDuration",
"yearMonthDuration",
"float",
"gDay",
"gMonth",
"gMonthDay",
"gYear",
"gYearMonth",
"hexBinary",
"NOTATION",
"QName",
"string",
"normalizedString",
"token",
"language",
"Name",
"NCName",
"ENTITY",
"ID",
"IDREF",
"NMTOKEN",
"time"
],
"type": "string"
}
},
"required": [
"name"
]
}
]
},
"File": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"mimeType": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"mimeType"
]
}
]
},
"Formula": {
"allOf": [
{
"$ref": "#/definitions/Constraint"
},
{
"properties": {
"dependsOn": {
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
}
}
}
]
},
"HasDataSpecification": {
"properties": {
"embeddedDataSpecifications": {
"items": {
"$ref": "#/definitions/EmbeddedDataSpecification"
},
"type": "array"
}
},
"type": "object"
},
"HasExtensions": {
"properties": {
"extensions": {
"items": {
"$ref": "#/definitions/Extension"
},
"type": "array"
}
},
"type": "object"
},
"HasSemantics": {
"properties": {
"semanticId": {
"$ref": "#/definitions/Reference"
}
},
"type": "object"
},
"Identifiable": {
"allOf": [
{
"$ref": "#/definitions/Referable"
},
{
"properties": {
"administration": {
"$ref": "#/definitions/AdministrativeInformation"
},
"identification": {
"$ref": "#/definitions/Identifier"
}
},
"required": [
"identification"
]
}
]
},
"Identifier": {
"properties": {
"id": {
"type": "string"
},
"idType": {
"$ref": "#/definitions/KeyType"
}
},
"required": [
"id",
"idType"
],
"type": "object"
},
"IdentifierKeyValuePair": {
"allOf": [
{
"$ref": "#/definitions/HasSemantics"
},
{
"properties": {
"key": {
"type": "string"
},
"subjectId": {
"$ref": "#/definitions/Reference"
},
"value": {
"type": "string"
}
},
"required": [
"key",
"value",
"subjectId"
]
}
]
},
"Key": {
"properties": {
"idType": {
"$ref": "#/definitions/KeyType"
},
"type": {
"$ref": "#/definitions/KeyElements"
},
"value": {
"type": "string"
}
},
"required": [
"type",
"idType",
"value"
],
"type": "object"
},
"KeyElements": {
"enum": [
"Asset",
"AssetAdministrationShell",
"ConceptDescription",
"Submodel",
"AccessPermissionRule",
"AnnotatedRelationshipElement",
"BasicEvent",
"Blob",
"Capability",
"DataElement",
"File",
"Entity",
"Event",
"MultiLanguageProperty",
"Operation",
"Property",
"Range",
"ReferenceElement",
"RelationshipElement",
"SubmodelElement",
"SubmodelElementCollection",
"View",
"GlobalReference",
"FragmentReference"
],
"type": "string"
},
"KeyType": {
"enum": [
"Custom",
"IRDI",
"IRI",
"IdShort",
"FragmentId"
],
"type": "string"
},
"LangString": {
"properties": {
"language": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"language",
"text"
],
"type": "object"
},
"LevelType": {
"enum": [
"Min",
"Max",
"Nom",
"Typ"
],
"type": "string"
},
"ModelType": {
"properties": {
"name": {
"$ref": "#/definitions/ModelTypes"
}
},
"required": [
"name"
],
"type": "object"
},
"ModelTypes": {
"enum": [
"Asset",
"AssetAdministrationShell",
"ConceptDescription",
"Submodel",
"AccessPermissionRule",
"AnnotatedRelationshipElement",
"BasicEvent",
"Blob",
"Capability",
"DataElement",
"File",
"Entity",
"Event",
"MultiLanguageProperty",
"Operation",
"Property",
"Range",
"ReferenceElement",
"RelationshipElement",
"SubmodelElement",
"SubmodelElementCollection",
"View",
"GlobalReference",
"FragmentReference",
"Constraint",
"Formula",
"Qualifier"
],
"type": "string"
},
"ModelingKind": {
"enum": [
"Template",
"Instance"
],
"type": "string"
},
"MultiLanguageProperty": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"value": {
"items": {
"$ref": "#/definitions/LangString"
},
"type": "array"
},
"valueId": {
"$ref": "#/definitions/Reference"
}
}
}
]
},
"ObjectAttributes": {
"properties": {
"objectAttribute": {
"items": {
"$ref": "#/definitions/Property"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
},
"Operation": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"inoutputVariable": {
"items": {
"$ref": "#/definitions/OperationVariable"
},
"type": "array"
},
"inputVariable": {
"items": {
"$ref": "#/definitions/OperationVariable"
},
"type": "array"
},
"outputVariable": {
"items": {
"$ref": "#/definitions/OperationVariable"
},
"type": "array"
}
}
}
]
},
"OperationVariable": {
"properties": {
"value": {
"oneOf": [
{
"$ref": "#/definitions/Blob"
},
{
"$ref": "#/definitions/File"
},
{
"$ref": "#/definitions/Capability"
},
{
"$ref": "#/definitions/Entity"
},
{
"$ref": "#/definitions/Event"
},
{
"$ref": "#/definitions/BasicEvent"
},
{
"$ref": "#/definitions/MultiLanguageProperty"
},
{
"$ref": "#/definitions/Operation"
},
{
"$ref": "#/definitions/Property"
},
{
"$ref": "#/definitions/Range"
},
{
"$ref": "#/definitions/ReferenceElement"
},
{
"$ref": "#/definitions/RelationshipElement"
},
{
"$ref": "#/definitions/SubmodelElementCollection"
}
]
}
},
"required": [
"value"
],
"type": "object"
},
"Permission": {
"properties": {
"kindOfPermission": {
"enum": [
"Allow",
"Deny",
"NotApplicable",
"Undefined"
],
"type": "string"
},
"permission": {
"$ref": "#/definitions/Reference"
}
},
"required": [
"permission",
"kindOfPermission"
],
"type": "object"
},
"PermissionsPerObject": {
"properties": {
"object": {
"$ref": "#/definitions/Reference"
},
"permission": {
"items": {
"$ref": "#/definitions/Permission"
},
"type": "array"
},
"targetObjectAttributes": {
"$ref": "#/definitions/ObjectAttributes"
}
},
"type": "object"
},
"PolicyAdministrationPoint": {
"properties": {
"externalAccessControl": {
"type": "boolean"
},
"localAccessControl": {
"$ref": "#/definitions/AccessControl"
}
},
"required": [
"externalAccessControl"
],
"type": "object"
},
"PolicyDecisionPoint": {
"properties": {
"externalPolicyDecisionPoints": {
"type": "boolean"
}
},
"required": [
"externalPolicyDecisionPoints"
],
"type": "object"
},
"PolicyEnforcementPoint": {
"properties": {
"externalPolicyEnforcementPoint": {
"type": "boolean"
}
},
"required": [
"externalPolicyEnforcementPoint"
],
"type": "object"
},
"PolicyInformationPoints": {
"properties": {
"externalInformationPoint": {
"type": "boolean"
},
"internalInformationPoint": {
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
}
},
"required": [
"externalInformationPoint"
],
"type": "object"
},
"Property": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"$ref": "#/definitions/ValueObject"
}
]
},
"Qualifiable": {
"properties": {
"qualifiers": {
"items": {
"$ref": "#/definitions/Constraint"
},
"type": "array"
}
},
"type": "object"
},
"Qualifier": {
"allOf": [
{
"$ref": "#/definitions/Constraint"
},
{
"$ref": "#/definitions/HasSemantics"
},
{
"$ref": "#/definitions/ValueObject"
},
{
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
]
}
]
},
"Range": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"max": {
"type": "string"
},
"min": {
"type": "string"
},
"valueType": {
"enum": [
"anyUri",
"base64Binary",
"boolean",
"date",
"dateTime",
"dateTimeStamp",
"decimal",
"integer",
"long",
"int",
"short",
"byte",
"nonNegativeInteger",
"positiveInteger",
"unsignedLong",
"unsignedInt",
"unsignedShort",
"unsignedByte",
"nonPositiveInteger",
"negativeInteger",
"double",
"duration",
"dayTimeDuration",
"yearMonthDuration",
"float",
"gDay",
"gMonth",
"gMonthDay",
"gYear",
"gYearMonth",
"hexBinary",
"NOTATION",
"QName",
"string",
"normalizedString",
"token",
"language",
"Name",
"NCName",
"ENTITY",
"ID",
"IDREF",
"NMTOKEN",
"time"
],
"type": "string"
}
},
"required": [
"valueType"
]
}
]
},
"Referable": {
"allOf": [
{
"$ref": "#/definitions/HasExtensions"
},
{
"properties": {
"category": {
"type": "string"
},
"description": {
"items": {
"$ref": "#/definitions/LangString"
},
"type": "array"
},
"displayName": {
"type": "string"
},
"idShort": {
"type": "string"
},
"modelType": {
"$ref": "#/definitions/ModelType"
}
},
"required": [
"modelType",
"idShort"
]
}
]
},
"Reference": {
"properties": {
"keys": {
"items": {
"$ref": "#/definitions/Key"
},
"type": "array"
}
},
"required": [
"keys"
],
"type": "object"
},
"ReferenceElement": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"value": {
"$ref": "#/definitions/Reference"
}
}
}
]
},
"RelationshipElement": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"first": {
"$ref": "#/definitions/Reference"
},
"second": {
"$ref": "#/definitions/Reference"
}
},
"required": [
"first",
"second"
]
}
]
},
"Security": {
"properties": {
"accessControlPolicyPoints": {
"$ref": "#/definitions/AccessControlPolicyPoints"
},
"certificate": {
"items": {
"oneOf": [
{
"$ref": "#/definitions/BlobCertificate"
}
]
},
"type": "array"
},
"requiredCertificateExtension": {
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
}
},
"required": [
"accessControlPolicyPoints"
],
"type": "object"
},
"SubjectAttributes": {
"properties": {
"subjectAttributes": {
"items": {
"$ref": "#/definitions/Reference"
},
"minItems": 1,
"type": "array"
}
},
"type": "object"
},
"Submodel": {
"allOf": [
{
"$ref": "#/definitions/Identifiable"
},
{
"$ref": "#/definitions/HasDataSpecification"
},
{
"$ref": "#/definitions/Qualifiable"
},
{
"$ref": "#/definitions/HasSemantics"
},
{
"properties": {
"kind": {
"$ref": "#/definitions/ModelingKind"
},
"submodelElements": {
"items": {
"$ref": "#/definitions/SubmodelElement"
},
"type": "array"
}
}
}
]
},
"SubmodelElement": {
"allOf": [
{
"$ref": "#/definitions/Referable"
},
{
"$ref": "#/definitions/HasDataSpecification"
},
{
"$ref": "#/definitions/HasSemantics"
},
{
"$ref": "#/definitions/Qualifiable"
},
{
"properties": {
"idShort": {
"type": "string"
},
"kind": {
"$ref": "#/definitions/ModelingKind"
}
},
"required": [
"idShort"
]
}
]
},
"SubmodelElementCollection": {
"allOf": [
{
"$ref": "#/definitions/SubmodelElement"
},
{
"properties": {
"allowDuplicates": {
"type": "boolean"
},
"ordered": {
"type": "boolean"
},
"value": {
"items": {
"oneOf": [
{
"$ref": "#/definitions/Blob"
},
{
"$ref": "#/definitions/File"
},
{
"$ref": "#/definitions/Capability"
},
{
"$ref": "#/definitions/Entity"
},
{
"$ref": "#/definitions/Event"
},
{
"$ref": "#/definitions/BasicEvent"
},
{
"$ref": "#/definitions/MultiLanguageProperty"
},
{
"$ref": "#/definitions/Operation"
},
{
"$ref": "#/definitions/Property"
},
{
"$ref": "#/definitions/Range"
},
{
"$ref": "#/definitions/ReferenceElement"
},
{
"$ref": "#/definitions/RelationshipElement"
},
{
"$ref": "#/definitions/SubmodelElementCollection"
}
]
},
"type": "array"
}
}
}
]
},
"ValueList": {
"properties": {
"valueReferencePairTypes": {
"items": {
"$ref": "#/definitions/ValueReferencePairType"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"valueReferencePairTypes"
],
"type": "object"
},
"ValueObject": {
"properties": {
"value": {
"type": "string"
},
"valueId": {
"$ref": "#/definitions/Reference"
},
"valueType": {
"enum": [
"anyUri",
"base64Binary",
"boolean",
"date",
"dateTime",
"dateTimeStamp",
"decimal",
"integer",
"long",
"int",
"short",
"byte",
"nonNegativeInteger",
"positiveInteger",
"unsignedLong",
"unsignedInt",
"unsignedShort",
"unsignedByte",
"nonPositiveInteger",
"negativeInteger",
"double",
"duration",
"dayTimeDuration",
"yearMonthDuration",
"float",
"gDay",
"gMonth",
"gMonthDay",
"gYear",
"gYearMonth",
"hexBinary",
"NOTATION",
"QName",
"string",
"normalizedString",
"token",
"language",
"Name",
"NCName",
"ENTITY",
"ID",
"IDREF",
"NMTOKEN",
"time"
],
"type": "string"
}
},
"type": "object"
},
"ValueReferencePairType": {
"allOf": [
{
"$ref": "#/definitions/ValueObject"
}
]
},
"View": {
"allOf": [
{
"$ref": "#/definitions/Referable"
},
{
"$ref": "#/definitions/HasDataSpecification"
},
{
"$ref": "#/definitions/HasSemantics"
},
{
"properties": {
"containedElements": {
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
}
}
}
]
}
},
"properties": {
"assetAdministrationShells": {
"items": {
"$ref": "#/definitions/AssetAdministrationShell"
},
"type": "array"
},
"assets": {
"items": {
"$ref": "#/definitions/Asset"
},
"type": "array"
},
"conceptDescriptions": {
"items": {
"$ref": "#/definitions/ConceptDescription"
},
"type": "array"
},
"submodels": {
"items": {
"$ref": "#/definitions/Submodel"
},
"type": "array"
}
},
"required": [
"assetAdministrationShells",
"submodels",
"assets",
"conceptDescriptions"
],
"title": "AssetAdministrationShellEnvironment",
"type": "object"
} | MIT | en |
axelarnetwork/axelar-configs | b8d47987bf175d5a29de02d3ade87750a143d082 | 2023-08-14T22:57:42 | registry/schemas/assetlist.schema.json | 5 | 2024-05-27T04:44:32.137886Z | {
"$defs": {
"asset": {
"additionalProperties": false,
"if": {
"properties": {
"type_asset": {
"enum": [
"erc20",
"cw20",
"snip20"
]
}
},
"required": [
"type_asset"
]
},
"properties": {
"address": {
"description": "[OPTIONAL] The address of the asset. Only required for type_asset : cw20, snip20",
"type": "string"
},
"base": {
"description": "The base unit of the asset. Must be in denom_units.",
"type": "string"
},
"coingecko_id": {
"description": "[OPTIONAL] The coingecko id to fetch asset data from coingecko v3 api. See https://api.coingecko.com/api/v3/coins/list",
"type": "string"
},
"denom_units": {
"items": {
"$ref": "#/$defs/denom_unit"
},
"minContains": 1,
"type": "array"
},
"description": {
"description": "[OPTIONAL] A short description of the asset",
"type": "string"
},
"display": {
"description": "The human friendly unit of the asset. Must be in denom_units.",
"type": "string"
},
"ibc": {
"additionalProperties": false,
"description": "[OPTIONAL] IBC Channel between src and dst between chain",
"properties": {
"dst_channel": {
"type": "string"
},
"source_channel": {
"type": "string"
},
"source_denom": {
"type": "string"
}
},
"required": [
"source_channel",
"dst_channel",
"source_denom"
],
"type": "object"
},
"images": {
"items": {
"additionalProperties": false,
"properties": {
"png": {
"format": "uri-reference",
"pattern": "^https://raw\\.githubusercontent\\.com/cosmos/chain-registry/master/(|testnets/|_non-cosmos/)[a-z0-9]+/images/.+\\.png$",
"type": "string"
},
"svg": {
"format": "uri-reference",
"pattern": "^https://raw\\.githubusercontent\\.com/cosmos/chain-registry/master/(|testnets/|_non-cosmos/)[a-z0-9]+/images/.+\\.svg$",
"type": "string"
},
"theme": {
"additionalProperties": false,
"properties": {
"primary_color_hex": {
"pattern": "^#[0-9a-fA-F]{6}$",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"minItems": 1,
"type": "array"
},
"keywords": {
"items": {
"type": "string"
},
"maxContains": 20,
"minContains": 1,
"type": "array"
},
"logo_URIs": {
"additionalProperties": false,
"properties": {
"png": {
"format": "uri-reference",
"pattern": "^https://raw\\.githubusercontent\\.com/cosmos/chain-registry/master/(|testnets/|_non-cosmos/)[a-z0-9]+/images/.+\\.png$",
"type": "string"
},
"svg": {
"format": "uri-reference",
"pattern": "^https://raw\\.githubusercontent\\.com/cosmos/chain-registry/master/(|testnets/|_non-cosmos/)[a-z0-9]+/images/.+\\.svg$",
"type": "string"
}
},
"type": "object"
},
"name": {
"description": "The project name of the asset. For example Bitcoin.",
"type": "string"
},
"symbol": {
"description": "The symbol of an asset. For example BTC.",
"type": "string"
},
"traces": {
"description": "The origin of the asset, starting with the index, and capturing all transitions in form and location.",
"items": {
"anyOf": [
{
"$ref": "#/$defs/ibc_transition"
},
{
"$ref": "#/$defs/ibc_cw20_transition"
},
{
"$ref": "#/$defs/non_ibc_transition"
}
]
},
"minContains": 1,
"type": "array"
},
"type_asset": {
"default": "sdk.coin",
"description": "[OPTIONAL] The potential options for type of asset. By default, assumes sdk.coin",
"enum": [
"sdk.coin",
"cw20",
"erc20",
"ics20",
"snip20",
"snip25"
],
"type": "string"
}
},
"required": [
"denom_units",
"base",
"display",
"name",
"symbol"
],
"then": {
"required": [
"address"
]
},
"type": "object"
},
"asset_pointer": {
"additionalProperties": false,
"description": "The (primary) key used to identify an asset defined within the Chain Registry.",
"properties": {
"base_denom": {
"description": "The base unit of the asset on its source platform. E.g., when describing ATOM from Cosmos Hub, specify 'uatom', NOT 'atom' nor 'ATOM'; base units are unique per platform.",
"type": "string"
},
"platform": {
"description": "The platform from which the asset originates. E.g., 'cosmoshub', 'ethereum', 'forex', or 'nasdaq'",
"type": "string"
}
},
"required": [
"platform",
"base_denom"
],
"type": "object"
},
"denom_unit": {
"additionalProperties": false,
"properties": {
"aliases": {
"items": {
"type": "string"
},
"minContains": 1,
"type": "array"
},
"denom": {
"type": "string"
},
"exponent": {
"type": "integer"
}
},
"required": [
"denom",
"exponent"
],
"type": "object"
},
"ibc_cw20_transition": {
"additionalProperties": false,
"properties": {
"chain": {
"additionalProperties": false,
"properties": {
"channel_id": {
"description": "The chain's IBC transfer channel(, e.g., 'channel-1').",
"pattern": "^channel-\\d+$",
"type": "string"
},
"path": {
"description": "The port/channel/denom input string that generates the 'ibc/...' denom.",
"type": "string"
},
"port": {
"description": "The port used to transfer IBC assets; often 'transfer', but sometimes varies, e.g., for outgoing cw20 transfers.",
"type": "string"
}
},
"required": [
"port",
"channel_id",
"path"
],
"type": "object"
},
"counterparty": {
"additionalProperties": false,
"properties": {
"base_denom": {
"description": "The base unit of the asset on its source platform. E.g., when describing ATOM from Cosmos Hub, specify 'uatom', NOT 'atom' nor 'ATOM'; base units are unique per platform.",
"type": "string"
},
"chain_name": {
"description": "The name of the counterparty chain. (must match exactly the chain name used in the Chain Registry)",
"type": "string"
},
"channel_id": {
"description": "The counterparty IBC transfer channel(, e.g., 'channel-1').",
"pattern": "^channel-\\d+$",
"type": "string"
},
"port": {
"description": "The port used to transfer IBC assets; often 'transfer', but sometimes varies, e.g., for outgoing cw20 transfers.",
"type": "string"
}
},
"required": [
"chain_name",
"base_denom",
"port",
"channel_id"
],
"type": "object"
},
"type": {
"enum": [
"ibc-cw20"
],
"type": "string"
}
},
"required": [
"type",
"counterparty",
"chain"
],
"type": "object"
},
"ibc_transition": {
"additionalProperties": false,
"properties": {
"chain": {
"additionalProperties": false,
"properties": {
"channel_id": {
"description": "The chain's IBC transfer channel(, e.g., 'channel-1').",
"pattern": "^channel-\\d+$",
"type": "string"
},
"path": {
"description": "The port/channel/denom input string that generates the 'ibc/...' denom.",
"type": "string"
}
},
"required": [
"channel_id",
"path"
],
"type": "object"
},
"counterparty": {
"additionalProperties": false,
"properties": {
"base_denom": {
"description": "The base unit of the asset on its source platform. E.g., when describing ATOM from Cosmos Hub, specify 'uatom', NOT 'atom' nor 'ATOM'; base units are unique per platform.",
"type": "string"
},
"chain_name": {
"description": "The name of the counterparty chain. (must match exactly the chain name used in the Chain Registry)",
"type": "string"
},
"channel_id": {
"description": "The counterparty IBC transfer channel(, e.g., 'channel-1').",
"pattern": "^channel-\\d+$",
"type": "string"
}
},
"required": [
"chain_name",
"base_denom",
"channel_id"
],
"type": "object"
},
"type": {
"enum": [
"ibc"
],
"type": "string"
}
},
"required": [
"type",
"counterparty",
"chain"
],
"type": "object"
},
"non_ibc_transition": {
"additionalProperties": false,
"properties": {
"chain": {
"additionalProperties": false,
"properties": {
"contract": {
"description": "The contract address where the transition takes place, where applicable. E.g., The Ethereum contract that locks up the asset while it's minted on another chain.",
"type": "string"
}
},
"required": [
"contract"
],
"type": "object"
},
"counterparty": {
"additionalProperties": false,
"properties": {
"base_denom": {
"type": "string"
},
"chain_name": {
"description": "The chain or platform from which the asset originates. E.g., 'cosmoshub', 'ethereum', 'forex', or 'nasdaq'",
"type": "string"
},
"contract": {
"description": "The contract address where the transition takes place, where applicable. E.g., The Ethereum contract that locks up the asset while it's minted on another chain.",
"type": "string"
}
},
"required": [
"chain_name",
"base_denom"
],
"type": "object"
},
"provider": {
"description": "The entity offering the service. E.g., 'Gravity Bridge' [Network] or 'Tether' [Company].",
"type": "string"
},
"type": {
"enum": [
"bridge",
"liquid-stake",
"synthetic",
"wrapped",
"additional-mintage",
"test-mintage"
],
"type": "string"
}
},
"required": [
"type",
"counterparty",
"provider"
],
"type": "object"
}
},
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"description": "Asset lists are a similar mechanism to allow frontends and other UIs to fetch metadata associated with Cosmos SDK denoms, especially for assets sent over IBC.",
"properties": {
"$schema": {
"pattern": "^(\\.\\./)+assetlist\\.schema\\.json$",
"type": "string"
},
"assets": {
"items": {
"$ref": "#/$defs/asset"
},
"minContains": 1,
"type": "array"
},
"chain_name": {
"type": "string"
}
},
"required": [
"chain_name",
"assets"
],
"title": "Asset Lists",
"type": "object"
} | Apache-2.0 | en |
swaldhoer/native-lua | 5024539e847fc5daab71ed309e4ad26c846a6b43 | 2021-06-20T13:09:42 | cfg/compiler-cfg.schema.json | 9 | 2024-05-27T05:31:33.714718Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Compiler setup to compile Lua as part of native Lua",
"properties": {
"CFLAGS": {
"description": "CFLAGS to be passed to the compiler",
"type": "array"
},
"CMCFLAGS": {
"description": "Compiler module CFLAGS to be passed to the compiler",
"type": "array"
},
"DEFINES": {
"description": "DEFINES to be passed to the compiler",
"type": "array"
},
"LINKFLAGS": {
"description": "LINKFLAGS to be passed to the compiler/linker",
"type": "array"
},
"libs": {
"description": "Additional libraries to be passed to the compiler/linker",
"type": "array"
},
"std": {
"description": "The C standard for all source files",
"properties": {
"opt": {
"description": "The argument to set the compiler C standard",
"type": "string"
},
"val": {
"description": "The value of the C standard",
"type": "string"
}
},
"required": [
"opt",
"val"
],
"type": "object"
}
},
"required": [
"std",
"CFLAGS",
"DEFINES",
"CMCFLAGS"
],
"title": "Product",
"type": "object"
} | MIT | en |
laytan/phpls | e5a4ff91dc3ccffe9a47d9db1099195c2f2a538e | 2023-04-14T19:03:28 | internal/config/phpls.schema.json | 25 | 2024-05-27T07:06:00.846709Z | {
"$id": "https://raw.githubusercontent.com/laytan/phpls/main/internal/config/phpls.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "Configuration format for the phpls language server.",
"properties": {
"cache_path": {
"description": "Root directory for generated stubs and logs, defaults to the user cache directory.",
"type": "string"
},
"diagnostics": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"type": "boolean"
},
"phpcs": {
"additionalProperties": false,
"properties": {
"binary": {
"default": [
"vendor/bin/phpcs",
"phpcs"
],
"description": "The paths checked, in order, for the PHPCS binary.",
"example": [
"phpcs"
],
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"enabled": {
"default": true,
"type": "boolean"
},
"method": {
"default": "ON_CHANGE",
"description": "When to run diagnostics, either ON_SAVE or ON_CHANGE.",
"enum": [
"ON_SAVE",
"ON_CHANGE"
],
"type": "string"
}
},
"type": "object"
},
"phpstan": {
"additionalProperties": false,
"properties": {
"binary": {
"default": [
"vendor/bin/phpstan",
"phpstan"
],
"description": "The paths checked, in order, for the PHPStan binary.",
"example": [
"phpstan"
],
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"enabled": {
"default": true,
"type": "boolean"
},
"method": {
"default": "ON_CHANGE",
"description": "When to run diagnostics, either ON_SAVE or ON_CHANGE.",
"enum": [
"ON_SAVE",
"ON_CHANGE"
],
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"dump_config": {
"default": false,
"description": "Dump the resolved config before validation, useful for debugging.",
"type": "boolean"
},
"extensions": {
"default": [
".php"
],
"description": "File extensions to consider PHP code.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"ignored_directories": {
"default": [
".git",
"node_modules"
],
"description": "Directories to ignore completely, use when you have huge directories with non-php files.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"php": {
"additionalProperties": false,
"properties": {
"binary": {
"default": "php",
"description": "The php binary used to execute external commands like analyzers.",
"example": "valet php",
"type": "string"
},
"version": {
"description": "The PHP version to use when parsing, defaults to the output of 'php -v'.",
"example": "8.1",
"pattern": "^[7-8](\\.[0-9]+){0,2}$",
"type": "string"
}
},
"type": "object"
},
"phpcbf": {
"additionalProperties": false,
"properties": {
"binary": {
"default": [
"vendor/bin/phpcbf",
"phpcbf"
],
"description": "The paths checked, in order, for the PHPCBF binary.",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"enabled": {
"default": true,
"description": "Enable formatting using PHPCBF.",
"type": "boolean"
},
"standard": {
"description": "The PHPCS standard to format according to, NOTE: if this is set, the project level config is ignored.",
"type": "string"
}
},
"type": "object"
},
"server": {
"additionalProperties": false,
"properties": {
"client_pid": {
"description": "A process ID to watch for exits, server will exit when it exits.",
"format": "int32",
"minimum": 0,
"type": "integer"
},
"communication": {
"default": "stdio",
"description": "How to communicate: standard io, web sockets or tcp.",
"enum": [
"stdio",
"ws",
"tcp"
],
"type": "string"
},
"url": {
"default": "127.0.0.1:2001",
"description": "The URL to use for the websocket or tcp server.",
"type": "string"
}
},
"type": "object"
},
"statsviz": {
"additionalProperties": false,
"properties": {
"enabled": {
"default": false,
"description": "Visualize the server's memory usage, cpu usage, threads and other stats. NOTE: comes with a performance cost.",
"type": "boolean"
},
"url": {
"default": "localhost:6060",
"description": "Where to serve the visualizations.",
"type": "string"
}
},
"type": "object"
}
},
"title": "phpls",
"type": "object"
} | Apache-2.0 | en |
joaopgrassi/otel-recipes | fc0abae00d6503c0189c756b6a7354fed2a4bc10 | 2021-12-19T16:42:36 | otel-recipes-schema.json | 43 | 2024-05-27T05:31:02.973173Z | {
"$id": "https://example.com/product.schema.json",
"$schema": "http://json-schema.org/draft-04/schema",
"definitions": {
"appContent": {
"properties": {
"dependencies": {
"description": "The list of OpenTelemetry dependencies.",
"items": {
"$ref": "#/definitions/dependencyContent"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"recipeFile": {
"description": "The name of the file that contains the recipe to display on the website.",
"type": "string"
},
"source": {
"description": "The link to the source code of the app on GitHub.",
"format": "uri",
"type": "string"
},
"type": {
"default": "console",
"description": "The type of app.",
"enum": [
"console",
"api",
"webapp"
],
"type": "string"
}
},
"required": [
"type",
"source",
"recipeFile",
"dependencies"
],
"type": "object"
},
"dependencyContent": {
"properties": {
"id": {
"description": "The id/name of the dependency.",
"type": "string"
},
"version": {
"description": "The version of the depedency needed.",
"type": "string"
}
},
"required": [
"id",
"version"
],
"type": "object"
},
"signalContent": {
"properties": {
"apps": {
"description": "The list of the signal's sample apps",
"items": {
"$ref": "#/definitions/appContent"
},
"type": "array",
"uniqueItems": true
},
"type": {
"description": "The type of the signal",
"enum": [
"trace",
"metric",
"log"
],
"type": "string"
}
},
"required": [
"type",
"apps"
],
"type": "object"
}
},
"properties": {
"lang": {
"description": "The name of the language.",
"enum": [
"csharp",
"js",
"go",
"java",
"python"
],
"type": "string"
},
"signals": {
"description": "The list of the languages's signals",
"items": {
"$ref": "#/definitions/signalContent"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"lang",
"signals"
],
"title": "JSON Schema for OTel recipe files",
"type": "object"
} | MIT | en |
joaopgrassi/otel-recipes | 32f43a3d47324a59472bbd7747b2a0bf15ddc6e3 | 2024-05-07T15:18:41 | otel-recipes-schema.json | 43 | 2024-05-27T05:31:02.973173Z | {
"$id": "https://github.com/joaopgrassi/otel-recipes/otel-recipes-schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"definitions": {
"dependencyContent": {
"properties": {
"id": {
"description": "The identifier of the dependency/package the user needs to install",
"type": "string"
},
"version": {
"description": "The version of the depedency/package required for the sample",
"type": "string"
}
},
"required": [
"id",
"version"
],
"type": "object"
},
"stepContent": {
"properties": {
"description": {
"description": "A brief description of the step",
"type": "string"
},
"displayName": {
"description": "The user friendly name of the step. This is shown on the website in the list of steps to follow. E.g. Configure the exporter, Configure the Trace Provider",
"type": "string"
},
"order": {
"default": 1,
"description": "The order in which this step should appear in the list. Starting with 1 for the first step",
"type": "integer"
},
"required": {
"default": true,
"description": "Indicates if this step is mandatory for the user or not",
"type": "boolean"
},
"source": {
"description": "The raw URL (raw.githubusercontent.com) to the file in the sample app that contains the code for this step. It's best to use a link with a ref to a tag/release version instead of using 'main'",
"format": "uri",
"type": "string"
}
},
"required": [
"displayName",
"order",
"source"
],
"type": "object"
}
},
"properties": {
"dependencies": {
"description": "The list of dependencies (packages) necessary to configure OpenTelemetry for the sample",
"items": {
"$ref": "#/definitions/dependencyContent"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A brief description of the sample app. This is shown in the 'sample metadata' section on the website",
"maxLength": 250,
"type": "string"
},
"displayName": {
"description": "The user friendly name of the sample app. This is shown on the website (filters)",
"maxLength": 100,
"type": "string"
},
"id": {
"description": "The unique identifier of the sample app. E.g. console, webapp, rest-api",
"type": "string"
},
"languageId": {
"description": "The unique identifier of the programming language. MUST be one of the suggested by the schema",
"enum": [
"csharp",
"js",
"go",
"java",
"python"
],
"type": "string"
},
"signal": {
"description": "The unique identifier of the telemetry signal. MUST be one of the suggested by the schema",
"enum": [
"traces",
"metrics",
"logs"
],
"type": "string"
},
"sourceRoot": {
"description": "The URL to the root directory of the sample app on GitHub. It's best to use a link with a ref to a tag/release version instead of using 'main'",
"format": "uri",
"type": "string"
},
"steps": {
"description": "The list steps necessary to configure OpenTelemetry for the sample",
"items": {
"$ref": "#/definitions/stepContent"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"tags": {
"additionalItems": false,
"description": "Related tags with the language/technology of the recipe.",
"items": {
"enum": [
"console",
"api",
"db",
"http",
"web",
"manual",
"automatic",
"sampling"
],
"type": "string"
},
"maxItems": 4,
"type": "array"
}
},
"required": [
"id",
"languageId",
"signal",
"displayName",
"description",
"sourceRoot",
"steps",
"dependencies"
],
"title": "JSON Schema for OTel recipe files",
"type": "object"
} | MIT | en |
joaopgrassi/otel-recipes | 5cddca2bb7cf1a6c7fdccad0c24e76b8a3a37097 | 2022-03-14T22:38:25 | otel-recipes-schema.json | 43 | 2024-05-27T05:31:02.973173Z | {
"$id": "https://github.com/joaopgrassi/otel-recipes/otel-recipes-schema.json",
"$schema": "http://json-schema.org/draft-04/schema",
"definitions": {
"dependencyContent": {
"properties": {
"id": {
"description": "The identifier of the dependency/package the user needs to install",
"type": "string"
},
"version": {
"description": "The version of the depedency/package required for the sample",
"type": "string"
}
},
"required": [
"id",
"version"
],
"type": "object"
},
"sampleContent": {
"properties": {
"dependencies": {
"description": "The list of dependencies (packages) necessary to configure OpenTelemetry for the sample",
"items": {
"$ref": "#/definitions/dependencyContent"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
},
"description": {
"description": "A brief description of the sample app. This is shon in the 'sample metadata' section on the website",
"type": "string"
},
"displayName": {
"description": "The user friendly name of the sample app. This is shown on the website (filters)",
"type": "string"
},
"id": {
"description": "The unique identifier of the sample app. E.g. console, webapp, rest-api",
"type": "string"
},
"sourceRoot": {
"description": "The URL to the root directory of the sample app on GitHub. It's best to use a link with a ref to a tag/release version instead of using 'main'",
"format": "uri",
"type": "string"
},
"steps": {
"description": "The list steps necessary to configure OpenTelemetry for the sample",
"items": {
"$ref": "#/definitions/stepContent"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"id",
"displayName",
"description",
"sourceRoot",
"steps",
"dependencies"
],
"type": "object"
},
"signalContent": {
"properties": {
"id": {
"description": "The unique identifier of the telemetry signal. MUST be one of the suggested by the schema",
"enum": [
"trace",
"metric",
"log"
],
"type": "string"
},
"samples": {
"description": "The list of available sample apps for the telemetry signal",
"items": {
"$ref": "#/definitions/sampleContent"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"id",
"samples"
],
"type": "object"
},
"stepContent": {
"properties": {
"description": {
"description": "A brief description of the step",
"type": "string"
},
"displayName": {
"description": "The user friendly name of the step. This is shown on the website in the list of steps to follow. E.g. Configure the exporter, Configure the Trace Provider",
"type": "string"
},
"order": {
"default": 1,
"description": "The order in which this step should appear in the list. Starting with 1 for the first step",
"type": "integer"
},
"required": {
"default": true,
"description": "Indicates if this step is mandatory for the user or not",
"type": "boolean"
},
"source": {
"description": "The raw URL (raw.githubusercontent.com) to the file in the sample app that contains the code for this step. It's best to use a link with a ref to a tag/release version instead of using 'main'",
"format": "uri",
"type": "string"
}
},
"required": [
"displayName",
"order",
"source"
],
"type": "object"
}
},
"properties": {
"languageId": {
"description": "The unique identifier of the programming language. MUST be one of the suggested by the schema",
"enum": [
"csharp",
"js",
"go",
"java",
"python"
],
"type": "string"
},
"signals": {
"description": "The list of telemetry signals for the programming language",
"items": {
"$ref": "#/definitions/signalContent"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"languageId",
"signals"
],
"title": "JSON Schema for OTel recipe files",
"type": "object"
} | MIT | en |
Subsets and Splits