Bump plugin-auth-backend to a minor change,

add documentation for fixing it
2021-02-10 11:16:26 -08:00
parent daf7fb717c
commit adf14c4c43
1 changed files with 32 additions and 2 deletions
@@ -1,6 +1,36 @@
 ---
 '@backstage/core': patch
-'@backstage/plugin-auth-backend': patch
+'@backstage/plugin-auth-backend': minor
 ---

-Change default scopes used for OIDC auth provider, remove undocumented scope
+Remove undocumented scope (default) from the OIDC auth provider which was breaking some identity services. If your app relied on this scope, you can readd it by adding a new factory in `packages/app/src/apis.ts`:
+
+```
+export const apis = [
+  createApiFactory({
+    api: oidcAuthApiRef,
+    deps: {
+      discoveryApi: discoveryApiRef,
+      oauthRequestApi: oauthRequestApiRef,
+      configApi: configApiRef,
+    },
+    factory: ({ discoveryApi, oauthRequestApi, configApi }) =>
+      OAuth2.create({
+        discoveryApi,
+        oauthRequestApi,
+        provider: {
+          id: 'oidc',
+          title: 'Your Identity Provider',
+          icon: OAuth2Icon,
+        },
+        defaultScopes: [
+          'default',
+          'openid',
+          'email',
+          'offline_access',
+        ],
+        environment: configApi.getOptionalString('auth.environment'),
+      }),
+  }),
+]
+```