Sdílet prostřednictvím

AuthorizationCodeCredential class

  • Reference
Balíček:
@azure/identity

Umožňuje ověřování 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 popsaný 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 Microsoft Entra ID.

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á s tímto pověřením použít. Úplný příklad tohoto toku najdete tady:

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 Microsoft Entra ID.

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á s tímto pověřením použít. Úplný příklad tohoto toku najdete tady:

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

Metody

getToken(string | string[], GetTokenOptions)

Provede ověření pomocí Microsoft Entra ID a v případě úspěchu vrátí přístupový token. Pokud ověřování selže, vyvolá se chyba 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 Microsoft Entra ID.

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á s tímto pověřením použít. Úplný příklad tohoto toku najdete tady:

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 Microsoft Entra tenanta (adresáře). Při řešení scénářů s více tenanty se může používat "common".

clientId

string

ID klienta (aplikace) registrace aplikace v tenantovi.

authorizationCode

string

Autorizační kód, který byl přijat od toku autorizačního kódu. Tento autorizační kód již nesmí být 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í to být stejný identifikátor URI, který je nakonfigurovaný pro registraci aplikace.

options
AuthorizationCodeCredentialOptions

Možnosti konfigurace klienta, který provede 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 Microsoft Entra ID.

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á s tímto pověřením použít. Úplný příklad tohoto toku najdete tady:

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 Microsoft Entra tenanta (adresáře). Při řešení scénářů s více tenanty se může používat "common".

clientId

string

ID klienta (aplikace) registrace aplikace v tenantovi.

clientSecret

string

Tajný klíč klienta vygenerovaný pro registraci aplikace

authorizationCode

string

Autorizační kód, který byl přijat od toku autorizačního kódu. Tento autorizační kód již nesmí být 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í to být stejný identifikátor URI, který je nakonfigurovaný pro registraci aplikace.

options
AuthorizationCodeCredentialOptions

Možnosti konfigurace klienta, který provede požadavek na přístupový token.

Podrobnosti metody

getToken(string | string[], GetTokenOptions)

Provede ověření pomocí Microsoft Entra ID a v případě úspěchu vrátí přístupový token. Pokud ověřování selže, vyvolá se chyba CredentialUnavailableError s podrobnostmi o selhání.

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

Parametry

scopes

string | string[]

Seznam oborů, ke kterým bude mít token přístup.

options
GetTokenOptions

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

Návraty

Promise<AccessToken>