From 4c2d1f48135100d94be68ea1efd666f1c98e714d Mon Sep 17 00:00:00 2001 From: Trong Huu Nguyen Date: Tue, 5 Nov 2024 11:44:45 +0100 Subject: [PATCH] docs(config): clarify description of openid.scopes flag --- docs/configuration.md | 2 +- pkg/config/openid.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 43e33b8..f2a0a8d 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -28,7 +28,7 @@ The following flags are available: | `openid.post-logout-redirect-uri` | string | URI for redirecting the user after successful logout at the Identity Provider. | | | `openid.provider` | string | Provider configuration to load and use, either `openid`, `azure`, `idporten`. | `openid` | | `openid.resource-indicator` | string | OAuth2 resource indicator to include in authorization request for acquiring audience-restricted tokens. | | -| `openid.scopes` | strings | List of additional scopes (other than `openid`) that should be used during the login flow. | | +| `openid.scopes` | strings | Comma separated list of additional scopes (other than `openid`) that should be used during the login flow. | | | `openid.ui-locales` | string | Space-separated string that configures the default UI locale (`ui_locales`) parameter for OAuth2 consent screen. | | | `openid.well-known-url` | string | URI to the well-known OpenID Configuration metadata document. | | | `redis.address` | string | Address of the Redis instance (host:port). An empty value will use in-memory session storage. Does not override address set by `redis.uri`. | | diff --git a/pkg/config/openid.go b/pkg/config/openid.go index 2455be4..5e81d1a 100644 --- a/pkg/config/openid.go +++ b/pkg/config/openid.go @@ -62,7 +62,7 @@ func openidFlags() { flag.String(OpenIDPostLogoutRedirectURI, "", "URI for redirecting the user after successful logout at the Identity Provider.") flag.String(OpenIDProvider, string(ProviderOpenID), "Provider configuration to load and use, either 'openid', 'azure', 'idporten'.") flag.String(OpenIDResourceIndicator, "", "OAuth2 resource indicator to include in authorization request for acquiring audience-restricted tokens.") - flag.StringSlice(OpenIDScopes, []string{}, "List of additional scopes (other than 'openid') that should be used during the login flow.") + flag.StringSlice(OpenIDScopes, []string{}, "Comma separated list of additional scopes (other than 'openid') that should be used during the login flow.") flag.String(OpenIDUILocales, "", "Space-separated string that configures the default UI locale (ui_locales) parameter for OAuth2 consent screen.") flag.String(OpenIDWellKnownURL, "", "URI to the well-known OpenID Configuration metadata document.") }