@azure/msal-node package
Kelas
| AuthError |
Kelas kesalahan umum yang dilemparkan oleh pustaka MSAL.js. |
| ClientApplication |
Kelas abstrak dasar untuk semua ClientApplications - publik dan rahasia |
| ClientAssertion |
Pernyataan klien jenis pembawa jwt yang digunakan dalam alur klien rahasia |
| ClientAuthError |
Kesalahan muncul ketika ada kesalahan dalam kode klien yang berjalan di browser. |
| ClientConfigurationError |
Kesalahan muncul ketika ada kesalahan dalam konfigurasi pustaka MSAL.js. |
| ClientCredentialClient |
Pemberian kredensial klien OAuth2.0 |
| ConfidentialClientApplication |
Kelas ini akan digunakan untuk memperoleh token untuk aplikasi klien rahasia (webApp, webAPI). Aplikasi klien rahasia akan mengonfigurasi rahasia aplikasi, sertifikat/pernyataan klien sebagaimana berlaku |
| CryptoProvider |
Kelas ini mengimplementasikan antarmuka kripto node MSAL, yang memungkinkannya untuk melakukan pengodean dan dekode base64, menghasilkan GUID acak kriptografis dan menerapkan Kunci Bukti untuk Kode Exchange spesifikasi untuk Alur Kode Otorisasi OAuth menggunakan PKCE (rfc di sini: https://tools.ietf.org/html/rfc7636). |
| DeviceCodeClient |
Klien kode perangkat OAuth2.0 |
| DistributedCachePlugin |
Plugin cache yang menserialisasikan data ke cache dan mendeserialisasi data dari cache |
| InteractionRequiredAuthError |
Kesalahan muncul saat interaksi pengguna diperlukan. |
| Logger |
Kelas yang memfasilitasi pengelogan pesan ke tempat tertentu. |
| ManagedIdentityApplication |
Kelas untuk menginisialisasi identitas terkelola dan mengidentifikasi layanan |
| OnBehalfOfClient |
KlienBehalf-Of |
| PublicClientApplication |
Kelas ini akan digunakan untuk memperoleh token untuk aplikasi klien publik (desktop, seluler). Aplikasi klien publik tidak dipercaya untuk menyimpan rahasia aplikasi dengan aman, dan oleh karena itu hanya dapat meminta token atas nama pengguna. |
| ServerError |
Kesalahan muncul ketika ada kesalahan dengan kode server, misalnya, tidak tersedia. |
| TokenCache |
Manajer cache token dalam memori |
| TokenCacheContext |
Instans kelas ini membantu melacak perubahan memori yang memfasilitasi keputusan untuk membaca dan menulis ke cache persisten |
| UsernamePasswordClient |
Catatan klien pemberian Kata Sandi Oauth2.0: Kami hanya mendukung klien publik untuk pemberian kata sandi dan untuk tujuan pengujian murni |
Antarmuka
| IAppTokenProvider | |
| ICacheClient |
Antarmuka untuk cache yang menentukan getter dan setter |
| ICachePlugin | |
| IConfidentialClientApplication |
Antarmuka untuk kelas ConfidentialClientApplication yang menentukan tanda tangan API publik |
| ILoopbackClient |
Antarmuka untuk LoopbackClient memungkinkan untuk mengganti server loopback default dengan implementasi kustom. |
| INativeBrokerPlugin | |
| INetworkModule |
Antarmuka jaringan klien untuk mengirim permintaan backend. |
| IPartitionManager |
Antarmuka yang mendefinisikan metode getter untuk mendapatkan kunci yang digunakan untuk data identitas dalam cache |
| IPublicClientApplication |
Antarmuka untuk kelas PublicClientApplication yang menentukan tanda tangan API publik |
| ISerializableTokenCache | |
| ITokenCache |
Antarmuka cache token untuk klien, memberikan akses ke API cache |
Alias Jenis
| AccountInfo |
Objek akun dengan tanda tangan berikut:
|
| AppTokenProviderParameters |
Input objek untuk ekstensiblitas IAppTokenProvider. MSAL akan membuat objek ini, yang dapat digunakan untuk membantu membuat AppTokenProviderResult.
|
| AppTokenProviderResult |
Objek output untuk ekstensiblitas IAppTokenProvider.
|
| AuthenticationResult |
Hasil yang dikembalikan dari titik akhir token otoritas.
|
| AuthorizationCodePayload |
Respons dikembalikan setelah memproses string atau fragmen kueri respons kode. |
| AuthorizationCodeRequest |
Objek permintaan yang diteruskan oleh pengguna untuk memperoleh token dari server yang bertukar kode otorisasi yang valid (leg kedua alur Kode Otorisasi OAuth2.0)
|
| AuthorizationUrlRequest |
Meminta objek yang diteruskan oleh pengguna untuk mengambil Kode dari server (bagian pertama alur pemberian kode otorisasi)
|
| AuthorizeResponse |
Properti respons yang dapat dikembalikan oleh titik akhir /authorize |
| AzureCloudOptions |
Opsi khusus AzureCloudInstance
|
| BrokerOptions |
Gunakan ini untuk mengonfigurasi opsi broker di bawah ini:
Catatan: Opsi ini hanya tersedia untuk PublicClientApplications menggunakan Alur Kode Otorisasi |
| CacheKVStore |
Penyimpanan nilai kunci untuk cache dalam memori |
| CacheOptions |
Gunakan ini untuk mengonfigurasi opsi konfigurasi cache di bawah ini:
|
| ClientAssertionCallback | |
| ClientCredentialRequest |
CommonClientCredentialRequest
|
| Configuration |
Gunakan objek konfigurasi untuk mengonfigurasi MSAL dan menginisialisasi objek aplikasi klien
|
| DeviceCodeRequest |
Parameter untuk alur kode perangkat Oauth2.
|
| IdTokenClaims |
Ketik yang menjelaskan klaim Token Id yang diketahui oleh MSAL. |
| InMemoryCache |
Jenis terputus-terputus untuk menangani objek data dalam memori dengan jenis yang ditentukan |
| InteractiveRequest |
Meminta objek yang diteruskan oleh pengguna untuk mengonfigurasi API acquireTokenInteractive
|
| JsonCache |
Format cache yang dibaca dari blob cache yang disediakan untuk konfigurasi selama instansiasi aplikasi |
| ManagedIdentityConfiguration | |
| ManagedIdentityIdParams | |
| ManagedIdentityRequestParams |
ManagedIdentityRequest
|
| NetworkRequestOptions |
Opsi yang diizinkan oleh API permintaan jaringan. |
| NetworkResponse | |
| NodeAuthOptions |
|
| NodeSystemOptions |
Ketik untuk mengonfigurasi pencatat dan opsi klien http
|
| NodeTelemetryOptions | |
| OnBehalfOfRequest |
|
| RefreshTokenRequest |
CommonRefreshTokenRequest
|
| SerializedAccessTokenEntity |
Jenis kredensial token akses |
| SerializedAccountEntity |
Jenis akun |
| SerializedAppMetadataEntity |
Jenis AppMetadata |
| SerializedIdTokenEntity |
Jenis kredensial Idtoken |
| SerializedRefreshTokenEntity |
Refresh jenis kredensial token |
| SignOutRequest | |
| SilentFlowRequest |
Parameter SilentFlow yang diteruskan oleh pengguna untuk mengambil kredensial secara diam-diam
|
| UsernamePasswordRequest |
Parameter UsernamePassword yang diteruskan oleh pengguna untuk mengambil kredensial Catatan: Praktik Terkini Terbaik Keamanan OAuth 2.0 terbaru melarang pemberian kata sandi sepenuhnya. Alur ini ditambahkan untuk pengujian internal.
|
Enum
| LogLevel |
Tingkat pesan log. |
Variabel
| Azure |
|
| Managed |
Nama Sumber Identitas Terkelola |
| Protocol |
Mode protokol yang didukung oleh MSAL. |
| Response |
nilai yang diizinkan untuk response_mode |
| Auth |
Kelas AuthErrorMessage yang berisi konstanta string yang digunakan oleh kode kesalahan dan pesan. |
| Client |
Konstanta string yang digunakan oleh kode kesalahan dan pesan. |
| Client |
Kelas ClientConfigurationErrorMessage yang berisi konstanta string yang digunakan oleh kode kesalahan dan pesan. |
| Interaction |
Kesalahan interaksi yang diperlukan yang ditentukan oleh SDK |
| Prompt |
kami mempertimbangkan untuk membuat "enum" ini dalam permintaan alih-alih string, namun sepertinya daftar nilai prompt yang diizinkan terus berubah selama beberapa tahun terakhir. Ada beberapa nilai prompt yang tidak terdokumentasi untuk beberapa mitra internal juga, oleh karena itu pilihan jenis "string" generik alih-alih "enum" |
| version |
Detail Variabel
AzureCloudInstance
AzureCloudInstance: { AzureChina: "https://login.chinacloudapi.cn", AzureGermany: "https://login.microsoftonline.de", AzurePpe: "https://login.windows-ppe.net", AzurePublic: "https://login.microsoftonline.com", AzureUsGovernment: "https://login.microsoftonline.us", None: "none" }
Jenis
{ AzureChina: "https://login.chinacloudapi.cn", AzureGermany: "https://login.microsoftonline.de", AzurePpe: "https://login.windows-ppe.net", AzurePublic: "https://login.microsoftonline.com", AzureUsGovernment: "https://login.microsoftonline.us", None: "none" }
ManagedIdentitySourceNames
Nama Sumber Identitas Terkelola
ManagedIdentitySourceNames: { APP_SERVICE: "AppService", AZURE_ARC: "AzureArc", CLOUD_SHELL: "CloudShell", DEFAULT_TO_IMDS: "DefaultToImds", IMDS: "Imds", MACHINE_LEARNING: "MachineLearning", SERVICE_FABRIC: "ServiceFabric" }
Jenis
{ APP_SERVICE: "AppService", AZURE_ARC: "AzureArc", CLOUD_SHELL: "CloudShell", DEFAULT_TO_IMDS: "DefaultToImds", IMDS: "Imds", MACHINE_LEARNING: "MachineLearning", SERVICE_FABRIC: "ServiceFabric" }
ProtocolMode
Mode protokol yang didukung oleh MSAL.
ProtocolMode: { AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }
Jenis
{ AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }
ResponseMode
nilai yang diizinkan untuk response_mode
ResponseMode: { FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }
Jenis
{ FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }
AuthErrorMessage
Peringatan
API ini sudah tidak digunakan lagi.
Use AuthErrorCodes instead
Kelas AuthErrorMessage yang berisi konstanta string yang digunakan oleh kode kesalahan dan pesan.
AuthErrorMessage: { postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }
Jenis
{ postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }
ClientAuthErrorMessage
Peringatan
API ini sudah tidak digunakan lagi.
Use ClientAuthErrorCodes instead
Konstanta string yang digunakan oleh kode kesalahan dan pesan.
ClientAuthErrorMessage: { DeviceCodeExpired: { code: string, desc: string }, DeviceCodePollingCancelled: { code: string, desc: string }, DeviceCodeUnknownError: { code: string, desc: string }, NoAccountInSilentRequest: { code: string, desc: string }, appendScopeSetError: { code: string, desc: string }, authTimeNotFoundError: { code: string, desc: string }, bindingKeyNotRemovedError: { code: string, desc: string }, clientInfoDecodingError: { code: string, desc: string }, clientInfoEmptyError: { code: string, desc: string }, emptyInputScopeSetError: { code: string, desc: string }, endpointResolutionError: { code: string, desc: string }, hashNotDeserialized: { code: string, desc: string }, invalidAssertion: { code: string, desc: string }, invalidCacheEnvironment: { code: string, desc: string }, invalidCacheRecord: { code: string, desc: string }, invalidClientCredential: { code: string, desc: string }, invalidStateError: { code: string, desc: string }, keyIdMissing: { code: string, desc: string }, logoutNotSupported: { code: string, desc: string }, maxAgeTranspired: { code: string, desc: string }, missingTenantIdError: { code: string, desc: string }, multipleMatchingAccounts: { code: string, desc: string }, multipleMatchingAppMetadata: { code: string, desc: string }, multipleMatchingTokens: { code: string, desc: string }, nestedAppAuthBridgeDisabled: { code: string, desc: string }, networkError: { code: string, desc: string }, noAccountFound: { code: string, desc: string }, noAuthorizationCodeFromServer: { code: string, desc: string }, noCryptoObj: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, nonceMismatchError: { code: string, desc: string }, nullOrEmptyToken: { code: string, desc: string }, platformBrokerError: { code: string, desc: string }, removeEmptyScopeError: { code: string, desc: string }, stateMismatchError: { code: string, desc: string }, stateNotFoundError: { code: string, desc: string }, tokenClaimsRequired: { code: string, desc: string }, tokenParsingError: { code: string, desc: string }, tokenRefreshRequired: { code: string, desc: string }, tokenRequestCannotBeMade: { code: string, desc: string }, unableToGetOpenidConfigError: { code: string, desc: string }, unexpectedCredentialType: { code: string, desc: string }, userCanceledError: { code: string, desc: string }, userTimeoutReached: { code: string, desc: string } }
Jenis
{ DeviceCodeExpired: { code: string, desc: string }, DeviceCodePollingCancelled: { code: string, desc: string }, DeviceCodeUnknownError: { code: string, desc: string }, NoAccountInSilentRequest: { code: string, desc: string }, appendScopeSetError: { code: string, desc: string }, authTimeNotFoundError: { code: string, desc: string }, bindingKeyNotRemovedError: { code: string, desc: string }, clientInfoDecodingError: { code: string, desc: string }, clientInfoEmptyError: { code: string, desc: string }, emptyInputScopeSetError: { code: string, desc: string }, endpointResolutionError: { code: string, desc: string }, hashNotDeserialized: { code: string, desc: string }, invalidAssertion: { code: string, desc: string }, invalidCacheEnvironment: { code: string, desc: string }, invalidCacheRecord: { code: string, desc: string }, invalidClientCredential: { code: string, desc: string }, invalidStateError: { code: string, desc: string }, keyIdMissing: { code: string, desc: string }, logoutNotSupported: { code: string, desc: string }, maxAgeTranspired: { code: string, desc: string }, missingTenantIdError: { code: string, desc: string }, multipleMatchingAccounts: { code: string, desc: string }, multipleMatchingAppMetadata: { code: string, desc: string }, multipleMatchingTokens: { code: string, desc: string }, nestedAppAuthBridgeDisabled: { code: string, desc: string }, networkError: { code: string, desc: string }, noAccountFound: { code: string, desc: string }, noAuthorizationCodeFromServer: { code: string, desc: string }, noCryptoObj: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, nonceMismatchError: { code: string, desc: string }, nullOrEmptyToken: { code: string, desc: string }, platformBrokerError: { code: string, desc: string }, removeEmptyScopeError: { code: string, desc: string }, stateMismatchError: { code: string, desc: string }, stateNotFoundError: { code: string, desc: string }, tokenClaimsRequired: { code: string, desc: string }, tokenParsingError: { code: string, desc: string }, tokenRefreshRequired: { code: string, desc: string }, tokenRequestCannotBeMade: { code: string, desc: string }, unableToGetOpenidConfigError: { code: string, desc: string }, unexpectedCredentialType: { code: string, desc: string }, userCanceledError: { code: string, desc: string }, userTimeoutReached: { code: string, desc: string } }
ClientConfigurationErrorMessage
Peringatan
API ini sudah tidak digunakan lagi.
Use ClientConfigurationErrorCodes instead
Kelas ClientConfigurationErrorMessage yang berisi konstanta string yang digunakan oleh kode kesalahan dan pesan.
ClientConfigurationErrorMessage: { authorityMismatch: { code: string, desc: string }, authorityUriInsecure: { code: string, desc: string }, cannotAllowPlatformBroker: { code: string, desc: string }, cannotSetOIDCOptions: { code: string, desc: string }, claimsRequestParsingError: { code: string, desc: string }, emptyScopesError: { code: string, desc: string }, invalidAuthenticationHeader: { code: string, desc: string }, invalidAuthorityMetadata: { code: string, desc: string }, invalidAuthorizePostBodyParameters: { code: string, desc: string }, invalidClaimsRequest: { code: string, desc: string }, invalidCloudDiscoveryMetadata: { code: string, desc: string }, invalidCodeChallengeMethod: { code: string, desc: string }, invalidCodeChallengeParams: { code: string, desc: string }, invalidPlatformBrokerConfiguration: { code: string, desc: string }, invalidRequestMethodForEAR: { code: string, desc: string }, logoutRequestEmptyError: { code: string, desc: string }, missingNonceAuthenticationHeader: { code: string, desc: string }, missingSshJwk: { code: string, desc: string }, missingSshKid: { code: string, desc: string }, redirectUriNotSet: { code: string, desc: string }, tokenRequestEmptyError: { code: string, desc: string }, untrustedAuthority: { code: string, desc: string }, urlEmptyError: { code: string, desc: string }, urlParseError: { code: string, desc: string } }
Jenis
{ authorityMismatch: { code: string, desc: string }, authorityUriInsecure: { code: string, desc: string }, cannotAllowPlatformBroker: { code: string, desc: string }, cannotSetOIDCOptions: { code: string, desc: string }, claimsRequestParsingError: { code: string, desc: string }, emptyScopesError: { code: string, desc: string }, invalidAuthenticationHeader: { code: string, desc: string }, invalidAuthorityMetadata: { code: string, desc: string }, invalidAuthorizePostBodyParameters: { code: string, desc: string }, invalidClaimsRequest: { code: string, desc: string }, invalidCloudDiscoveryMetadata: { code: string, desc: string }, invalidCodeChallengeMethod: { code: string, desc: string }, invalidCodeChallengeParams: { code: string, desc: string }, invalidPlatformBrokerConfiguration: { code: string, desc: string }, invalidRequestMethodForEAR: { code: string, desc: string }, logoutRequestEmptyError: { code: string, desc: string }, missingNonceAuthenticationHeader: { code: string, desc: string }, missingSshJwk: { code: string, desc: string }, missingSshKid: { code: string, desc: string }, redirectUriNotSet: { code: string, desc: string }, tokenRequestEmptyError: { code: string, desc: string }, untrustedAuthority: { code: string, desc: string }, urlEmptyError: { code: string, desc: string }, urlParseError: { code: string, desc: string } }
InteractionRequiredAuthErrorMessage
Peringatan
API ini sudah tidak digunakan lagi.
Use InteractionRequiredAuthErrorCodes instead
Kesalahan interaksi yang diperlukan yang ditentukan oleh SDK
InteractionRequiredAuthErrorMessage: { bad_token: { code: string, desc: string }, interrupted_user: { code: string, desc: string }, native_account_unavailable: { code: string, desc: string }, noTokensFoundError: { code: string, desc: string } }
Jenis
{ bad_token: { code: string, desc: string }, interrupted_user: { code: string, desc: string }, native_account_unavailable: { code: string, desc: string }, noTokensFoundError: { code: string, desc: string } }
PromptValue
kami mempertimbangkan untuk membuat "enum" ini dalam permintaan alih-alih string, namun sepertinya daftar nilai prompt yang diizinkan terus berubah selama beberapa tahun terakhir. Ada beberapa nilai prompt yang tidak terdokumentasi untuk beberapa mitra internal juga, oleh karena itu pilihan jenis "string" generik alih-alih "enum"
PromptValue: { CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }
Jenis
{ CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }
version
version: "3.8.10"
Jenis
"3.8.10"