Udostępnij za pośrednictwem

UsernamePasswordCredential class

  • Odwołanie
Pakiet:
@azure/identity

Umożliwia uwierzytelnianie Tożsamość Microsoft Entra przy użyciu nazwy użytkownika i hasła. To poświadczenie wymaga wysokiego stopnia zaufania, dlatego należy używać go tylko wtedy, gdy nie można używać innych, bezpieczniejszych typów poświadczeń.

Konstruktory

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

Tworzy wystąpienie elementu UsernamePasswordCredential ze szczegółami wymaganymi do uwierzytelnienia względem Tożsamość Microsoft Entra przy użyciu nazwy użytkownika i hasła.

Metody

getToken(string | string[], GetTokenOptions)

Uwierzytelnia się przy użyciu Tożsamość Microsoft Entra i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie zakończy się niepowodzeniem, zostanie zgłoszony błąd CredentialUnavailableError ze szczegółami błędu.

Jeśli użytkownik podał opcję disableAutomaticAuthentication, gdy token nie będzie można pobrać w trybie dyskretnym, ta metoda nie spróbuje zażądać interakcji użytkownika w celu pobrania tokenu.

Szczegóły konstruktora

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

Tworzy wystąpienie elementu UsernamePasswordCredential ze szczegółami wymaganymi do uwierzytelnienia względem Tożsamość Microsoft Entra przy użyciu nazwy użytkownika i hasła.

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

Parametry

tenantId

string

Dzierżawa Microsoft Entra (katalog).

clientId

string

Identyfikator klienta (aplikacji) rejestracji aplikacji w dzierżawie.

username

string

Adres e-mail konta użytkownika (nazwa użytkownika).

password

string

Hasło konta użytkownika

options
UsernamePasswordCredentialOptions

Opcje konfigurowania klienta, który wysyła żądanie uwierzytelniania.

Szczegóły metody

getToken(string | string[], GetTokenOptions)

Uwierzytelnia się przy użyciu Tożsamość Microsoft Entra i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie zakończy się niepowodzeniem, zostanie zgłoszony błąd CredentialUnavailableError ze szczegółami błędu.

Jeśli użytkownik podał opcję disableAutomaticAuthentication, gdy token nie będzie można pobrać w trybie dyskretnym, ta metoda nie spróbuje zażądać interakcji użytkownika w celu pobrania tokenu.

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

Parametry

scopes

string | string[]

Lista zakresów, dla których token będzie miał dostęp.

options
GetTokenOptions

Opcje używane do konfigurowania żądań, które mogą być tworzone przez tę implementację TokenCredential.

Zwraca

Promise<AccessToken>