IPublicClientApplication interface

Пакет:

@azure/msal-node

Интерфейс для класса PublicClientApplication, определяющего подписи общедоступного API

Методы

acquireTokenByCode(AuthorizationCodeRequest)	Получает токен, обмениваясь кодом авторизации, полученным на первом шаге потока кода авторизации OAuth 2.0
acquireTokenByDeviceCode(DeviceCodeRequest)	Получает маркер от центра с помощью потока кода устройства OAuth2.0
acquireTokenByRefreshToken(RefreshTokenRequest)	Получение маркера путем обмена маркером обновления, предоставленного для нового набора маркеров.
acquireTokenByUsernamePassword(UsernamePasswordRequest)	Получает маркеры с предоставлением пароля, обмениваясь именем пользователя и паролем клиентских приложений для учетных данных
acquireTokenInteractive(InteractiveRequest)	Получение маркера в интерактивном режиме
acquireTokenSilent(SilentFlowRequest)	Получает токен автоматически, когда пользователь указывает учетную запись, для этого запрашивается маркер.
clearCache()	Очистите кэш
getAllAccounts()	Возвращает все кэшированные учетные записи
getAuthCodeUrl(AuthorizationUrlRequest)	Создает URL-адрес запроса авторизации
getLogger()	Возвращает экземпляр средства ведения журнала
getTokenCache()	Возвращает кэш маркеров для приложения
setLogger(Logger)	Заменяет набор средств ведения журнала по умолчанию в конфигурациях новым средство ведения журнала новыми конфигурациями.
signOut(SignOutRequest)	Удаляет артефакты кэша, связанные с данной учетной записью

Сведения о методе

acquireTokenByCode(AuthorizationCodeRequest)

Получает токен, обмениваясь кодом авторизации, полученным на первом шаге потока кода авторизации OAuth 2.0

function acquireTokenByCode(request: AuthorizationCodeRequest): Promise<AuthenticationResult>

Параметры

request

AuthorizationCodeRequest

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

Promise<AuthenticationResult>

acquireTokenByDeviceCode(DeviceCodeRequest)

Получает маркер от центра с помощью потока кода устройства OAuth2.0

function acquireTokenByDeviceCode(request: DeviceCodeRequest): Promise<null | AuthenticationResult>

Параметры

request

DeviceCodeRequest

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

Promise<null | AuthenticationResult>

acquireTokenByRefreshToken(RefreshTokenRequest)

Получение маркера путем обмена маркером обновления, предоставленного для нового набора маркеров.

function acquireTokenByRefreshToken(request: RefreshTokenRequest): Promise<null | AuthenticationResult>

Параметры

request

RefreshTokenRequest

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

Promise<null | AuthenticationResult>

acquireTokenByUsernamePassword(UsernamePasswordRequest)

Предупреждение

Теперь этот API является нерекомендуемым.

• Use a more secure flow instead

Получает маркеры с предоставлением пароля, обмениваясь именем пользователя и паролем клиентских приложений для учетных данных

function acquireTokenByUsernamePassword(request: UsernamePasswordRequest): Promise<null | AuthenticationResult>

Параметры

request

UsernamePasswordRequest

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

Promise<null | AuthenticationResult>

acquireTokenInteractive(InteractiveRequest)

Получение маркера в интерактивном режиме

function acquireTokenInteractive(request: InteractiveRequest): Promise<AuthenticationResult>

Параметры

request

InteractiveRequest

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

Promise<AuthenticationResult>

acquireTokenSilent(SilentFlowRequest)

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

function acquireTokenSilent(request: SilentFlowRequest): Promise<AuthenticationResult>

Параметры

request

SilentFlowRequest

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

Promise<AuthenticationResult>

clearCache()

Очистите кэш

function clearCache()

getAllAccounts()

Возвращает все кэшированные учетные записи

function getAllAccounts(): Promise<AccountInfo[]>

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

Promise<AccountInfo[]>

getAuthCodeUrl(AuthorizationUrlRequest)

Создает URL-адрес запроса авторизации

function getAuthCodeUrl(request: AuthorizationUrlRequest): Promise<string>

Параметры

request

AuthorizationUrlRequest

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

Promise<string>

getLogger()

Возвращает экземпляр средства ведения журнала

function getLogger(): Logger

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

Logger

getTokenCache()

Возвращает кэш маркеров для приложения

function getTokenCache(): TokenCache

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

TokenCache

setLogger(Logger)

Заменяет набор средств ведения журнала по умолчанию в конфигурациях новым средство ведения журнала новыми конфигурациями.

function setLogger(logger: Logger)

Параметры

logger

Logger

signOut(SignOutRequest)

Удаляет артефакты кэша, связанные с данной учетной записью

function signOut(request: SignOutRequest): Promise<void>

Параметры

request

SignOutRequest

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

Promise<void>