Skip to main content
Version: 2.xx.xx

useGetIdentity

useGetIdentity calls the getUserIdentity method from the authProvider under the hood.

It returns the result of react-query's useQuery which includes many properties, some of which being isSuccess and isError. Data that is resolved from the getUserIdentity will be returned as the data in the query result.

Usage​

useGetIdentity can be useful when you want to get the user information anywhere in your code.

Let's say that you want to show the user's name.

We have a logic in authProvider's getUserIdentity method like below.

const authProvider: AuthProvider = {
...
getUserIdentity: () =>
Promise.resolve({
id: 1,
fullName: "Jane Doe",
}),
...
};

You can access identity data like below.

import { useGetIdentity } from "@pankod/refine";

export const User: React.FC = () => {
const { data: identity } = useGetIdentity<{ id: string; fullName: string}>();

return <span>{identity?.fullName}</span>
}
caution

This hook can only be used if the authProvider is provided.