From 2b178b22bad325a9dece32bfa4c7e9232b37d472 Mon Sep 17 00:00:00 2001 From: Dimitri Papadopoulos <3350651-DimitriPapadopoulos@users.noreply.gitlab.com> Date: Sun, 1 Feb 2026 18:39:01 +0100 Subject: [PATCH] Small doc improvements Signed-off-by: Dimitri Papadopoulos <3350651-DimitriPapadopoulos@users.noreply.gitlab.com> --- doc/README-oidc.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/README-oidc.md b/doc/README-oidc.md index 733a0df7..9125941b 100644 --- a/doc/README-oidc.md +++ b/doc/README-oidc.md @@ -1,6 +1,6 @@ # Using ocserv with OpenID Connect authentication -OpenID Connect (OIDC) is an identity layer build on top of the OAuth 2.0 protocols. Authentication using OIDC utilizes the following flow: +OpenID Connect (OIDC) is an identity layer built on top of the OAuth 2.0 protocol. Authentication using OIDC utilizes the following flow: +--------+ +---------------+ | |--(A)- Authorization Request ->| Resource | @@ -24,7 +24,7 @@ For as more detailed explanation see the OpenID Connect protocol ( 2) -Required claims controls what claims must be present in a token to permit access. +The 'required_claims' field controls which claims must be present in a token to permit access. -See your OpenID Connect provider for details on claims and OpenID Connect metadata document URL. +Refer to your OpenID Connect provider's documentation for details on claims and the OpenID Connect metadata document URL. ## Sample token -An OIDC token is returned as a base64url encoded blob. +An OIDC token is returned as a base64url-encoded blob. `eyJ0eXAiOiAiSldUIiwgImFsZyI6ICJFUzI1NiIsICJraWQiOiAiTXkgRmFrZSBLZXkifQ.eyJhdWQiOiAiU29tZUF1ZGllbmNlIiwgImlzcyI6ICJTb21lSXNzdWVyIiwgImlhdCI6IDE1ODE5ODAzMzcsICJuYmYiOiAxNTgxOTgwMzM3LCAiZXhwIjogMTU4MTk4Mzk5NywgInByZWZlcnJlZF91c2VybmFtZSI6ICJTb21lVXNlciJ9.dBGYHphmSHx_IQp09LpK9wkxAcIqnNRkX2Z59PPe0q7aU8yr2QZrq2fqtqRgk3fJ-LyRFaL5HyKHOHq3xebdXg` -You can view the contents of the token using . +You can view the contents of the token using tools like . ``` { "typ": "JWT",