Aracılığıyla paylaş

AuthorizationCodeCredential class

Paket:
@azure/identity

Microsoft Entra Id belgelerinde daha ayrıntılı olarak açıklanan yetkilendirme kodu akışı aracılığıyla elde edilen yetkilendirme kodunu kullanarak Microsoft Entra Id kimlik doğrulaması 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'den 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'den 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 Kimliği 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, CredentialUnavailableError hatanın ayrıntılarıyla birlikte oluşturulur.

Oluşturucu Ayrıntıları

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

Microsoft Entra Id'den 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ısı (dizin) kimliği veya adı. 'common' çok kiracılı senaryolarla ilgilenirken kullanılabilir.

clientId

string

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

authorizationCode

string

Yetkilendirme kodu akışı izlenerek alınan yetkilendirme kodu. Erişim belirteci almak için bu yetkilendirme kodu ö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'den 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ısı (dizin) kimliği veya adı. 'common' çok kiracılı senaryolarla ilgilenirken 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ışı izlenerek alınan yetkilendirme kodu. Erişim belirteci almak için bu yetkilendirme kodu ö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 Kimliği 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, CredentialUnavailableError hatanın ayrıntılarıyla birlikte 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>