Aracılığıyla paylaş

AuthorizationCodeCredential class

  • Başvuru
Paket:
@azure/identity

kimlik doğrulamasının Microsoft Entra ID belgelerinde daha ayrıntılı olarak açıklanan yetkilendirme kodu akışı aracılığıyla alınan yetkilendirme kodunu kullanarak Microsoft Entra ID sağlar:

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

Oluşturucular

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

Microsoft Entra ID alınan bir kimlik doğrulamasını kullanarak erişim belirteci istemek için gereken ayrıntıları içeren bir AuthorizationCodeCredential örneği oluşturur.

Şu anda bu kimlik bilgisinin kullanıcısının, bu kimlik bilgileriyle kullanılacak bir yetkilendirme kodu almak için yetkilendirme kodu akışını başlatması gerekir. Bu akışın tam örneği burada verilmiştir:

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)

Microsoft Entra ID alınan bir kimlik doğrulamasını kullanarak erişim belirteci istemek için gereken ayrıntıları içeren bir AuthorizationCodeCredential örneği oluşturur.

Şu anda bu kimlik bilgisinin kullanıcısının, bu kimlik bilgileriyle kullanılacak bir yetkilendirme kodu almak için yetkilendirme kodu akışını başlatması gerekir. Bu akışın tam örneği burada verilmiştir:

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

Yöntemler

getToken(string | string[], GetTokenOptions)

Microsoft Entra ID ile kimlik doğrulaması yapar ve başarılı olursa bir erişim belirteci döndürür. Kimlik doğrulaması başarısız olursa, hatanın ayrıntılarıyla birlikte bir CredentialUnavailableError oluşturulur.

Oluşturucu Ayrıntıları

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

Microsoft Entra ID alınan bir kimlik doğrulamasını kullanarak erişim belirteci istemek için gereken ayrıntıları içeren bir AuthorizationCodeCredential örneği oluşturur.

Şu anda bu kimlik bilgisinin kullanıcısının, bu kimlik bilgileriyle kullanılacak bir yetkilendirme kodu almak için yetkilendirme kodu akışını başlatması gerekir. Bu akışın tam örneği burada verilmiştir:

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)

Parametreler

tenantId

string

Microsoft Entra kiracı (dizin) kimliği veya adı. Çok kiracılı senaryolarla ilgilenirken 'ortak' kullanılabilir.

clientId

string

Kiracıdaki bir Uygulama Kaydının istemci (uygulama) kimliği.

authorizationCode

string

Yetkilendirme kodu akışından alınan yetkilendirme kodu. Bu yetkilendirme kodu erişim belirteci almak için önceden kullanılmamış olmalıdır.

redirectUri

string

Yetkilendirme kodunu istemek için kullanılan yeniden yönlendirme URI'si. Uygulama Kaydı için yapılandırılan URI ile aynı olmalıdır.

options
AuthorizationCodeCredentialOptions

Erişim belirteci isteğinde bulunan istemciyi yapılandırma seçenekleri.

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

Microsoft Entra ID alınan bir kimlik doğrulamasını kullanarak erişim belirteci istemek için gereken ayrıntıları içeren bir AuthorizationCodeCredential örneği oluşturur.

Şu anda bu kimlik bilgisinin kullanıcısının, bu kimlik bilgileriyle kullanılacak bir yetkilendirme kodu almak için yetkilendirme kodu akışını başlatması gerekir. Bu akışın tam örneği burada verilmiştir:

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)

Parametreler

tenantId

string

Microsoft Entra kiracı (dizin) kimliği veya adı. Çok kiracılı senaryolarla ilgilenirken 'ortak' kullanılabilir.

clientId

string

Kiracıdaki bir Uygulama Kaydının istemci (uygulama) kimliği.

clientSecret

string

Uygulama Kaydı için oluşturulan bir istemci gizli dizisi

authorizationCode

string

Yetkilendirme kodu akışından alınan yetkilendirme kodu. Bu yetkilendirme kodu erişim belirteci almak için önceden kullanılmamış olmalıdır.

redirectUri

string

Yetkilendirme kodunu istemek için kullanılan yeniden yönlendirme URI'si. Uygulama Kaydı için yapılandırılan URI ile aynı olmalıdır.

options
AuthorizationCodeCredentialOptions

Erişim belirteci isteğinde bulunan istemciyi yapılandırma seçenekleri.

Yöntem Ayrıntıları

getToken(string | string[], GetTokenOptions)

Microsoft Entra ID ile kimlik doğrulaması yapar ve başarılı olursa bir erişim belirteci döndürür. Kimlik doğrulaması başarısız olursa, hatanın ayrıntılarıyla birlikte bir CredentialUnavailableError oluşturulur.

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

Parametreler

scopes

string | string[]

Belirtecin erişeceği kapsamların listesi.

options
GetTokenOptions

Bu TokenCredential uygulamasının gerçekleştirebileceği istekleri yapılandırmak için kullanılan seçenekler.

Döndürülenler

Promise<AccessToken>