Udostępnij za pomocą

AuthorizationCodeCredential class

Pakiet:
@azure/identity

Umożliwia uwierzytelnianie w usłudze Microsoft Entra ID przy użyciu kodu autoryzacji uzyskanego za pośrednictwem przepływu kodu autoryzacji, opisanego bardziej szczegółowo w dokumentacji identyfikatora entra firmy Microsoft:

https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow

Konstruktory

AuthorizationCodeCredential(string, string, string, string, AuthorizationCodeCredentialOptions)

Tworzy wystąpienie elementu AuthorizationCodeCredential ze szczegółami wymaganymi do zażądania tokenu dostępu przy użyciu uwierzytelniania uzyskanego z identyfikatora entra firmy Microsoft.

Obecnie użytkownik tego poświadczenia musi zainicjować przepływ kodu autoryzacji w celu uzyskania kodu autoryzacji do użycia z tym poświadczeniu. Pełny przykład tego przepływu znajduje się tutaj:

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts
AuthorizationCodeCredential(string, string, string, string, string, AuthorizationCodeCredentialOptions)

Tworzy wystąpienie elementu AuthorizationCodeCredential ze szczegółami wymaganymi do zażądania tokenu dostępu przy użyciu uwierzytelniania uzyskanego z identyfikatora entra firmy Microsoft.

Obecnie użytkownik tego poświadczenia musi zainicjować przepływ kodu autoryzacji w celu uzyskania kodu autoryzacji do użycia z tym poświadczeniu. Pełny przykład tego przepływu znajduje się tutaj:

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

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.

Szczegóły konstruktora

AuthorizationCodeCredential(string, string, string, string, AuthorizationCodeCredentialOptions)

Tworzy wystąpienie elementu AuthorizationCodeCredential ze szczegółami wymaganymi do zażądania tokenu dostępu przy użyciu uwierzytelniania uzyskanego z identyfikatora entra firmy Microsoft.

Obecnie użytkownik tego poświadczenia musi zainicjować przepływ kodu autoryzacji w celu uzyskania kodu autoryzacji do użycia z tym poświadczeniu. Pełny przykład tego przepływu znajduje się tutaj:

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

new AuthorizationCodeCredential(tenantId: string, clientId: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)

Parametry

tenantId

string

Identyfikator lub nazwa dzierżawy (katalogu) firmy Microsoft. "common" może być używany podczas pracy ze scenariuszami z wieloma dzierżawami.

clientId

string

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

authorizationCode

string

Kod autoryzacji otrzymany z przepływu kodu autoryzacji. Ten kod autoryzacji nie może być jeszcze używany do uzyskania tokenu dostępu.

redirectUri

string

Identyfikator URI przekierowania, który został użyty do żądania kodu autoryzacji. Musi być tym samym identyfikatorem URI skonfigurowanym dla rejestracji aplikacji.

options
AuthorizationCodeCredentialOptions

Opcje konfigurowania klienta, który wysyła żądanie tokenu dostępu.

AuthorizationCodeCredential(string, string, string, string, string, AuthorizationCodeCredentialOptions)

Tworzy wystąpienie elementu AuthorizationCodeCredential ze szczegółami wymaganymi do zażądania tokenu dostępu przy użyciu uwierzytelniania uzyskanego z identyfikatora entra firmy Microsoft.

Obecnie użytkownik tego poświadczenia musi zainicjować przepływ kodu autoryzacji w celu uzyskania kodu autoryzacji do użycia z tym poświadczeniu. Pełny przykład tego przepływu znajduje się tutaj:

https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/v2/manual/authorizationCodeSample.ts

new AuthorizationCodeCredential(tenantId: string, clientId: string, clientSecret: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)

Parametry

tenantId

string

Identyfikator lub nazwa dzierżawy (katalogu) firmy Microsoft. "common" może być używany podczas pracy ze scenariuszami z wieloma dzierżawami.

clientId

string

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

clientSecret

string

Wpis tajny klienta wygenerowany dla rejestracji aplikacji

authorizationCode

string

Kod autoryzacji otrzymany z przepływu kodu autoryzacji. Ten kod autoryzacji nie może być jeszcze używany do uzyskania tokenu dostępu.

redirectUri

string

Identyfikator URI przekierowania, który został użyty do żądania kodu autoryzacji. Musi być tym samym identyfikatorem URI skonfigurowanym dla rejestracji aplikacji.

options
AuthorizationCodeCredentialOptions

Opcje konfigurowania klienta, który wysyła żądanie tokenu dostępu.

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.

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>