From 76189b86b74684fa7d471941c230b58d8a00ea3f Mon Sep 17 00:00:00 2001 From: James Elliott Date: Thu, 15 Jul 2021 13:04:44 +1000 Subject: [PATCH] docs(oidc): misc docs fixes and additional references (#2185) This fixes a few anchor issues in the OpenID Connect docs, as well as adds some additional references and fixes the name of one of the endpoints. --- docs/configuration/identity-providers/oidc.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/configuration/identity-providers/oidc.md b/docs/configuration/identity-providers/oidc.md index 31c5fc7d..2cd79d29 100644 --- a/docs/configuration/identity-providers/oidc.md +++ b/docs/configuration/identity-providers/oidc.md @@ -8,7 +8,7 @@ nav_order: 2 # OpenID Connect -**Authelia** currently supports the [OpenID Connect] OP role as a [**beta**](#beta) feature. The OP role is the +**Authelia** currently supports the [OpenID Connect] OP role as a [**beta**](#roadmap) feature. The OP role is the [OpenID Connect] Provider role, not the Relaying Party or RP role. This means other applications that implement the [OpenID Connect] RP role can use Authelia as an authentication and authorization backend similar to how you may use social media or development platforms for login. @@ -84,12 +84,18 @@ for which stage will have each feature, and may evolve over time: General Availability after previous stages are vetted for bug fixes - misc + misc List of other features that may be implemented Front-Channel Logout 2 + + OAuth 2.0 Authorization Server Metadata 2 + + + OpenID Connect Session Management 2 + @@ -162,7 +168,7 @@ required: yes {: .label .label-config .label-red } -The private key in DER base64 encoded PEM format used to encrypt the [OpenID Connect] JWT's.[¹](../../faq.md#why_only_use_a_private_issue_key_with_oidc) +The private key in DER base64 encoded PEM format used to encrypt the [OpenID Connect] JWT's.[¹](../../faq.md#why-only-use-a-private-issuer-key-and-no-public-key-with-oidc) You must [generate this option yourself](#generating-a-random-secret). To create this option, use `docker run -u "$(id -u):$(id -g)" -v "$(pwd)":/keys authelia/authelia:latest authelia rsa generate --dir /keys` to generate both the private and public key in the current directory. You can then paste the @@ -469,10 +475,8 @@ Authelia via https://auth.example.com, the discovery URL is https://auth.example |Authorization|api/oidc/authorize | |Token |api/oidc/token | |Introspection|api/oidc/introspect | -|Revoke |api/oidc/revoke | +|Revocation |api/oidc/revoke | |Userinfo |api/oidc/userinfo | -[//]: # (Links) - [OpenID Connect]: https://openid.net/connect/ [token lifespan]: https://docs.apigee.com/api-platform/antipatterns/oauth-long-expiration