@azure/msal-react package

Affiche les composants enfants si l’utilisateur est authentifié

function AuthenticatedTemplate(props: PropsWithChildren<Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>>): React.ReactElement | null

Paramètres

Retours

Tente d’authentifier l’utilisateur s’il n’est pas déjà authentifié, puis restitue les composants enfants

function MsalAuthenticationTemplate(props: PropsWithChildren<Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">> & { authenticationRequest?: PopupRequest | RedirectRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>, errorComponent?: any, interactionType: InteractionType, loadingComponent?: any }>): React.ReactElement | null

Paramètres

Retours

Composant fournisseur de contexte MSAL. Cela doit être rendu au-dessus des autres composants qui utilisent MSAL.

function MsalProvider(__namedParameters: PropsWithChildren<{ instance: IPublicClientApplication }>): React.ReactElement

Paramètres

Retours

Affiche les composants enfants si l’utilisateur n’est pas authentifié

function UnauthenticatedTemplate(props: PropsWithChildren<Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>>): React.ReactElement | null

Paramètres

Retours

Étant donné 1 ou plusieurs accountIdentifiers, retourne l’objet Account si l’utilisateur est connecté

function useAccount(accountIdentifiers?: Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>): AccountInfo | null

Paramètres

Retours

Retourne une valeur indiquant si un utilisateur est actuellement connecté. Indiquez éventuellement 1 ou plusieurs accountIdentifiers pour déterminer si un utilisateur spécifique est connecté

function useIsAuthenticated(matchAccount?: Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>): boolean

Paramètres

Retours

Retourne des valeurs de contexte msal

function useMsal(): IMsalContext

Retours

Si un utilisateur n’est pas actuellement connecté à ce hook appelle une connexion. Les connexions ayant échoué peuvent être retentées à l’aide du rappel de connexion retourné. Si un utilisateur est actuellement connecté à ce hook tente d’acquérir un jeton. Les demandes de jeton suivantes peuvent utiliser le rappel acquireToken retourné. Fournissez éventuellement un objet de demande à utiliser dans l’appel login/acquireToken. Fournissez éventuellement un utilisateur spécifique qui doit être connecté.

function useMsalAuthentication(interactionType: InteractionType, authenticationRequest?: PopupRequest | RedirectRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>, accountIdentifiers?: Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>): MsalAuthenticationResult

Paramètres

Retours

Composants de commande supérieure encapsulés fournis avec msal en injectant des valeurs de contexte msal dans les propriétés du composant

function withMsal<P>(Component: ComponentType<P>): FunctionComponent<Subtract<P, WithMsalProps>>

Paramètres

Retours

MsalConsumer: React.Consumer<IMsalContext>

Type

MsalContext: React.Context<IMsalContext>

Type

version: "3.0.29"

Type