Merge pull request #6675 from backstage/fix-idtoken

Switch frontend identity to use `token` instead of `idToken`

.changeset/lucky-spiders-impress.md

@@ -0,0 +1,6 @@
+---
+'@backstage/core-components': patch
+'@backstage/core-plugin-api': patch
+---
+
+Switched frontend identity code to use `token` instead of the deprecated `idToken` field

packages/core-components/src/layout/SignInPage/SignInPage.tsx

@@ -130,7 +130,7 @@ export const SingleSignInPage = ({
           userId: identity!.id,
           profile: profile!,
           getIdToken: () => {
-            return authApi.getBackstageIdentity().then(i => i!.idToken);
+            return authApi.getBackstageIdentity().then(i => i!.token);
           },
           signOut: async () => {
             await authApi.signOut();

packages/core-components/src/layout/SignInPage/auth0Provider.tsx

@@ -40,7 +40,7 @@ const Component: ProviderComponent = ({ onResult }) => {
         userId: identity!.id,
         profile: profile!,
         getIdToken: () =>
-          auth0AuthApi.getBackstageIdentity().then(i => i!.idToken),
+          auth0AuthApi.getBackstageIdentity().then(i => i!.token),
         signOut: async () => {
           await auth0AuthApi.signOut();
         },
@@ -82,7 +82,7 @@ const loader: ProviderLoader = async apis => {
   return {
     userId: identity.id,
     profile: profile!,
-    getIdToken: () => auth0AuthApi.getBackstageIdentity().then(i => i!.idToken),
+    getIdToken: () => auth0AuthApi.getBackstageIdentity().then(i => i!.token),
     signOut: async () => {
       await auth0AuthApi.signOut();
     },

packages/core-components/src/layout/SignInPage/commonProvider.tsx

@@ -86,7 +86,7 @@ const loader: ProviderLoader = async (apis, apiRef) => {
   return {
     userId: identity.id,
     profile: profile!,
-    getIdToken: () => authApi.getBackstageIdentity().then(i => i!.idToken),
+    getIdToken: () => authApi.getBackstageIdentity().then(i => i!.token),
     signOut: async () => {
       await authApi.signOut();
     },

packages/core-plugin-api/api-report.md

@@ -196,6 +196,7 @@ export type AuthRequestOptions = {
 export type BackstageIdentity = {
   id: string;
   idToken: string;
+  token: string;
 };
 
 // Warning: (tsdoc-undefined-tag) The TSDoc tag "@IdentityApi" is not defined in this configuration

packages/core-plugin-api/src/apis/definitions/auth.ts

@@ -151,9 +151,14 @@ export type BackstageIdentity = {
   id: string;
 
   /**
-   * An ID token that can be used to authenticate the user within Backstage.
+   * @deprecated This is deprecated, use `token` instead.
    */
   idToken: string;
+
+  /**
+   * The token used to authenticate the user within Backstage.
+   */
+  token: string;
 };
 
 /**