Skip to content

Public pre-auth UI configuration

GET
/api/settings

Returns application settings needed before authentication: banner, consent modal, auth provider flags, password policy, and registration status. No authentication required — the login page and consent banner need this data before the user signs in.

Responses

Public settings for SPA pre-auth UI

application/json
JSON
{
  
"banner": {
  
  
"enabled": true,
  
  
"text": "UNCLASSIFIED",
  
  
"background_color": "#007a33",
  
  
"text_color": "#ffffff"
  
},
  
"consent": {
  
  
"enabled": false,
  
  
"version": 1,
  
  
"title": "Terms of Use",
  
  
"content": "",
  
  
"ttl": 0
  
},
  
"local_login": {
  
  
"enabled": true
  
},
  
"user_registration": {
  
  
"enabled": true
  
},
  
"ldap": {
  
  
"enabled": false,
  
  
"title": null
  
},
  
"oidc": {
  
  
"enabled": false,
  
  
"title": null
  
},
  
"smtp": {
  
  
"enabled": false
  
},
  
"password": {
  
  
"min_length": 15,
  
  
"min_uppercase": 2,
  
  
"min_lowercase": 2,
  
  
"min_number": 2,
  
  
"min_special": 2
  
},
  
"lockout": {
  
  
"enabled": true,
  
  
"maximum_attempts": 3,
  
  
"last_attempt_warning": true
  
}
}

Playground

Samples

Powered by VitePress OpenAPI

Part of the MITRE Security Automation Framework (SAF)