Aracılığıyla paylaş

DeviceCodeCredential class

  • Başvuru
Paket:
@azure/identity

Kullanıcının içine girebileceği https://microsoft.com/deviceloginbir cihaz kodu kullanarak Microsoft Entra ID kimlik doğrulamasını etkinleştirir.

Oluşturucular

DeviceCodeCredential(DeviceCodeCredentialOptions)

Microsoft Entra ID ile cihaz kodu yetkilendirme akışını başlatmak için gereken ayrıntıları içeren bir DeviceCodeCredential örneği oluşturur.

Kullanıcılara, kimlik doğrulaması için kullanabilecekleri bir kod veren bir ileti günlüğe kaydedilir https://microsoft.com/devicelogin

Geliştiriciler özel userPromptCallbackbir geçirerek bu iletinin nasıl gösterileceğini yapılandırabilir:

const credential = new DeviceCodeCredential({
  tenantId: env.AZURE_TENANT_ID,
  clientId: env.AZURE_CLIENT_ID,
  userPromptCallback: (info) => {
    console.log("CUSTOMIZED PROMPT CALLBACK", info.message);
  }
});

Yöntemler

authenticate(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.

Belirteç sessizce alınamazsa, bu yöntem belirteci almak için kullanıcı etkileşimi gerektirir.
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.

Kullanıcı seçeneğini disableAutomaticAuthenticationsağladıysa, belirteç sessizce alınamadıktan sonra, bu yöntem belirteci almak için kullanıcı etkileşimi istemeye çalışmaz.

Oluşturucu Ayrıntıları

DeviceCodeCredential(DeviceCodeCredentialOptions)

Microsoft Entra ID ile cihaz kodu yetkilendirme akışını başlatmak için gereken ayrıntıları içeren bir DeviceCodeCredential örneği oluşturur.

Kullanıcılara, kimlik doğrulaması için kullanabilecekleri bir kod veren bir ileti günlüğe kaydedilir https://microsoft.com/devicelogin

Geliştiriciler özel userPromptCallbackbir geçirerek bu iletinin nasıl gösterileceğini yapılandırabilir:

const credential = new DeviceCodeCredential({
  tenantId: env.AZURE_TENANT_ID,
  clientId: env.AZURE_CLIENT_ID,
  userPromptCallback: (info) => {
    console.log("CUSTOMIZED PROMPT CALLBACK", info.message);
  }
});

new DeviceCodeCredential(options?: DeviceCodeCredentialOptions)

Parametreler

options
DeviceCodeCredentialOptions

Kimlik doğrulama isteklerini yapan istemciyi yapılandırma seçenekleri.

Yöntem Ayrıntıları

authenticate(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.

Belirteç sessizce alınamazsa, bu yöntem belirteci almak için kullanıcı etkileşimi gerektirir.

function authenticate(scopes: string | string[], options?: GetTokenOptions): Promise<undefined | AuthenticationRecord>

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<undefined | AuthenticationRecord>

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.

Kullanıcı seçeneğini disableAutomaticAuthenticationsağladıysa, belirteç sessizce alınamadıktan sonra, bu yöntem belirteci almak için kullanıcı etkileşimi istemeye çalışmaz.

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>