Sdílet prostřednictvím

AuthorizationCodeCredential class

  • Reference
Balíček:
@azure/identity

Umožňuje ověřování pro Microsoft Entra ID pomocí autorizačního kódu získaného prostřednictvím toku autorizačního kódu, který je podrobněji popsán v dokumentaci k Microsoft Entra ID:

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

Konstruktory

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

Vytvoří instanci AuthorizationCodeCredential s podrobnostmi potřebnými k vyžádání přístupového tokenu pomocí ověřování získaného z ID Microsoft Entra.

V současné době je nutné, aby uživatel těchto přihlašovacích údajů zahájil tok autorizačního kódu, aby získal autorizační kód, který se má použít s tímto přihlašovacími údaji. Tady je úplný příklad tohoto toku:

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)

Vytvoří instanci AuthorizationCodeCredential s podrobnostmi potřebnými k vyžádání přístupového tokenu pomocí ověřování získaného z ID Microsoft Entra.

V současné době je nutné, aby uživatel těchto přihlašovacích údajů zahájil tok autorizačního kódu, aby získal autorizační kód, který se má použít s tímto přihlašovacími údaji. Tady je úplný příklad tohoto toku:

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

Metody

getToken(string | string[], GetTokenOptions)

Ověří se pomocí ID Microsoft Entra a v případě úspěchu vrátí přístupový token. Pokud se ověření nezdaří, zobrazí se CredentialUnavailableError s podrobnostmi o selhání.

Podrobnosti konstruktoru

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

Vytvoří instanci AuthorizationCodeCredential s podrobnostmi potřebnými k vyžádání přístupového tokenu pomocí ověřování získaného z ID Microsoft Entra.

V současné době je nutné, aby uživatel těchto přihlašovacích údajů zahájil tok autorizačního kódu, aby získal autorizační kód, který se má použít s tímto přihlašovacími údaji. Tady je úplný příklad tohoto toku:

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

ID nebo název tenanta Microsoft Entra. Při řešení scénářů s více tenanty se můžou používat běžné scénáře.

clientId

string

ID klienta (aplikace) registrace aplikace v tenantovi.

authorizationCode

string

Autorizační kód přijatý po toku autorizačního kódu. Tento autorizační kód již nebyl použit k získání přístupového tokenu.

redirectUri

string

Identifikátor URI přesměrování, který byl použit k vyžádání autorizačního kódu. Musí být stejný identifikátor URI, který je nakonfigurovaný pro registraci aplikace.

options
AuthorizationCodeCredentialOptions

Možnosti konfigurace klienta, který provádí požadavek na přístupový token

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

Vytvoří instanci AuthorizationCodeCredential s podrobnostmi potřebnými k vyžádání přístupového tokenu pomocí ověřování získaného z ID Microsoft Entra.

V současné době je nutné, aby uživatel těchto přihlašovacích údajů zahájil tok autorizačního kódu, aby získal autorizační kód, který se má použít s tímto přihlašovacími údaji. Tady je úplný příklad tohoto toku:

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

ID nebo název tenanta Microsoft Entra. Při řešení scénářů s více tenanty se můžou používat běžné scénáře.

clientId

string

ID klienta (aplikace) registrace aplikace v tenantovi.

clientSecret

string

Tajný klíč klienta vygenerovaný pro registraci aplikace

authorizationCode

string

Autorizační kód přijatý po toku autorizačního kódu. Tento autorizační kód již nebyl použit k získání přístupového tokenu.

redirectUri

string

Identifikátor URI přesměrování, který byl použit k vyžádání autorizačního kódu. Musí být stejný identifikátor URI, který je nakonfigurovaný pro registraci aplikace.

options
AuthorizationCodeCredentialOptions

Možnosti konfigurace klienta, který provádí požadavek na přístupový token

Podrobnosti metody

getToken(string | string[], GetTokenOptions)

Ověří se pomocí ID Microsoft Entra a v případě úspěchu vrátí přístupový token. Pokud se ověření nezdaří, zobrazí se CredentialUnavailableError s podrobnostmi o selhání.

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

Parametry

scopes

string | string[]

Seznam oborů, pro které bude mít token přístup.

options
GetTokenOptions

Možnosti použité ke konfiguraci všech požadavků, které tato implementace TokenCredential může provést.

Návraty

Promise<AccessToken>