Skip to content

docs: document the OAuth2 additional audiences setting #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
secana merged 1 commit into from
Sep 1, 2026
Merged

docs: document the OAuth2 additional audiences setting #67

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions src/views/DocumentationV6View.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -869,6 +869,9 @@ const mobileNavOpen = ref(false);
default-value="" description="OAuth2 client ID from your identity provider." />
<ConfigCard title="Client Secret" toml="[oauth2] client_secret" env-var="KELLNR_OAUTH2__CLIENT_SECRET"
default-value="" description="OAuth2 client secret. Recommended to set via environment variable." />
<ConfigCard title="Additional Audiences" toml="[oauth2] additional_audiences"
env-var="KELLNR_OAUTH2__ADDITIONAL_AUDIENCES" default-value="[]"
description="Audiences accepted in the ID token besides the client ID, which stays required." />
<ConfigCard title="Scopes" toml="[oauth2] scopes" env-var="KELLNR_OAUTH2__SCOPES"
default-value='["openid", "profile", "email"]'
description="OAuth2 scopes to request from the identity provider." />
Expand Down Expand Up @@ -985,6 +988,26 @@ const mobileNavOpen = ref(false);
</ol>
</TextBlock>

<TextBlock>
<b>Multiple Audiences</b><br />
Some identity providers, Zitadel among them, issue ID tokens whose <i>aud</i> claim lists several
audiences instead of the client ID alone. Kellnr rejects an audience it does not know, because every
audience named in a token is able to present that token to Kellnr. If your provider adds further
audiences, list the ones you trust:
</TextBlock>

<CodeBlock lang="toml">
[oauth2]
additional_audiences = ["other-client-id", "project-id"]
</CodeBlock>

<TextBlock>
The configured <i>client_id</i> still has to appear in the <i>aud</i> claim. The allowlist covers only
the additional entries, and leaving it empty, the default, keeps every additional audience rejected.
As an environment variable the list is comma-separated:
<i>KELLNR_OAUTH2__ADDITIONAL_AUDIENCES=other-client-id,project-id</i>.
</TextBlock>

<TextBlock>
<b>User Provisioning</b><br />
When <i>auto_provision_users</i> is enabled (default), Kellnr automatically creates a local user account
Expand Down
Loading