InteractiveBrowserCredential class

  • Ссылка
Пакет:
@azure/identity

Включает проверку подлинности для Microsoft Entra ID в веб-браузере с помощью интерактивного потока входа.

Конструкторы

InteractiveBrowserCredential(InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

Создает экземпляр InteractiveBrowserCredential с необходимыми сведениями.

Эти учетные данные используют поток кода авторизации. На Node.js откроется окно браузера, прослушивая ответ перенаправления от службы проверки подлинности. В браузерах проверка подлинности выполняется через всплывающие окна. Необязательный loginStyle параметр может иметь значение redirect для проверки подлинности, перенаправляя пользователя на страницу безопасного входа Azure, которая затем перенаправит пользователя обратно в веб-приложение, с которого началась проверка подлинности.

Для Node.js, если clientId предоставляется , необходимо настроить Microsoft Entra приложение так, чтобы у него была конечная точка перенаправления "Мобильные и классические приложения". Следуйте нашему руководству по настройке URI перенаправления для классических приложений, которые вызывают веб-API.

Методы

authenticate(string | string[], GetTokenOptions)

Выполняет проверку подлинности с помощью Microsoft Entra ID и возвращает маркер доступа в случае успешного выполнения. Если проверка подлинности завершается сбоем, выдается credentialUnavailableError со сведениями о сбое.

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

На Node.js для этих учетных данных по умолчанию включен ключ проверки для обмена кодом (PKCE ). PKCE — это функция безопасности, которая устраняет атаки перехвата кода проверки подлинности.
getToken(string | string[], GetTokenOptions)

Выполняет проверку подлинности с помощью Microsoft Entra ID и возвращает маркер доступа в случае успешного выполнения. Если проверка подлинности завершается сбоем, выдается credentialUnavailableError со сведениями о сбое.

Если пользователь указал параметр disableAutomaticAuthentication, после того как маркер не может быть получен автоматически, этот метод не будет пытаться запросить взаимодействие с пользователем для получения маркера.

Сведения о конструкторе

InteractiveBrowserCredential(InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

Создает экземпляр InteractiveBrowserCredential с необходимыми сведениями.

Эти учетные данные используют поток кода авторизации. На Node.js откроется окно браузера, прослушивая ответ перенаправления от службы проверки подлинности. В браузерах проверка подлинности выполняется через всплывающие окна. Необязательный loginStyle параметр может иметь значение redirect для проверки подлинности, перенаправляя пользователя на страницу безопасного входа Azure, которая затем перенаправит пользователя обратно в веб-приложение, с которого началась проверка подлинности.

Для Node.js, если clientId предоставляется , необходимо настроить Microsoft Entra приложение так, чтобы у него была конечная точка перенаправления "Мобильные и классические приложения". Следуйте нашему руководству по настройке URI перенаправления для классических приложений, которые вызывают веб-API.

new InteractiveBrowserCredential(options: InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

Параметры

options

InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions

Параметры настройки клиента, который выполняет запросы проверки подлинности.

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

authenticate(string | string[], GetTokenOptions)

Выполняет проверку подлинности с помощью Microsoft Entra ID и возвращает маркер доступа в случае успешного выполнения. Если проверка подлинности завершается сбоем, выдается credentialUnavailableError со сведениями о сбое.

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

На Node.js для этих учетных данных по умолчанию включен ключ проверки для обмена кодом (PKCE ). PKCE — это функция безопасности, которая устраняет атаки перехвата кода проверки подлинности.

function authenticate(scopes: string | string[], options?: GetTokenOptions): Promise<undefined | AuthenticationRecord>

Параметры

scopes

string | string[]

Список областей, доступ к которым будет иметь маркер.

options
GetTokenOptions

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

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

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

Выполняет проверку подлинности с помощью Microsoft Entra ID и возвращает маркер доступа в случае успешного выполнения. Если проверка подлинности завершается сбоем, выдается credentialUnavailableError со сведениями о сбое.

Если пользователь указал параметр disableAutomaticAuthentication, после того как маркер не может быть получен автоматически, этот метод не будет пытаться запросить взаимодействие с пользователем для получения маркера.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

Параметры

scopes

string | string[]

Список областей, доступ к которым будет иметь маркер.

options
GetTokenOptions

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

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

Promise<AccessToken>