UsernamePasswordCredential class

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

Позволяет выполнять проверку подлинности для Microsoft Entra ID с использованием имени пользователя и пароля. Эти учетные данные требуют высокой степени доверия, поэтому их следует использовать только в том случае, если другие, более безопасные типы учетных данных не могут использоваться.

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

UsernamePasswordCredential(string, string, string, string, UsernamePasswordCredentialOptions)

Создает экземпляр UsernamePasswordCredential со сведениями, необходимыми для проверки подлинности в Microsoft Entra ID с именем пользователя и паролем.

Методы

getToken(string | string[], GetTokenOptions)

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

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

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

UsernamePasswordCredential(string, string, string, string, UsernamePasswordCredentialOptions)

Создает экземпляр UsernamePasswordCredential со сведениями, необходимыми для проверки подлинности в Microsoft Entra ID с именем пользователя и паролем.

new UsernamePasswordCredential(tenantId: string, clientId: string, username: string, password: string, options?: UsernamePasswordCredentialOptions)

Параметры

tenantId

string

Клиент (каталог) Microsoft Entra.

clientId

string

Идентификатор клиента (приложения) регистрации приложения в клиенте.

username

string

Адрес электронной почты (имя пользователя) учетной записи пользователя.

password

string

Пароль учетной записи пользователя

options
UsernamePasswordCredentialOptions

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

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

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>