AuthorizationCodeCredential class
Memungkinkan autentikasi untuk Microsoft Entra ID menggunakan kode otorisasi yang diperoleh melalui alur kode otorisasi, yang dijelaskan secara lebih rinci dalam dokumentasi Microsoft Entra ID:
https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow
Konstruktor
Authorization |
Membuat instans AuthorizationCodeCredential dengan detail yang diperlukan untuk meminta token akses menggunakan autentikasi yang diperoleh dari Microsoft Entra ID. Saat ini diperlukan bagi pengguna kredensial ini untuk memulai alur kode otorisasi untuk mendapatkan kode otorisasi yang akan digunakan dengan kredensial ini. Contoh lengkap alur ini disediakan di sini: |
Authorization |
Membuat instans AuthorizationCodeCredential dengan detail yang diperlukan untuk meminta token akses menggunakan autentikasi yang diperoleh dari Microsoft Entra ID. Saat ini diperlukan bagi pengguna kredensial ini untuk memulai alur kode otorisasi untuk mendapatkan kode otorisasi yang akan digunakan dengan kredensial ini. Contoh lengkap alur ini disediakan di sini: |
Metode
get |
Mengautentikasi dengan Microsoft Entra ID dan mengembalikan token akses jika berhasil. Jika autentikasi gagal, CredentialUnavailableError akan dilemparkan dengan detail kegagalan. |
Detail Konstruktor
AuthorizationCodeCredential(string, string, string, string, AuthorizationCodeCredentialOptions)
Membuat instans AuthorizationCodeCredential dengan detail yang diperlukan untuk meminta token akses menggunakan autentikasi yang diperoleh dari Microsoft Entra ID.
Saat ini diperlukan bagi pengguna kredensial ini untuk memulai alur kode otorisasi untuk mendapatkan kode otorisasi yang akan digunakan dengan kredensial ini. Contoh lengkap alur ini disediakan di sini:
new AuthorizationCodeCredential(tenantId: string, clientId: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)
Parameter
- tenantId
-
string
ID atau nama penyewa (direktori) Microsoft Entra. 'common' dapat digunakan saat berhadapan dengan skenario multi-penyewa.
- clientId
-
string
ID klien (aplikasi) Pendaftaran Aplikasi di penyewa.
- authorizationCode
-
string
Kode otorisasi yang diterima dari mengikuti alur kode otorisasi. Kode otorisasi ini tidak boleh digunakan untuk mendapatkan token akses.
- redirectUri
-
string
URI pengalihan yang digunakan untuk meminta kode otorisasi. Harus URI yang sama yang dikonfigurasi untuk Pendaftaran Aplikasi.
Opsi untuk mengonfigurasi klien yang membuat permintaan token akses.
AuthorizationCodeCredential(string, string, string, string, string, AuthorizationCodeCredentialOptions)
Membuat instans AuthorizationCodeCredential dengan detail yang diperlukan untuk meminta token akses menggunakan autentikasi yang diperoleh dari Microsoft Entra ID.
Saat ini diperlukan bagi pengguna kredensial ini untuk memulai alur kode otorisasi untuk mendapatkan kode otorisasi yang akan digunakan dengan kredensial ini. Contoh lengkap alur ini disediakan di sini:
new AuthorizationCodeCredential(tenantId: string, clientId: string, clientSecret: string, authorizationCode: string, redirectUri: string, options?: AuthorizationCodeCredentialOptions)
Parameter
- tenantId
-
string
ID atau nama penyewa (direktori) Microsoft Entra. 'common' dapat digunakan saat berhadapan dengan skenario multi-penyewa.
- clientId
-
string
ID klien (aplikasi) Pendaftaran Aplikasi di penyewa.
- clientSecret
-
string
Rahasia klien yang dihasilkan untuk Pendaftaran Aplikasi
- authorizationCode
-
string
Kode otorisasi yang diterima dari mengikuti alur kode otorisasi. Kode otorisasi ini tidak boleh digunakan untuk mendapatkan token akses.
- redirectUri
-
string
URI pengalihan yang digunakan untuk meminta kode otorisasi. Harus URI yang sama yang dikonfigurasi untuk Pendaftaran Aplikasi.
Opsi untuk mengonfigurasi klien yang membuat permintaan token akses.
Detail Metode
getToken(string | string[], GetTokenOptions)
Mengautentikasi dengan Microsoft Entra ID dan mengembalikan token akses jika berhasil. Jika autentikasi gagal, CredentialUnavailableError akan dilemparkan dengan detail kegagalan.
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>