useOpenSso
useOpenSso(
args?):UseMutationResult<OpenSsoReturnType,FrakRpcError<undefined>,OpenSsoArgsType,unknown>
Defined in: react/src/hook/useOpenSso.ts:40
Hook that return a mutation helping to open the SSO page
It’s a @tanstack/react-query!home | `tanstack` wrapper around the `openSso()` action
Parameters
Section titled “Parameters”Optional config object with mutations for customizing the underlying @tanstack/react-query!useMutation | `useMutation()`
mutations?
Section titled “mutations?”MutationOptions
Optional mutation options, see @tanstack/react-query!useMutation | `useMutation()` for more infos
Returns
Section titled “Returns”UseMutationResult<OpenSsoReturnType, FrakRpcError<undefined>, OpenSsoArgsType, unknown>
The mutation hook wrapping the openSso() action
The mutate and mutateAsync argument is of type `OpenSsoArgsType`:
either the full SSO params, or { ssoUrl } from `usePrepareSsoUrl()`
to open the popup without awaiting anything first.
The mutation doesn’t output any value
- `openSso()` for more info about the underlying action
- @tanstack/react-query!useMutation | `useMutation()` for more info about the mutation options and response