v1

latestOpenAPI 3.0.0Apache 2.02026-07-177719.4 KB

oidc

Get OIDC configuration.

Returns the current OIDC configuration with secrets redacted. Includes indicators for fields overridden by environment variables.

get/security/oidc

Response

OIDC configuration

enabledboolean

Whether OIDC authentication is enabled

issuerstring

OIDC provider issuer URL

clientIdstring

OAuth client ID

clientSecretstring

Always empty (redacted for security)

clientSecretSetboolean

Whether a client secret has been configured

redirectUristring

OAuth redirect URI (optional, auto-generated if not set)

scopestring

OAuth scopes to request

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

Signal K permission level

autoCreateUsersboolean

Automatically create users on first OIDC login

adminGroupsstring[]

Groups that grant admin permission

readwriteGroupsstring[]

Groups that grant read/write permission

groupsAttributestring

ID token claim containing user groups

providerNamestring

Display name shown on login button

autoLoginboolean

Automatically redirect to OIDC provider when not authenticated

envOverridesobject

Fields that are overridden by environment variables

Example response

{
  "issuer": "https://auth.example.com",
  "scope": "openid email profile",
  "adminGroups": [
    "admins",
    "sk-admin"
  ],
  "readwriteGroups": [
    "users",
    "operators"
  ],
  "groupsAttribute": "groups",
  "providerName": "SSO Login"
}