Skip to main content
Single sign-on
Access & SecuritySourceAPIChangelog

Reference

Settings​

Admin​

Set by an admin in Settings, under the plugin's name. It applies to everyone.

SettingTypeDefaultWhat it does
Sign in with SSO automaticallybooleanfalseSend visitors straight to the first SSO provider instead of showing the login form. The OIDC_SILENT_LOGIN_DEFAULT environment variable overrides this.
Let users link their accountbooleantrueUsers can link a single sign-on account to their Termix account in Settings, Security. Off, only admins can link accounts.

Environment variables​

Set these on the Termix server, for example under environment: in your compose file. See environment variables for the ones core and other plugins read.

VariableDefaultWhat it does
OIDC_CLIENT_IDClient ID of an OIDC provider set from the environment. Needs the next four too.
OIDC_CLIENT_SECRETIts client secret.
OIDC_ISSUER_URLIts issuer URL.
OIDC_AUTHORIZATION_URLIts authorization endpoint.
OIDC_TOKEN_URLIts token endpoint.
OIDC_USERINFO_URLIts userinfo endpoint, if it is not the usual one.
OIDC_IDENTIFIER_PATHsubClaim that identifies a user.
OIDC_NAME_PATHpreferred_usernameClaim used as the Termix username.
OIDC_SCOPESopenid email profileScopes to ask for.
OIDC_ALLOWED_USERSEmails allowed to sign in, comma separated. Empty allows everyone.
OIDC_ADMIN_GROUPMembers of this group are admins.
OIDC_GROUP_CLAIMClaim with the groups, if not groups, roles or group.
OIDC_ROLE_MAPGroups to Termix roles as group:role pairs, comma separated. Works for every OIDC provider, not just this one.
OIDC_SIGN_OUT_AT_PROVIDERfalsetrue also signs people out of the provider above when they sign out of Termix.
OIDC_END_SESSION_URLThe provider's sign out page, if it is not in its discovery document.
OIDC_ENV_OVERRIDEfalsetrue makes the provider above the only one, even when providers are set up in the app.
OIDC_LEGACY_CALLBACKtruefalse makes the provider above send the new redirect URI, /plugin-api/sso/callback, instead of the 2.8 one, /users/oidc/callback.
OIDC_SILENT_LOGIN_DEFAULTtrue or false. Sends visitors straight to SSO, and locks the setting.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
sso.manageadminAdd, change and remove the SSO providers people can sign in with.

Capabilities​

What the plugin's code is allowed to do. Termix shows this list before you install it. See capabilities for all of them.

CapabilityRiskWhat it means
auth:provideHighHandle sign in. It can add a login method, a second factor or an SSH sign-in type.
network:serveMediumAccept connections. It opens a port on the Termix server.
network:outboundMediumReach the internet. It can send requests to outside services.
db:ownLowStore its own data. Kept in its own tables, separate from other plugins.
kv:ownLowRemember small settings. Kept separate from other plugins.
secrets:ownLowStore its own secrets. Encrypted by Termix. The plugin never holds the key.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.

API​

The plugin's HTTP routes are in the API reference.

Platforms​

Linux, Windows, macOS