Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-177719.4 KB
oidc

Update OIDC configuration.

Updates the OIDC configuration. Fields set via environment variables cannot be overridden. Leave clientSecret empty to preserve the existing secret.

put/security/oidc

Request body

enabledboolean
issuerstring
clientIdstring
clientSecretstring

Leave empty to keep existing secret

scopestring
defaultPermission'readonly' | 'readwrite' | 'admin'

Signal K permission level

autoCreateUsersboolean
groupsAttributestring
providerNamestring
autoLoginboolean

Example request

{
  "issuer": "https://auth.example.com",
  "scope": "openid email profile"
}

Response

Configuration saved successfully

messagestring

Example response

{
  "message": "OIDC configuration saved"
}