ClientApplication class

Пакет:: @azure/msal-node

Базовый абстрактный класс для всех ClientApplications — общедоступный и конфиденциальный

Методы

acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)	Получает токен, обмениваясь кодом авторизации, полученным на первом шаге потока кода авторизации OAuth2.0. `getAuthCodeUrl(AuthorizationCodeUrlRequest)` можно использовать для создания URL-адреса для первого шага потока кода авторизации OAuth2.0. Убедитесь, что значения перенаправления и области в AuthorizationCodeUrlRequest и AuthorizationCodeRequest совпадают.
acquireTokenByRefreshToken(RefreshTokenRequest)	Получает маркер, обмениваясь маркером обновления, предоставленным для нового набора маркеров. Этот API предоставляется только для сценариев, в которых требуется выполнить миграцию из ADAL в MSAL. В противном случае рекомендуется использовать `acquireTokenSilent()` для автоматических сценариев. При использовании `acquireTokenSilent()`MSAL будет обрабатывать кэширование и обновление маркеров автоматически.
acquireTokenByUsernamePassword(UsernamePasswordRequest)	Получает маркеры с предоставлением пароля, обмениваясь именем пользователя и паролем клиентских приложений для учетных данных Последняя политика безопасности OAuth 2.0 рекомендуется полностью запретить предоставление пароля. Дополнительные сведения об этой рекомендации см. в https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 документации и рекомендациях Microsoft:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword
acquireTokenSilent(SilentFlowRequest)	Автоматически получает маркер, когда пользователь указывает учетную запись, для нее запрашивается маркер. Этот API ожидает, что пользователь предоставит объект учетной записи и просматривает кэш, чтобы получить маркер при наличии. Кроме того, существует необязательный логический параметр forceRefresh, который пользователь может отправить для обхода кэша для access_token и id_token. Если срок действия refresh_token истек или не найден, возникает ошибка, и в этом случае пользователю рекомендуется вызывать любой API получения интерактивных маркеров (например: `acquireTokenByCode()`).
clearCache()	Очистите кэш
getAuthCodeUrl(AuthorizationUrlRequest)	Создает URL-адрес запроса авторизации, позволяя пользователю вводить учетные данные и давать согласие приложению. URL-адрес предназначен для конечной точки /authorize центра, настроенного в объекте приложения. После ввода учетными данными и согласия пользователя центр отправит ответ на URI перенаправления, отправленный в запросе, и должен содержать код авторизации, который затем можно использовать для получения маркеров с помощью `acquireTokenByCode(AuthorizationCodeRequest)`.
getLogger()	Возвращает экземпляр средства ведения журнала
getTokenCache()	Возвращает кэш маркеров для приложения.
setLogger(Logger)	Заменяет набор средств ведения журнала по умолчанию в конфигурациях новым средство ведения журнала новыми конфигурациями.

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

acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)

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

getAuthCodeUrl(AuthorizationCodeUrlRequest) можно использовать для создания URL-адреса для первого шага потока кода авторизации OAuth2.0. Убедитесь, что значения перенаправления и области в AuthorizationCodeUrlRequest и AuthorizationCodeRequest совпадают.

function acquireTokenByCode(request: AuthorizationCodeRequest, authCodePayLoad?: AuthorizationCodePayload): Promise<AuthenticationResult>

Параметры

request: AuthorizationCodeRequest

authCodePayLoad: AuthorizationCodePayload

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

Promise<AuthenticationResult>

acquireTokenByRefreshToken(RefreshTokenRequest)

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

Этот API предоставляется только для сценариев, в которых требуется выполнить миграцию из ADAL в MSAL. В противном случае рекомендуется использовать acquireTokenSilent() для автоматических сценариев. При использовании acquireTokenSilent()MSAL будет обрабатывать кэширование и обновление маркеров автоматически.

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

Параметры

request: RefreshTokenRequest

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

Promise<null | AuthenticationResult>

acquireTokenByUsernamePassword(UsernamePasswordRequest)

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

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

Use a more secure flow instead

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

Последняя политика безопасности OAuth 2.0 рекомендуется полностью запретить предоставление пароля. Дополнительные сведения об этой рекомендации см. в https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 документации и рекомендациях Microsoft:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword

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

Параметры

request: UsernamePasswordRequest

UsenamePasswordRequest

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

Promise<null | AuthenticationResult>

acquireTokenSilent(SilentFlowRequest)

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

Этот API ожидает, что пользователь предоставит объект учетной записи и просматривает кэш, чтобы получить маркер при наличии. Кроме того, существует необязательный логический параметр forceRefresh, который пользователь может отправить для обхода кэша для access_token и id_token. Если срок действия refresh_token истек или не найден, возникает ошибка, и в этом случае пользователю рекомендуется вызывать любой API получения интерактивных маркеров (например: acquireTokenByCode()).

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

Параметры

request: SilentFlowRequest

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

Promise<AuthenticationResult>

clearCache()

Очистите кэш

function clearCache()

getAuthCodeUrl(AuthorizationUrlRequest)

Создает URL-адрес запроса авторизации, позволяя пользователю вводить учетные данные и давать согласие приложению. URL-адрес предназначен для конечной точки /authorize центра, настроенного в объекте приложения.

После ввода учетными данными и согласия пользователя центр отправит ответ на URI перенаправления, отправленный в запросе, и должен содержать код авторизации, который затем можно использовать для получения маркеров с помощью acquireTokenByCode(AuthorizationCodeRequest).

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

Экземпляр средства ведения журнала