CustomAuthPublicClientApplication class
- Extends
-
PublicClientApplication
Методы
| create(Custom |
Создает новый экземпляр PublicClientApplication с заданной конфигурацией и контроллером для запуска потоков проверки подлинности в собственном коде. |
| get |
Возвращает текущую учетную запись из кэша браузера. |
| reset |
Инициирует поток сброса пароля. Этот метод приводит к активации дополнительного действия (отправки кода) для завершения сброса пароля. Создайте результат с сведениями об ошибке при возникновении исключения. |
| sign |
Инициирует поток входа. Этот метод приводит к завершению входа или дополнительным действиям (пароль, код и т. д.) для завершения входа. Создайте результат с сведениями об ошибке при возникновении исключения. |
| sign |
Инициирует поток регистрации. Этот метод приводит к завершению регистрации или дополнительным действиям (пароль, код и т. д.) для завершения регистрации. Создайте результат с сведениями об ошибке при возникновении исключения. |
Наследуемые методы
| acquire |
Эта функция активирует код авторизации (переданный как код) из конечной точки маркера eSTS. Этот код авторизации должен быть получен на стороне сервера с помощью конфиденциального клиента для получения spa_code. Этот API не является отступом для обычного получения и активации кода авторизации. Активация этого кода авторизации не требует PKCE, так как она была приобретена конфиденциальным клиентом. |
| acquire |
Используйте, когда вы хотите получить access_token для API, открыв всплывающее окно в браузере пользователя |
| acquire |
Используйте, если вы хотите получить access_token для API, перенаправив окно браузера пользователя в конечную точку авторизации. Эта функция перенаправляет страницу, поэтому любой код, следующий за этой функцией, не будет выполняться. ВАЖНО. Не рекомендуется иметь код, зависящий от разрешения обещания. Эта функция будет переходить от текущего окна браузера. В настоящее время он возвращает обещание, чтобы отразить асинхронную природу кода, выполняемого в этой функции. |
| acquire |
Автоматическое получение маркера доступа для заданного набора областей. Возвращает обещание обработки, если выполняются параллельные запросы. |
| add |
Добавление обратных вызовов событий в массив |
| add |
Регистрирует обратный вызов для получения событий производительности. |
| clear |
Очищает маркеры и учетную запись из кэша браузера. |
| create |
Создает StandardController и передает его в PublicClientApplication |
| disable |
Удаляет прослушиватель событий, который выдает событие при добавлении или удалении учетной записи пользователя из localstorage на другой вкладке браузера или окне |
| enable |
Добавляет прослушиватель событий, который выдает событие при добавлении или удалении учетной записи пользователя из localstorage на другой вкладке браузера или окне |
| get |
Возвращает первую учетную запись, найденную в кэше, которая соответствует фильтру учетной записи, переданной. |
| get |
Возвращает входную учетную запись, соответствующую homeAccountId. (объект учетной записи создается во время успешного входа) или null, если учетная запись не найдена. |
| get |
Возвращает вошедшего в систему учетную запись, соответствующую localAccountId. (объект учетной записи создается во время успешного входа) или null, если учетная запись не найдена. |
| get |
Возвращает имя пользователя, соответствующее учетной записи для входа. (объект учетной записи создается во время успешного входа) или null, если учетная запись не найдена. Этот API предоставляется для удобства, но getAccountById должен использоваться для обеспечения оптимальной надежности. |
| get |
Возвращает текущую активную учетную запись |
| get |
Возвращает все учетные записи в кэше, соответствующие необязательному фильтру. Если фильтр не указан, возвращаются все учетные записи. |
| get |
Возвращает экземпляр средства ведения журнала |
| get |
Возвращает кэш маркеров для приложения. |
| handle |
Функция обработчика событий, которая позволяет пользователям запускать события после загрузки объекта PublicClientApplication во время потоков перенаправления. Это должно вызываться на всех загрузках страниц, участвующих в потоках проверки подлинности перенаправления. |
| hydrate |
Кэш Hydrates с маркерами и учетной записью в объекте AuthenticationResult |
| initialize(Initialize |
Функция инициализатора для выполнения асинхронных задач запуска, таких как подключение к расширению WAM |
| initialize |
Вызывается библиотеками-оболочками (Angular и React), чтобы задать номер SKU и версия, передаваемые телеметрии, средству ведения журнала и т. д. |
| login |
Использование при инициировании процесса входа с помощью всплывающего окна в браузере пользователя |
| login |
Используйте при инициировании процесса входа, перенаправив браузер пользователя в конечную точку авторизации. Эта функция перенаправляет страницу, поэтому любой код, следующий за этой функцией, не будет выполняться. ВАЖНО. Не рекомендуется иметь код, зависящий от разрешения обещания. Эта функция будет переходить от текущего окна браузера. В настоящее время он возвращает обещание, чтобы отразить асинхронную природу кода, выполняемого в этой функции. |
| logout(End |
Нерекомендуемая функция выхода. Вместо этого используйте logoutRedirect или logoutPopup |
| logout |
Очищает локальный кэш для текущего пользователя, а затем открывает всплывающее окно, предлагающее пользователю выйти из сервера. |
| logout |
Используется для выхода текущего пользователя и перенаправления пользователя в postLogoutRedirectUri.
Поведение по умолчанию — перенаправление пользователя в |
| remove |
Удаляет обратный вызов с предоставленным идентификатором из массива обратного вызова |
| remove |
Удаляет обратный вызов, зарегистрированный с помощью addPerformanceCallback. |
| set |
Задает учетную запись, используемую в качестве активной учетной записи. Если учетная запись не передается в API-интерфейсы acquireToken, MSAL будет использовать эту активную учетную запись. |
| set |
Заменяет набор средств ведения журнала по умолчанию в конфигурациях новым средство ведения журнала новыми конфигурациями. |
| set |
Задает клиент навигации |
| sso |
Эта функция использует скрытый iframe для получения кода авторизации из eSTS. Существуют случаи, когда это может не работать:
В этих случаях запрос должен выполняться внутри всплывающего окна или полного перенаправления кадров. В случаях, когда требуется взаимодействие, вы не можете отправить запрос с запросом=none. Если срок действия маркера обновления истек, эту функцию можно использовать для автоматического получения нового набора маркеров до тех пор, пока сеанс на сервере по-прежнему существует. |
Сведения о методе
create(CustomAuthConfiguration)
Создает новый экземпляр PublicClientApplication с заданной конфигурацией и контроллером для запуска потоков проверки подлинности в собственном коде.
static function create(config: CustomAuthConfiguration): Promise<ICustomAuthPublicClientApplication>
Параметры
- config
- CustomAuthConfiguration
Объект конфигурации для экземпляра PublicClientApplication
Возвращаемое значение
Promise<ICustomAuthPublicClientApplication>
- Обещание, разрешающее экземпляр CustomAuthPublicClientApplication
getCurrentAccount(CustomAuthActionInputs)
Возвращает текущую учетную запись из кэша браузера.
function getCurrentAccount(accountRetrievalInputs?: CustomAuthActionInputs): GetAccountResult
Параметры
- accountRetrievalInputs
-
CustomAuthActionInputs
Возвращаемое значение
- Результат операции получения учетной записи
resetPassword(ResetPasswordInputs)
Инициирует поток сброса пароля. Этот метод приводит к активации дополнительного действия (отправки кода) для завершения сброса пароля. Создайте результат с сведениями об ошибке при возникновении исключения.
function resetPassword(resetPasswordInputs: ResetPasswordInputs): Promise<ResetPasswordStartResult>
Параметры
- resetPasswordInputs
- ResetPasswordInputs
Входные данные для потока сброса пароля
Возвращаемое значение
Promise<ResetPasswordStartResult>
- Обещание, которое разрешается в ResetPasswordStartResult
signIn(SignInInputs)
Инициирует поток входа. Этот метод приводит к завершению входа или дополнительным действиям (пароль, код и т. д.) для завершения входа. Создайте результат с сведениями об ошибке при возникновении исключения.
function signIn(signInInputs: SignInInputs): Promise<SignInResult>
Параметры
- signInInputs
- SignInInputs
Входные данные для потока входа
Возвращаемое значение
Promise<SignInResult>
- Обещание, разрешающее signInResult
signUp(SignUpInputs)
Инициирует поток регистрации. Этот метод приводит к завершению регистрации или дополнительным действиям (пароль, код и т. д.) для завершения регистрации. Создайте результат с сведениями об ошибке при возникновении исключения.
function signUp(signUpInputs: SignUpInputs): Promise<SignUpResult>
Параметры
- signUpInputs
- SignUpInputs
Возвращаемое значение
Promise<SignUpResult>
- Обещание, разрешающее signUpResult
Сведения о наследуемом методе
acquireTokenByCode(AuthorizationCodeRequest)
Эта функция активирует код авторизации (переданный как код) из конечной точки маркера eSTS. Этот код авторизации должен быть получен на стороне сервера с помощью конфиденциального клиента для получения spa_code. Этот API не является отступом для обычного получения и активации кода авторизации.
Активация этого кода авторизации не требует PKCE, так как она была приобретена конфиденциальным клиентом.
function acquireTokenByCode(request: AuthorizationCodeRequest): Promise<AuthenticationResult>
Параметры
- request
-
AuthorizationCodeRequest
Возвращаемое значение
Promise<AuthenticationResult>
Обещание, которое выполняется при завершении этой функции или отклонено, если возникла ошибка.
Наследуется от PublicClientApplication.acquireTokenByCode
acquireTokenPopup(PopupRequest)
Используйте, когда вы хотите получить access_token для API, открыв всплывающее окно в браузере пользователя
function acquireTokenPopup(request: PopupRequest): Promise<AuthenticationResult>
Параметры
- request
-
PopupRequest
Возвращаемое значение
Promise<AuthenticationResult>
Обещание, которое выполняется при завершении этой функции или отклонено, если возникла ошибка.
Наследуется от PublicClientApplication.acquireTokenPopup
acquireTokenRedirect(RedirectRequest)
Используйте, если вы хотите получить access_token для API, перенаправив окно браузера пользователя в конечную точку авторизации. Эта функция перенаправляет страницу, поэтому любой код, следующий за этой функцией, не будет выполняться.
ВАЖНО. Не рекомендуется иметь код, зависящий от разрешения обещания. Эта функция будет переходить от текущего окна браузера. В настоящее время он возвращает обещание, чтобы отразить асинхронную природу кода, выполняемого в этой функции.
function acquireTokenRedirect(request: RedirectRequest): Promise<void>
Параметры
- request
-
RedirectRequest
Возвращаемое значение
Promise<void>
Наследуется от PublicClientApplication.acquireTokenRedirect
acquireTokenSilent(SilentRequest)
Автоматическое получение маркера доступа для заданного набора областей. Возвращает обещание обработки, если выполняются параллельные запросы.
function acquireTokenSilent(silentRequest: SilentRequest): Promise<AuthenticationResult>
Параметры
- silentRequest
-
SilentRequest
Возвращаемое значение
Promise<AuthenticationResult>
- обещание, которое выполняется при завершении этой функции или отклонено, если возникла ошибка. AuthenticationResult Возвращает объект
Наследуется от PublicClientApplication.acquireTokenSilent
addEventCallback(EventCallbackFunction, EventType[])
Добавление обратных вызовов событий в массив
function addEventCallback(callback: EventCallbackFunction, eventTypes?: EventType[]): null | string
Параметры
- callback
-
EventCallbackFunction
- eventTypes
-
EventType[]
Возвращаемое значение
null | string
Наследуется от PublicClientApplication.addEventCallback
addPerformanceCallback(PerformanceCallbackFunction)
Регистрирует обратный вызов для получения событий производительности.
function addPerformanceCallback(callback: PerformanceCallbackFunction): string
Параметры
- callback
- PerformanceCallbackFunction
Возвращаемое значение
string
Наследуется от PublicClientApplication.addPerformanceCallback
clearCache(ClearCacheRequest)
Очищает маркеры и учетную запись из кэша браузера.
function clearCache(logoutRequest?: ClearCacheRequest): Promise<void>
Параметры
- logoutRequest
-
ClearCacheRequest
Возвращаемое значение
Promise<void>
Наследуется от PublicClientApplication.clearCache
createPublicClientApplication(Configuration)
Создает StandardController и передает его в PublicClientApplication
static function createPublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>
Параметры
- configuration
-
Configuration
{Configuration}
Возвращаемое значение
Promise<IPublicClientApplication>
Наследуется от PublicClientApplication.createPublicClientApplication
disableAccountStorageEvents()
Удаляет прослушиватель событий, который выдает событие при добавлении или удалении учетной записи пользователя из localstorage на другой вкладке браузера или окне
function disableAccountStorageEvents()
Наследуется от PublicClientApplication.disableAccountStorageEvents
enableAccountStorageEvents()
Добавляет прослушиватель событий, который выдает событие при добавлении или удалении учетной записи пользователя из localstorage на другой вкладке браузера или окне
function enableAccountStorageEvents()
Наследуется от PublicClientApplication.enableAccountStorageEvents
getAccount(AccountFilter)
Возвращает первую учетную запись, найденную в кэше, которая соответствует фильтру учетной записи, переданной.
function getAccount(accountFilter: AccountFilter): null | AccountInfo
Параметры
- accountFilter
- AccountFilter
Возвращаемое значение
null | AccountInfo
Первая учетная запись, найденная в кэше, соответствующая предоставленному фильтру или null, если учетная запись не найдена.
Наследуется от PublicClientApplication.getAccount
getAccountByHomeId(string)
Предупреждение
Теперь этот API является нерекомендуемым.
- Use getAccount instead
Возвращает входную учетную запись, соответствующую homeAccountId. (объект учетной записи создается во время успешного входа) или null, если учетная запись не найдена.
function getAccountByHomeId(homeAccountId: string): null | AccountInfo
Параметры
- homeAccountId
-
string
Возвращаемое значение
null | AccountInfo
Объект учетной записи, хранящийся в MSAL
Наследуется от PublicClientApplication.getAccountByHomeId
getAccountByLocalId(string)
Предупреждение
Теперь этот API является нерекомендуемым.
- Use getAccount instead
Возвращает вошедшего в систему учетную запись, соответствующую localAccountId. (объект учетной записи создается во время успешного входа) или null, если учетная запись не найдена.
function getAccountByLocalId(localId: string): null | AccountInfo
Параметры
- localId
-
string
Возвращаемое значение
null | AccountInfo
Объект учетной записи, хранящийся в MSAL
Наследуется от PublicClientApplication.getAccountByLocalId
getAccountByUsername(string)
Предупреждение
Теперь этот API является нерекомендуемым.
- Use getAccount instead
Возвращает имя пользователя, соответствующее учетной записи для входа. (объект учетной записи создается во время успешного входа) или null, если учетная запись не найдена. Этот API предоставляется для удобства, но getAccountById должен использоваться для обеспечения оптимальной надежности.
function getAccountByUsername(userName: string): null | AccountInfo
Параметры
- userName
-
string
Возвращаемое значение
null | AccountInfo
Объект учетной записи, хранящийся в MSAL
Наследуется от PublicClientApplication.getAccountByUsername
getActiveAccount()
Возвращает текущую активную учетную запись
function getActiveAccount(): null | AccountInfo
Возвращаемое значение
null | AccountInfo
Наследуется от PublicClientApplication.getActiveAccount
getAllAccounts(AccountFilter)
Возвращает все учетные записи в кэше, соответствующие необязательному фильтру. Если фильтр не указан, возвращаются все учетные записи.
function getAllAccounts(accountFilter?: AccountFilter): AccountInfo[]
Параметры
- accountFilter
- AccountFilter
Фильтр (необязательно) для сузки возвращаемых учетных записей
Возвращаемое значение
Массив объектов AccountInfo в кэше
Наследуется от PublicClientApplication.getAllAccounts
getLogger()
Возвращает экземпляр средства ведения журнала
function getLogger(): Logger
Возвращаемое значение
Наследуется от PublicClientApplication.getLogger
getTokenCache()
Возвращает кэш маркеров для приложения.
function getTokenCache(): ITokenCache
Возвращаемое значение
ITokenCache
Наследуется от PublicClientApplication.getTokenCache
handleRedirectPromise(string)
Функция обработчика событий, которая позволяет пользователям запускать события после загрузки объекта PublicClientApplication во время потоков перенаправления. Это должно вызываться на всех загрузках страниц, участвующих в потоках проверки подлинности перенаправления.
function handleRedirectPromise(hash?: string): Promise<null | AuthenticationResult>
Параметры
- hash
-
string
Хэш для обработки. По умолчанию используется текущее значение window.location.hash. Необходимо явно указать только в том случае, если обрабатываемый ответ не содержится в текущем значении.
Возвращаемое значение
Promise<null | AuthenticationResult>
Ответ маркера или значение NULL. Если возвращаемое значение равно NULL, перенаправление проверки подлинности не было обнаружено.
Наследуется от PublicClientApplication.handleRedirectPromise
hydrateCache(AuthenticationResult, PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>)
Кэш Hydrates с маркерами и учетной записью в объекте AuthenticationResult
function hydrateCache(result: AuthenticationResult, request: PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>): Promise<void>
Параметры
- result
-
AuthenticationResult
- request
-
PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>
Объект запроса, используемый для получения AuthenticationResult
Возвращаемое значение
Promise<void>
Наследуется от PublicClientApplication.hydrateCache
initialize(InitializeApplicationRequest)
Функция инициализатора для выполнения асинхронных задач запуска, таких как подключение к расширению WAM
function initialize(request?: InitializeApplicationRequest): Promise<void>
Параметры
- request
-
InitializeApplicationRequest
{? InitializeApplicationRequest}
Возвращаемое значение
Promise<void>
Наследуется от PublicClientApplication.initialize
initializeWrapperLibrary(WrapperSKU, string)
Вызывается библиотеками-оболочками (Angular и React), чтобы задать номер SKU и версия, передаваемые телеметрии, средству ведения журнала и т. д.
function initializeWrapperLibrary(sku: WrapperSKU, version: string)
Параметры
- sku
-
WrapperSKU
- version
-
string
Наследуется от PublicClientApplication.initializeWrapperLibrary
loginPopup(PopupRequest)
Использование при инициировании процесса входа с помощью всплывающего окна в браузере пользователя
function loginPopup(request?: PopupRequest): Promise<AuthenticationResult>
Параметры
- request
-
PopupRequest
Возвращаемое значение
Promise<AuthenticationResult>
Обещание, которое выполняется при завершении этой функции или отклонено, если возникла ошибка.
Наследуется от PublicClientApplication.loginPopup
loginRedirect(RedirectRequest)
Используйте при инициировании процесса входа, перенаправив браузер пользователя в конечную точку авторизации. Эта функция перенаправляет страницу, поэтому любой код, следующий за этой функцией, не будет выполняться.
ВАЖНО. Не рекомендуется иметь код, зависящий от разрешения обещания. Эта функция будет переходить от текущего окна браузера. В настоящее время он возвращает обещание, чтобы отразить асинхронную природу кода, выполняемого в этой функции.
function loginRedirect(request?: RedirectRequest): Promise<void>
Параметры
- request
-
RedirectRequest
Возвращаемое значение
Promise<void>
Наследуется от PublicClientApplication.loginRedirect
logout(EndSessionRequest)
Предупреждение
Теперь этот API является нерекомендуемым.
Нерекомендуемая функция выхода. Вместо этого используйте logoutRedirect или logoutPopup
function logout(logoutRequest?: EndSessionRequest): Promise<void>
Параметры
- logoutRequest
-
EndSessionRequest
Возвращаемое значение
Promise<void>
Наследуется от PublicClientApplication.logout
logoutPopup(EndSessionPopupRequest)
Очищает локальный кэш для текущего пользователя, а затем открывает всплывающее окно, предлагающее пользователю выйти из сервера.
function logoutPopup(logoutRequest?: EndSessionPopupRequest): Promise<void>
Параметры
- logoutRequest
-
EndSessionPopupRequest
Возвращаемое значение
Promise<void>
Наследуется от PublicClientApplication.logoutPopup
logoutRedirect(EndSessionRequest)
Используется для выхода текущего пользователя и перенаправления пользователя в postLogoutRedirectUri.
Поведение по умолчанию — перенаправление пользователя в window.location.href.
function logoutRedirect(logoutRequest?: EndSessionRequest): Promise<void>
Параметры
- logoutRequest
-
EndSessionRequest
Возвращаемое значение
Promise<void>
Наследуется от PublicClientApplication.logoutRedirect
removeEventCallback(string)
Удаляет обратный вызов с предоставленным идентификатором из массива обратного вызова
function removeEventCallback(callbackId: string)
Параметры
- callbackId
-
string
Наследуется от PublicClientApplication.removeEventCallback
removePerformanceCallback(string)
Удаляет обратный вызов, зарегистрированный с помощью addPerformanceCallback.
function removePerformanceCallback(callbackId: string): boolean
Параметры
- callbackId
-
string
Возвращаемое значение
boolean
Наследуется от PublicClientApplication.removePerformanceCallback
setActiveAccount(null | AccountInfo)
Задает учетную запись, используемую в качестве активной учетной записи. Если учетная запись не передается в API-интерфейсы acquireToken, MSAL будет использовать эту активную учетную запись.
function setActiveAccount(account: null | AccountInfo)
Параметры
- account
-
null | AccountInfo
Наследуется от PublicClientApplication.setActiveAccount
setLogger(Logger)
Заменяет набор средств ведения журнала по умолчанию в конфигурациях новым средство ведения журнала новыми конфигурациями.
function setLogger(logger: Logger)
Параметры
- logger
- Logger
Экземпляр средства ведения журнала
Наследуется от PublicClientApplication.setLogger
setNavigationClient(INavigationClient)
Задает клиент навигации
function setNavigationClient(navigationClient: INavigationClient)
Параметры
- navigationClient
-
INavigationClient
Наследуется от PublicClientApplication.setNavigationClient
ssoSilent(Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>)
Эта функция использует скрытый iframe для получения кода авторизации из eSTS. Существуют случаи, когда это может не работать:
- Любой браузер с помощью формы интеллектуального предотвращения отслеживания
- Если в службе нет установленного сеанса
В этих случаях запрос должен выполняться внутри всплывающего окна или полного перенаправления кадров.
В случаях, когда требуется взаимодействие, вы не можете отправить запрос с запросом=none.
Если срок действия маркера обновления истек, эту функцию можно использовать для автоматического получения нового набора маркеров до тех пор, пока сеанс на сервере по-прежнему существует.
function ssoSilent(request: Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>): Promise<AuthenticationResult>
Параметры
- request
-
Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>
Возвращаемое значение
Promise<AuthenticationResult>
Обещание, которое выполняется при завершении этой функции или отклонено, если возникла ошибка.
Наследуется от PublicClientApplication.ssoSilent