ClientSecretCredential class

Pakiet:

@azure/identity

Umożliwia uwierzytelnianie Tożsamość Microsoft Entra przy użyciu klucza tajnego klienta, który został wygenerowany na potrzeby rejestracji aplikacji. Więcej informacji na temat konfigurowania klucza tajnego klienta można znaleźć tutaj:

https://learn.microsoft.com/entra/identity-platform/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application

Konstruktory

ClientSecretCredential(string, string, string, ClientSecretCredentialOptions)

Tworzy wystąpienie obiektu ClientSecretCredential ze szczegółami wymaganymi do uwierzytelniania w Tożsamość Microsoft Entra przy użyciu klucza tajnego klienta.

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 nie powiedzie się, zostanie zgłoszony błąd CredentialUnavailableError ze szczegółami niepowodzenia.

Szczegóły konstruktora

ClientSecretCredential(string, string, string, ClientSecretCredentialOptions)

Tworzy wystąpienie obiektu ClientSecretCredential ze szczegółami wymaganymi do uwierzytelniania w Tożsamość Microsoft Entra przy użyciu klucza tajnego klienta.

new ClientSecretCredential(tenantId: string, clientId: string, clientSecret: string, options?: ClientSecretCredentialOptions)

Parametry

tenantId

string

Identyfikator dzierżawy (katalogu) Microsoft Entra.

clientId

string

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

clientSecret

string

Klucz tajny klienta wygenerowany dla rejestracji aplikacji.

options

ClientSecretCredentialOptions

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 nie powiedzie się, zostanie zgłoszony błąd CredentialUnavailableError ze szczegółami niepowodzenia.

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>