Skip to content
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

docs: update and enhance oidc documentation #2142

Merged
merged 31 commits into from
Jul 14, 2021
Merged
Changes from 1 commit
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
a5b5339
update and enhance OIDC documentation
georglauterbach Jul 2, 2021
d19d70b
Merge branch 'master' into update-oidc-docs
georglauterbach Jul 2, 2021
a97d065
Merge branch 'master' into update-oidc-docs
georglauterbach Jul 2, 2021
9c71384
Merge remote-tracking branch 'origin/update-oidc-docs' into update-oi…
georglauterbach Jul 2, 2021
23580da
Merge branch 'master' into update-oidc-docs
georglauterbach Jul 3, 2021
1694d8b
Update docs/configuration/identity-providers/oidc.md
georglauterbach Jul 5, 2021
4a70cde
Update docs/configuration/identity-providers/oidc.md
georglauterbach Jul 5, 2021
fffca37
updateddocs according to @clems4ever's suggestions
georglauterbach Jul 5, 2021
109dcfe
Merge branch 'master' into update-oidc-docs
georglauterbach Jul 5, 2021
4b27c4b
add `tr` command in pipe to remove newline which could cause confusion
georglauterbach Jul 5, 2021
7380e74
a bit of Bash fetishism
georglauterbach Jul 6, 2021
2a0909b
Merge branch 'master' into update-oidc-docs
georglauterbach Jul 6, 2021
365216c
Merge branch 'master' into update-oidc-docs
georglauterbach Jul 8, 2021
4c33b6a
Merge branch 'master' into update-oidc-docs
georglauterbach Jul 11, 2021
862ba89
Update docs/configuration/identity-providers/oidc.md
georglauterbach Jul 12, 2021
6063ba6
Update docs/configuration/secrets.md
georglauterbach Jul 12, 2021
0711d2d
Update docs/community/oidc-integrations.md
georglauterbach Jul 12, 2021
226e7c7
Update docs/community/oidc-integrations.md
georglauterbach Jul 12, 2021
f4009f9
incorporated suggestions
georglauterbach Jul 12, 2021
5b18300
Update docs/configuration/identity-providers/oidc.md
georglauterbach Jul 13, 2021
041810c
Update docs/configuration/identity-providers/oidc.md
georglauterbach Jul 13, 2021
0e28050
Update docs/configuration/identity-providers/oidc.md
georglauterbach Jul 13, 2021
5f3c274
Update docs/configuration/identity-providers/oidc.md
georglauterbach Jul 13, 2021
6745134
Update docs/configuration/identity-providers/oidc.md
georglauterbach Jul 13, 2021
bc26b21
Update docs/configuration/identity-providers/oidc.md
georglauterbach Jul 13, 2021
744cd45
Update docs/configuration/identity-providers/oidc.md
georglauterbach Jul 13, 2021
bd81219
Update docs/configuration/secrets.md
georglauterbach Jul 13, 2021
5113aa8
Update docs/faq.md
georglauterbach Jul 13, 2021
1fb000c
replace all old links
georglauterbach Jul 13, 2021
3c8e993
Merge branch 'master' into update-oidc-docs
georglauterbach Jul 13, 2021
bf0af03
Merge branch 'master' into update-oidc-docs
clems4ever Jul 13, 2021
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
Prev Previous commit
Next Next commit
Merge branch 'master' into update-oidc-docs
  • Loading branch information
georglauterbach authored Jul 11, 2021
commit 4c33b6a3cd9631581fa515df39bfda470c9a5ee4
30 changes: 30 additions & 0 deletions docs/configuration/identity-providers/oidc.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,19 @@ required: no
A list of response modes this client can return. It is recommended that this isn't configured at this time unless you
know what you're doing. Potential values are `form_post`, `query`, and `fragment`.

#### userinfo_signing_algorithm

<div markdown="1">
type: string
{: .label .label-config .label-purple }
default: none
{: .label .label-config .label-blue }
required: no
{: .label .label-config .label-green }
</div>

The algorithm used to sign the userinfo endpoint responses. This can either be `none` or `RS256`.

## Generating Options Yourself
georglauterbach marked this conversation as resolved.
Show resolved Hide resolved

If you must generate an option yourself, you can use a random string of sufficient length. The command
georglauterbach marked this conversation as resolved.
Show resolved Hide resolved
Expand Down Expand Up @@ -444,6 +457,23 @@ This scope includes the profile information the authentication backend reports a
|:-------:|:------:|:----------------:|:--------------------:|
|name |string | display_name |The users display name|

## Endpoint Implementations

This is a table of the endpoints we currently support and their paths. This can be requrired information for some RP's,
particularly those that don't use [discovery](https://openid.net/specs/openid-connect-discovery-1_0.html). The paths are
appended to the end of the primary URL used to access Authelia. For example in the Discovery example provided you access
Authelia via https://auth.example.com, the discovery URL is https://auth.example.com/.well-known/openid-configuration.

|Endpoint |Path |
|:-----------:|:------------------------------:|
|Discovery |.well-known/openid-configuration|
|JWKS |api/oidc/jwks |
|Authorization|api/oidc/authorize |
|Token |api/oidc/token |
|Introspection|api/oidc/introspect |
|Revoke |api/oidc/revoke |
|Userinfo |api/oidc/userinfo |

[//]: # (Links)

[OpenID Connect]: https://openid.net/connect/
Expand Down
You are viewing a condensed version of this merge commit. You can view the full changes here.