diff --git a/plugins/auth-react/api-report.md b/plugins/auth-react/api-report.md index d5206261d2..52e6c6bc3a 100644 --- a/plugins/auth-react/api-report.md +++ b/plugins/auth-react/api-report.md @@ -36,4 +36,10 @@ export function useCookieAuthRefresh(options: { pluginId: string }): expiresAt: string; }; }; + +// @public +export function useSignInAuthError(): { + error: Error | undefined; + checkAuthError: () => void; +}; ``` diff --git a/plugins/auth-react/src/hooks/useSignInAuthError/useSignInAuthError.tsx b/plugins/auth-react/src/hooks/useSignInAuthError/useSignInAuthError.tsx index 8d4af1f555..fe146fedca 100644 --- a/plugins/auth-react/src/hooks/useSignInAuthError/useSignInAuthError.tsx +++ b/plugins/auth-react/src/hooks/useSignInAuthError/useSignInAuthError.tsx @@ -18,6 +18,10 @@ import { discoveryApiRef, useApi } from '@backstage/core-plugin-api'; import { useAsync } from '@react-hookz/web'; import { deserializeError } from '@backstage/errors'; +/** + * @public + * A hook that will fetch any sign in auth error in redirect auth flow + */ export function useSignInAuthError(): { error: Error | undefined; checkAuthError: () => void;