Udostępnij za pośrednictwem

UsernamePasswordCredential class

  • Odwołanie
Pakiet:
@azure/identity

Ostrzeżenie

Ten interfejs API jest już przestarzały.

UsernamePasswordCredential is deprecated. Use a more secure credential. See https://aka.ms/azsdk/identity/mfa for details.

Umożliwia uwierzytelnianie w usłudze Microsoft Entra ID z nazwą użytkownika i hasłem użytkownika. 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 w identyfikatorze Entra firmy Microsoft przy użyciu nazwy użytkownika i hasła.

Metody

getToken(string | string[], GetTokenOptions)

Uwierzytelnia się przy użyciu identyfikatora Entra firmy Microsoft i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony CredentialUnavailableError ze szczegółami błędu.

Jeśli użytkownik podał opcję disableAutomaticAuthentication, gdy nie można pobrać tokenu w trybie dyskretnym, ta metoda nie podejmie próby zażądania 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 w identyfikatorze Entra firmy Microsoft 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 firmy Microsoft Entra (katalog).

clientId

string

Identyfikator klienta (aplikacji) zarejestrowanej 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 identyfikatora Entra firmy Microsoft i zwraca token dostępu, jeśli się powiedzie. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony CredentialUnavailableError ze szczegółami błędu.

Jeśli użytkownik podał opcję disableAutomaticAuthentication, gdy nie można pobrać tokenu w trybie dyskretnym, ta metoda nie podejmie próby zażądania 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>