@azure/msal-react package

Отрисовывает дочерние компоненты при проверке подлинности пользователя

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

Параметры

Возвращаемое значение

Пытается выполнить проверку подлинности пользователя, если он еще не прошел проверку подлинности, а затем отрисовывает дочерние компоненты

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

Параметры

Возвращаемое значение

Компонент поставщика контекста MSAL. Это должно быть отрисовывается над любыми другими компонентами, используюющими MSAL.

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

Параметры

Возвращаемое значение

Отрисовывает дочерние компоненты, если пользователь не прошел проверку подлинности

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

Параметры

Возвращаемое значение

Учитывая 1 или более accountIdentifiers, возвращает объект Account, если пользователь вошел в систему.

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

Параметры

Возвращаемое значение

Возвращает значение, вошедшего в систему пользователя. При необходимости укажите 1 или более учетных записейIdentifiers, чтобы определить, входит ли конкретный пользователь в систему.

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

Параметры

Возвращаемое значение

Возвращает значения контекста msal

function useMsal(): IMsalContext

Возвращаемое значение

Если пользователь в данный момент не вошел в систему, вызывает имя входа. Неудачные имена входа можно получить с помощью возвращаемого обратного вызова входа. Если пользователь в данный момент вошел в этот перехватчик, пытается получить токен. Последующие запросы маркеров могут использовать возвращенный обратный вызов acquireToken. При необходимости укажите объект запроса, который будет использоваться в вызове login/acquireToken. При необходимости укажите определенного пользователя, вошедшего в систему.

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

Параметры

Возвращаемое значение

Оболочки компонентов более высокого порядка, предоставляемые компонентом msal, путем внедрения значений контекста msal в реквизиты компонента

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

Параметры

Возвращаемое значение

MsalConsumer: React.Consumer<IMsalContext>

Тип

MsalContext: React.Context<IMsalContext>

Тип

version: "3.0.29"

Тип