@azure/msal-react package

Interfaces

IMsalContext

Alias de tipos

AccountIdentifiers

AuthenticatedTemplateProps

MsalAuthenticationProps

MsalAuthenticationResult

MsalProviderProps

SetComplement

SetDifference

Subtract

UnauthenticatedTemplateProps

WithMsalProps

Funciones

AuthenticatedTemplate(PropsWithChildren<Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>>)	Representa los componentes secundarios si el usuario está autenticado
MsalAuthenticationTemplate(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 }>)	Intenta autenticar al usuario si aún no está autenticado y, a continuación, representa los componentes secundarios.
MsalProvider(PropsWithChildren<{ instance: IPublicClientApplication }>)	Componente del proveedor de contexto de MSAL. Debe representarse encima de cualquier otro componente que use MSAL.
UnauthenticatedTemplate(PropsWithChildren<Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>>)	Representa componentes secundarios si el usuario no está autenticado
useAccount(Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>)	Dado 1 o más accountIdentifiers, devuelve el objeto Account si el usuario ha iniciado sesión.
useIsAuthenticated(Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>)	Devuelve si un usuario ha iniciado sesión actualmente o no. Opcionalmente, proporcione 1 o más accountIdentifiers para determinar si un usuario específico ha iniciado sesión
useMsal()	Devuelve valores de contexto msal.
useMsalAuthentication(InteractionType, PopupRequest | RedirectRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>, Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>)	Si un usuario no ha iniciado sesión actualmente en este enlace invoca un inicio de sesión. Los inicios de sesión con errores se pueden reintentar mediante la devolución de llamada de inicio de sesión devuelta. Si un usuario ha iniciado sesión actualmente en este enlace intenta adquirir un token. Las solicitudes de token posteriores pueden usar la devolución de llamada acquireToken devuelta. Opcionalmente, proporcione un objeto de solicitud que se usará en la llamada login/acquireToken. Opcionalmente, proporcione un usuario específico que se debe iniciar sesión.
withMsal<P>(ComponentType<P>)	El componente de orden superior ajusta el componente proporcionado con msal insertando valores de contexto msal en las propiedades del componente.

Variables

MsalConsumer
MsalContext
version

Detalles de la función

AuthenticatedTemplate(PropsWithChildren<Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>>)

Representa los componentes secundarios si el usuario está autenticado

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

Parámetros

props

PropsWithChildren<Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>>

Devoluciones

React.ReactElement | null

MsalAuthenticationTemplate(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 }>)

Intenta autenticar al usuario si aún no está autenticado y, a continuación, representa los componentes secundarios.

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

Parámetros

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 }>

Devoluciones

React.ReactElement | null

MsalProvider(PropsWithChildren<{ instance: IPublicClientApplication }>)

Componente del proveedor de contexto de MSAL. Debe representarse encima de cualquier otro componente que use MSAL.

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

Parámetros

__namedParameters

PropsWithChildren<{ instance: IPublicClientApplication }>

Devoluciones

React.ReactElement

UnauthenticatedTemplate(PropsWithChildren<Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>>)

Representa componentes secundarios si el usuario no está autenticado

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

Parámetros

props

PropsWithChildren<Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>>

Devoluciones

React.ReactElement | null

useAccount(Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>)

Dado 1 o más accountIdentifiers, devuelve el objeto Account si el usuario ha iniciado sesión.

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

Parámetros

accountIdentifiers

Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>

Devoluciones

AccountInfo | null

useIsAuthenticated(Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>)

Devuelve si un usuario ha iniciado sesión actualmente o no. Opcionalmente, proporcione 1 o más accountIdentifiers para determinar si un usuario específico ha iniciado sesión

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

Parámetros

matchAccount

Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>

Devoluciones

boolean

useMsal()

Devuelve valores de contexto msal.

function useMsal(): IMsalContext

Devoluciones

IMsalContext

useMsalAuthentication(InteractionType, PopupRequest | RedirectRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>, Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>)

Si un usuario no ha iniciado sesión actualmente en este enlace invoca un inicio de sesión. Los inicios de sesión con errores se pueden reintentar mediante la devolución de llamada de inicio de sesión devuelta. Si un usuario ha iniciado sesión actualmente en este enlace intenta adquirir un token. Las solicitudes de token posteriores pueden usar la devolución de llamada acquireToken devuelta. Opcionalmente, proporcione un objeto de solicitud que se usará en la llamada login/acquireToken. Opcionalmente, proporcione un usuario específico que se debe iniciar sesión.

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

Parámetros

interactionType

InteractionType

authenticationRequest

PopupRequest | RedirectRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>

accountIdentifiers

Partial<Pick<AccountInfo, "homeAccountId" | "localAccountId" | "username">>

Devoluciones

MsalAuthenticationResult

withMsal<P>(ComponentType<P>)

El componente de orden superior ajusta el componente proporcionado con msal insertando valores de contexto msal en las propiedades del componente.

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

Parámetros

Component

ComponentType<P>

Devoluciones

FunctionComponent<Subtract<P, WithMsalProps>>

Detalles de variables

MsalConsumer

MsalConsumer: React.Consumer<IMsalContext>

Tipo

React.Consumer<IMsalContext>

MsalContext

MsalContext: React.Context<IMsalContext>

Tipo

React.Context<IMsalContext>

version

version: "3.0.29"

Tipo

"3.0.29"