update changeset with example and change minor to patch (#7)

Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net> Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
2022-12-12 11:38:23 +05:30
parent a5a2d12298
commit f7749ae07f
1 changed files with 27 additions and 2 deletions
@@ -1,5 +1,30 @@
 ---
-'@backstage/core-components': minor
+'@backstage/core-components': patch
 ---

-Added option to pass additional headers in ProxiedSignInPage
+Added option to pass additional headers to `<ProxiedSignInPage />`
+
+The <ProxiedSignInPage /> supports signing into Backstage with a Sign Page coming from an external provider e.g. Google IAP, AWS ALB, etc. The component makes requests to a single endpoint `/refresh` on the auth backend to fetch the logged in user session.
+
+If the provider in auth backend expects additional headers such as `x-provider-token`, there is now a way to configure that in `ProxiedSignInPage` using the optional `getHeaders` prop.
+
+Example -
+
+```tsx
+const app = createApp({
+  // ...
+  components: {
+    SignInPage: props => (
+      <ProxiedSignInPage
+        {...props}
+        provider="my-custom-provider"
+        getHeaders={async () => {
+          const someValue = await someFn();
+          return { 'x-some-key': someValue };
+        }}
+      />
+    ),
+  },
+  // ...
+});
+```