Skip to content

Single sign-on for teams

In the core, OpenID Connect proves the identity of the owner (single sign-on). With a licence key every account can sign in through your identity provider, and accounts and groups follow from there.

What changes

  • Every role signs in through OIDC: admins, members and guests.
  • Accounts on first sign-in: an allowed person without an account gets one the first time they sign in. No invitation is needed.
  • Groups and the admin role from a claim: Waylight reads the groups of a person from a claim in the ID token and maps them to its own groups.
  • Removing a person takes effect: someone removed at the provider, or without the required claim, can no longer sign in. Admins can end all open sessions of an account at once under Settings → Members.
  • Passwords can be switched off for everyone except the last admin, who keeps a password as a way in when the provider is down.

Configuration

The settings of the core apply (configuration), plus:

Variable Example Meaning
OIDC_ALLOW_ALL_ACCOUNTS true Every role may sign in through OIDC.
OIDC_AUTO_CREATE true Create an account for an allowed person on first sign-in.
OIDC_ALLOWED_GROUPS waylight-users Only people in one of these provider groups may sign in (comma-separated). Empty means everyone the provider lets through.
OIDC_GROUPS_CLAIM groups The claim that holds the groups.
OIDC_ADMIN_GROUP waylight-admins Members of this provider group become admins.
OIDC_DEFAULT_ROLE member Role of new accounts: member or guest.

The mapping between provider groups and Waylight groups is set under Settings → Members → Groups → Provider group. A group without a mapping is maintained by hand.

Groups and the admin role

Groups and the admin role are updated at every sign-in. If a person leaves a provider group, they leave the matching Waylight group at their next sign-in; if they lose the admin group, they become a member. Changes are written to the security log.

Microsoft Entra ID

  1. In the Microsoft Entra admin center choose App registrations → New registration. Supported account types: this organisational directory only. Redirect URI (Web): https://<your-waylight>/api/auth/oidc/callback.
  2. Under Certificates & secrets create a client secret.
  3. Under Token configuration add the groups claim (security groups, as group ID or as sAMAccountName for synced groups).
  4. Set OIDC_ISSUER=https://login.microsoftonline.com/<tenant-id>/v2.0, OIDC_CLIENT_ID and OIDC_CLIENT_SECRET, and the variables above.

The same app registration can serve the workplace search and the Microsoft Teams app.

Google Workspace

  1. In the Google Cloud console create an OAuth client of type Web application with the redirect URI https://<your-waylight>/api/auth/oidc/callback, and set the consent screen to Internal.
  2. Set OIDC_ISSUER=https://accounts.google.com, OIDC_CLIENT_ID and OIDC_CLIENT_SECRET.
  3. Google does not put groups into the ID token. Waylight reads them through the Admin SDK instead: enable the Admin SDK API, give the OAuth client the scope https://www.googleapis.com/auth/admin.directory.group.readonly with domain-wide delegation, and set OIDC_GOOGLE_GROUPS=true.

Other providers such as Keycloak, Authentik or Authelia work as long as they put the groups into a claim.