From 0173a3d14c82a556bb5255156dcce839bb122953 Mon Sep 17 00:00:00 2001 From: Yannik Daellenbach Date: Thu, 10 Apr 2025 17:52:26 +0200 Subject: [PATCH] Document `sessionDuration` Signed-off-by: Yannik Daellenbach --- docs/auth/openshift/provider.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/auth/openshift/provider.md b/docs/auth/openshift/provider.md index f208aaca81..ab458a80e9 100644 --- a/docs/auth/openshift/provider.md +++ b/docs/auth/openshift/provider.md @@ -43,6 +43,9 @@ auth: authorizationUrl: ${AUTH_OPENSHIFT_AUTHORIZATION_URL} tokenUrl: ${AUTH_OPENSHIFT_TOKEN_URL} openshiftApiServerUrl: ${OPENSHIFT_API_SERVER_URL} + ## uncomment to set lifespan of user session + # sessionDuration: { hours: 24 } # supports `ms` library format (e.g. '24h', '2 days'), ISO duration, "human duration" as used in code + # sessionDuration: 1d signIn: resolvers: - resolver: displayNameMatchingUserEntityName @@ -55,10 +58,13 @@ The OpenShift provider is a structure with these configuration keys: - `authorizationUrl`: The OpenShift OAuth client auth endpoint, format: `https:///oauth/authorize`. - `tokenUrl`: The OpenShift OAuth client token endpoint, format: `https:///oauth/token`. - `openshiftApiServerUrl`: The OpenShift API server endpoint, format: `https://`. +- `sessionDuration`: (optional): Lifespan of the user session. - `signIn`: The configuration for the sign-in process, including the **resolvers** that should be used to match the user from the auth provider with the user entity in the Backstage catalog (typically a single resolver is sufficient). +The provider needs to use the scope **user:full**. + ## Backend Installation To add the provider to the backend we will first need to install the package by running this command: