-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
website/docs: add oidc issuer information #22556
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.
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
Open
PeshekDotDev
wants to merge
7
commits into
main
Choose a base branch
from
oidc-global-issuer
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
855aed8
website/docs: add oidc issuer information
PeshekDotDev 5df35db
Update website/docs/add-secure-apps/providers/oauth2/index.mdx
PeshekDotDev 035572f
Update website/docs/add-secure-apps/providers/oauth2/index.mdx
PeshekDotDev 48edbf5
Update website/docs/add-secure-apps/providers/oauth2/index.mdx
PeshekDotDev 9852462
Apply suggestion from @dominic-r
dominic-r 176b97d
update warning to info
PeshekDotDev 7bf12ec
Update language throughout the doc, fix punctuation and spelling
dewi-tik File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -86,6 +86,25 @@ Using back-channel logout (a server-to-server notification mechanism) allows an | |
|
|
||
| For more information, see our [OAuth2/OpenID Connect front-channel and back-channel logout](./frontchannel_and_backchannel_logout.mdx) documentation. | ||
|
|
||
| ## Issuer mode | ||
|
|
||
| The **Issuer mode** setting (under **Advanced protocol settings** controls the value authentik uses for the `iss` (issuer) claim in the tokens it signs, and for the `issuer` field in the provider's [OpenID Connect discovery document](#oauth2-endpoints-and-bindings). | ||
|
|
||
| | Mode (UI label) | `iss` value | | ||
| | ------------------------------------------------------------------------------- | ------------------------------------------------------------- | | ||
| | _Each provider has a different issuer, based on the application slug_ (default) | `https://authentik.company/application/o/<application_slug>/` | | ||
| | _Same identifier is used for all providers_ | `https://authentik.company/` | | ||
|
dominic-r marked this conversation as resolved.
Outdated
|
||
|
|
||
| By default, authentik uses per-provider mode: every provider has a unique issuer derived from its application slug. This is the recommended setting, and it matches how the discovery and JWKS endpoints are structured, since both are served under the per-application `/application/o/<application_slug>/` path. | ||
|
PeshekDotDev marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### Global issuer mode | ||
|
|
||
| Setting the issuer mode to _Same identifier is used for all providers_ (referred to internally as **global** mode) makes every OAuth2 provider on the authentik instance share the same issuer: the root URL of the instance (`https://authentik.company/`). | ||
|
PeshekDotDev marked this conversation as resolved.
Outdated
|
||
|
|
||
| :::warning | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. i'd make this an :::info + adding a title |
||
| Global issuer mode still serves the discovery document at `https://authentik.company/application/o/<application_slug>/.well-known/openid-configuration`, not at the root issuer URL. | ||
| ::: | ||
|
|
||
| ## OAuth 2.0 flows and grant types | ||
|
|
||
| There are three general flows of OAuth 2.0: | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.