Share via

DeviceCodeCredential class

  • Referensi
Paket:
@azure/identity

Memungkinkan autentikasi untuk Microsoft Entra ID menggunakan kode perangkat yang dapat dimasukkan pengguna ke dalam https://microsoft.com/devicelogin.

Konstruktor

DeviceCodeCredential(DeviceCodeCredentialOptions)

Membuat instans DeviceCodeCredential dengan detail yang diperlukan untuk memulai alur otorisasi kode perangkat dengan Microsoft Entra ID.

Pesan akan dicatat, memberi pengguna kode yang dapat mereka gunakan untuk mengautentikasi setelah mereka masuk https://microsoft.com/devicelogin

Pengembang dapat mengonfigurasi bagaimana pesan ini ditampilkan dengan meneruskan kustom userPromptCallback:

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

Metode

authenticate(string | string[], GetTokenOptions)

Mengautentikasi dengan Microsoft Entra ID dan mengembalikan token akses jika berhasil. Jika autentikasi gagal, CredentialUnavailableError akan dilemparkan dengan detail kegagalan.

Jika token tidak dapat diambil secara diam-diam, metode ini akan memerlukan interaksi pengguna untuk mengambil token.
getToken(string | string[], GetTokenOptions)

Mengautentikasi dengan Microsoft Entra ID dan mengembalikan token akses jika berhasil. Jika autentikasi gagal, CredentialUnavailableError akan dilemparkan dengan detail kegagalan.

Jika pengguna memberikan opsi disableAutomaticAuthentication, setelah token tidak dapat diambil secara diam-diam, metode ini tidak akan mencoba meminta interaksi pengguna untuk mengambil token.

Detail Konstruktor

DeviceCodeCredential(DeviceCodeCredentialOptions)

Membuat instans DeviceCodeCredential dengan detail yang diperlukan untuk memulai alur otorisasi kode perangkat dengan Microsoft Entra ID.

Pesan akan dicatat, memberi pengguna kode yang dapat mereka gunakan untuk mengautentikasi setelah mereka masuk https://microsoft.com/devicelogin

Pengembang dapat mengonfigurasi bagaimana pesan ini ditampilkan dengan meneruskan kustom userPromptCallback:

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)

Parameter

options
DeviceCodeCredentialOptions

Opsi untuk mengonfigurasi klien yang membuat permintaan autentikasi.

Detail Metode

authenticate(string | string[], GetTokenOptions)

Mengautentikasi dengan Microsoft Entra ID dan mengembalikan token akses jika berhasil. Jika autentikasi gagal, CredentialUnavailableError akan dilemparkan dengan detail kegagalan.

Jika token tidak dapat diambil secara diam-diam, metode ini akan memerlukan interaksi pengguna untuk mengambil token.

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

Parameter

scopes

string | string[]

Daftar cakupan yang tokennya akan memiliki akses.

options
GetTokenOptions

Opsi yang digunakan untuk mengonfigurasi permintaan apa pun yang mungkin dibuat oleh implementasi TokenCredential ini.

Mengembalikan

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

Mengautentikasi dengan Microsoft Entra ID dan mengembalikan token akses jika berhasil. Jika autentikasi gagal, CredentialUnavailableError akan dilemparkan dengan detail kegagalan.

Jika pengguna memberikan opsi disableAutomaticAuthentication, setelah token tidak dapat diambil secara diam-diam, metode ini tidak akan mencoba meminta interaksi pengguna untuk mengambil token.

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

Parameter

scopes

string | string[]

Daftar cakupan yang tokennya akan memiliki akses.

options
GetTokenOptions

Opsi yang digunakan untuk mengonfigurasi permintaan apa pun yang mungkin dibuat oleh implementasi TokenCredential ini.

Mengembalikan

Promise<AccessToken>