Udostępnij za pośrednictwem

AuthorizationCodeCredential class

  • Odwołanie
Pakiet:
@azure/identity

Umożliwia uwierzytelnianie Tożsamość Microsoft Entra przy użyciu kodu autoryzacji uzyskanego za pośrednictwem przepływu kodu autoryzacji, opisanego bardziej szczegółowo w dokumentacji Tożsamość Microsoft Entra:

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 żądania tokenu dostępu przy użyciu uwierzytelniania uzyskanego z Tożsamość Microsoft Entra.

Obecnie konieczne jest, aby użytkownik tego poświadczenia zainicjował przepływ kodu autoryzacji w celu uzyskania kodu autoryzacji do użycia z tym poświadczeniam. Pełny przykład tego przepływu przedstawiono 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 żądania tokenu dostępu przy użyciu uwierzytelniania uzyskanego z Tożsamość Microsoft Entra.

Obecnie konieczne jest, aby użytkownik tego poświadczenia zainicjował przepływ kodu autoryzacji w celu uzyskania kodu autoryzacji do użycia z tym poświadczeniam. Pełny przykład tego przepływu przedstawiono 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 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.

Szczegóły konstruktora

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

Tworzy wystąpienie elementu AuthorizationCodeCredential ze szczegółami wymaganymi do żądania tokenu dostępu przy użyciu uwierzytelniania uzyskanego z Tożsamość Microsoft Entra.

Obecnie konieczne jest, aby użytkownik tego poświadczenia zainicjował przepływ kodu autoryzacji w celu uzyskania kodu autoryzacji do użycia z tym poświadczeniam. Pełny przykład tego przepływu przedstawiono 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 Microsoft Entra (katalogu). "typowe" mogą być używane w przypadku obsługi scenariuszy obejmujących wiele dzierżaw.

clientId

string

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

authorizationCode

string

Kod autoryzacji odebrany z następującego przepływu kodu autoryzacji. Ten kod autoryzacji nie może być już 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 żądania tokenu dostępu przy użyciu uwierzytelniania uzyskanego z Tożsamość Microsoft Entra.

Obecnie konieczne jest, aby użytkownik tego poświadczenia zainicjował przepływ kodu autoryzacji w celu uzyskania kodu autoryzacji do użycia z tym poświadczeniam. Pełny przykład tego przepływu przedstawiono 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 Microsoft Entra (katalogu). "typowe" mogą być używane w przypadku obsługi scenariuszy obejmujących wiele dzierżaw.

clientId

string

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

clientSecret

string

Klucz tajny klienta wygenerowany dla rejestracji aplikacji

authorizationCode

string

Kod autoryzacji odebrany z następującego przepływu kodu autoryzacji. Ten kod autoryzacji nie może być już 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 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.

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>