@azure/msal-node package
Sınıflar
| AuthError |
MSAL.js kitaplığı tarafından genel hata sınıfı oluşturuldu. |
| ClientApplication |
Tüm ClientApplications için temel soyut sınıf - genel ve gizli |
| ClientAssertion |
Gizli istemci akışlarında kullanılan jwt-bearer türünün istemci onayı |
| ClientAuthError |
Tarayıcıda çalışan istemci kodunda bir hata olduğunda hata oluştu. |
| ClientConfigurationError |
MSAL.js kitaplığının yapılandırmasında bir hata olduğunda hata oluştu. |
| ClientCredentialClient |
OAuth2.0 istemci kimlik bilgisi verme |
| ConfidentialClientApplication |
Bu sınıf, gizli istemci uygulamaları (webApp, webAPI) için belirteçleri almak için kullanılır. Gizli istemci uygulamaları uygulama gizli dizilerini, istemci sertifikalarını/onaylarını uygun şekilde yapılandıracaktır |
| CryptoProvider |
Bu sınıf MSAL düğümünü şifreleme arabirimini uygulayarak base64 kodlama ve kod çözme işlemlerini gerçekleştirmesine, şifreli rastgele GUID'ler oluşturmasına ve PKCE kullanarak OAuth Yetkilendirme Kodu Akışı için Kod Exchange Için Yazım Denetleme Anahtarı belirtimleri uygulamasına olanak tanır (rfc: https://tools.ietf.org/html/rfc7636). |
| DeviceCodeClient |
OAuth2.0 Cihaz kodu istemcisi |
| DistributedCachePlugin |
Verileri önbelleğe seri hale getiren ve verileri önbellekten seri durumdan çıkaran önbellek eklentisi |
| InteractionRequiredAuthError |
Kullanıcı etkileşimi gerektiğinde hata oluştu. |
| Logger |
İletilerin belirli bir yere kaydedilmesini kolaylaştıran sınıf. |
| ManagedIdentityApplication |
Yönetilen kimliği başlatma ve hizmeti tanımlama sınıfı |
| OnBehalfOfClient |
Behalf-Of istemci |
| PublicClientApplication |
Bu sınıf, genel istemci uygulamaları (masaüstü, mobil) için belirteçleri almak için kullanılır. Genel istemci uygulamalarının uygulama gizli dizilerini güvenli bir şekilde depolamasına güvenilmez ve bu nedenle yalnızca kullanıcı adına belirteç isteyebilir. |
| ServerError |
Sunucu koduyla ilgili bir hata olduğunda ( örneğin, kullanılamaz durumda olduğunda) hata oluştu. |
| TokenCache |
Bellek içi belirteç önbellek yöneticisi |
| TokenCacheContext |
Bu sınıf örneği, kalıcı önbellekten okuma ve yazma kararlarını kolaylaştıran bellek değişikliklerini izlemeye yardımcı olur |
| UsernamePasswordClient |
Oauth2.0 Parola verme istemcisi Not: Yalnızca parola verme ve yalnızca test amacıyla genel istemcileri destekliyoruz |
Arabirimler
| IAppTokenProvider | |
| ICacheClient |
Bir alıcı ve ayarlayıcı tanımlayan önbellek arabirimi |
| ICachePlugin | |
| IConfidentialClientApplication |
Genel API imzalarını tanımlayan ConfidentialClientApplication sınıfı arabirimi |
| ILoopbackClient |
Varsayılan geri döngü sunucusunu özel bir uygulamayla değiştirmeyi sağlayan LoopbackClient arabirimi. |
| INativeBrokerPlugin | |
| INetworkModule |
Arka uç istekleri göndermek için istemci ağ arabirimi. |
| IPartitionManager |
Önbellekteki verileri tanımlamak için kullanılan anahtarları almak için getter yöntemlerini tanımlayan arabirim |
| IPublicClientApplication |
Genel API imzalarını tanımlayan PublicClientApplication sınıfı arabirimi |
| ISerializableTokenCache | |
| ITokenCache |
İstemci için önbellek api'lerine erişim veren belirteç önbellek arabirimi |
Tür Diğer Adları
| AccountInfo |
Aşağıdaki imzaya sahip hesap nesnesi:
|
| AppTokenProviderParameters |
IAppTokenProvider genişletilebilirliği için giriş nesnesi. MSAL, AppTokenProviderResult oluşturmaya yardımcı olmak için kullanılabilecek bu nesneyi oluşturur.
|
| AppTokenProviderResult |
IAppTokenProvider genişletilebilirliği için çıkış nesnesi.
|
| AuthenticationResult |
Sonuç, yetkilinin belirteç uç noktasından döndürülür.
|
| AuthorizationCodePayload |
Kod yanıtı sorgu dizesi veya parçası işlendikten sonra yanıt döndürüldü. |
| AuthorizationCodeRequest |
Geçerli bir yetkilendirme kodu (OAuth2.0 Yetkilendirme Kodu akışının ikinci ayağı) alışverişinde bulunan sunucudan belirteç almak için kullanıcı tarafından geçirilen istek nesnesi
|
| AuthorizationUrlRequest |
Kullanıcı tarafından sunucudan kod almak için geçirilen istek nesnesi (yetkilendirme kodu verme akışının ilk ayağı)
|
| AuthorizeResponse |
/authorize uç noktası tarafından döndürülebilecek yanıt özellikleri |
| AzureCloudOptions |
AzureCloudInstance'a özgü seçenekler
|
| BrokerOptions |
Aşağıdaki aracı seçeneklerini yapılandırmak için bunu kullanın:
Not: Bu seçenekler yalnızca Yetkilendirme Kodu Akışı kullanılarak PublicClientApplications için kullanılabilir |
| CacheKVStore |
Bellek içi önbellek için anahtar değer deposu |
| CacheOptions |
Aşağıdaki önbellek yapılandırma seçeneklerini yapılandırmak için bunu kullanın:
|
| ClientAssertionCallback | |
| ClientCredentialRequest |
CommonClientCredentialRequest
|
| Configuration |
MSAL'yi yapılandırmak ve istemci uygulama nesnesini başlatmak için yapılandırma nesnesini kullanın
|
| DeviceCodeRequest |
Oauth2 cihaz kodu akışı için parametreler.
|
| IdTokenClaims |
MSAL tarafından bilinen Kimlik Belirteci taleplerini açıklayan tür. |
| InMemoryCache |
Bellek içi veri nesnelerini tanımlı türlerle işlemek için aralıklı tür |
| InteractiveRequest |
AcquireTokenInteractive API'sini yapılandırmak için kullanıcı tarafından geçirilen istek nesnesi
|
| JsonCache |
Uygulama örneği oluşturma sırasında yapılandırmaya sağlanan önbellek blobundan okunan önbellek biçimi |
| ManagedIdentityConfiguration | |
| ManagedIdentityIdParams | |
| ManagedIdentityRequestParams |
ManagedIdentityRequest
|
| NetworkRequestOptions |
Ağ isteği API'lerinin izin verdiği seçenekler. |
| NetworkResponse | |
| NodeAuthOptions |
|
| NodeSystemOptions |
Günlükçü ve http istemci seçeneklerini yapılandırma türü
|
| NodeTelemetryOptions | |
| OnBehalfOfRequest |
|
| RefreshTokenRequest |
CommonRefreshTokenRequest
|
| SerializedAccessTokenEntity |
Erişim belirteci kimlik bilgisi türü |
| SerializedAccountEntity |
Hesap türü |
| SerializedAppMetadataEntity |
AppMetadata türü |
| SerializedIdTokenEntity |
Idtoken kimlik bilgisi türü |
| SerializedRefreshTokenEntity |
Yenileme belirteci kimlik bilgisi türü |
| SignOutRequest | |
| SilentFlowRequest |
Kimlik bilgilerini sessizce almak için kullanıcı tarafından geçirilen SilentFlow parametreleri
|
| UsernamePasswordRequest |
Kullanıcı tarafından kimlik bilgilerini almak için geçirilen UsernamePassword parametreleri Not: En son OAuth 2.0 Güvenlik En İyi Güncel Uygulaması parola verme işlemini tamamen izin vermez. Bu akış, iç test için eklenir.
|
Numaralandırmalar
| LogLevel |
Günlük iletisi düzeyi. |
Değişkenler
| Azure |
|
| Managed |
Yönetilen Kimlik Kaynak Adları |
| Protocol |
MSAL tarafından desteklenen protokol modları. |
| Response |
response_mode için izin verilen değerler |
| Auth |
Hata kodları ve iletiler tarafından kullanılan dize sabitlerini içeren AuthErrorMessage sınıfı. |
| Client |
Hata kodları ve iletiler tarafından kullanılan dize sabitleri. |
| Client |
Hata kodları ve iletiler tarafından kullanılan dize sabitlerini içeren ClientConfigurationErrorMessage sınıfı. |
| Interaction |
SDK tarafından tanımlanan etkileşim gerekli hatalar |
| Prompt |
bu "numaralandırmayı" dize yerine istekte yapmayı değerlendirdik, ancak son birkaç yılda değişen istem değerlerinin izin verilen listesi gibi görünüyor. Bazı iç iş ortakları için de bazı belgelenmemiş istem değerleri vardır, bu nedenle "sabit listesi" yerine genel "dize" türü seçimi |
| version |
Değişken Ayrıntıları
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" }Tür
{ 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
Yönetilen Kimlik Kaynak Adları
ManagedIdentitySourceNames: { APP_SERVICE: "AppService", AZURE_ARC: "AzureArc", CLOUD_SHELL: "CloudShell", DEFAULT_TO_IMDS: "DefaultToImds", IMDS: "Imds", MACHINE_LEARNING: "MachineLearning", SERVICE_FABRIC: "ServiceFabric" }Tür
{ APP_SERVICE: "AppService", AZURE_ARC: "AzureArc", CLOUD_SHELL: "CloudShell", DEFAULT_TO_IMDS: "DefaultToImds", IMDS: "Imds", MACHINE_LEARNING: "MachineLearning", SERVICE_FABRIC: "ServiceFabric" }
ProtocolMode
MSAL tarafından desteklenen protokol modları.
ProtocolMode: { AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }Tür
{ AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }
ResponseMode
response_mode için izin verilen değerler
ResponseMode: { FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }Tür
{ FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }
AuthErrorMessage
Uyarı
Bu API artık kullanım dışıdır.
Use AuthErrorCodes instead
Hata kodları ve iletiler tarafından kullanılan dize sabitlerini içeren AuthErrorMessage sınıfı.
AuthErrorMessage: { postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }Tür
{ postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }
ClientAuthErrorMessage
Uyarı
Bu API artık kullanım dışıdır.
Use ClientAuthErrorCodes instead
Hata kodları ve iletiler tarafından kullanılan dize sabitleri.
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 } }Tür
{ 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
Uyarı
Bu API artık kullanım dışıdır.
Use ClientConfigurationErrorCodes instead
Hata kodları ve iletiler tarafından kullanılan dize sabitlerini içeren ClientConfigurationErrorMessage sınıfı.
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 } }Tür
{ 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
Uyarı
Bu API artık kullanım dışıdır.
Use InteractionRequiredAuthErrorCodes instead
SDK tarafından tanımlanan etkileşim gerekli hatalar
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 } }Tür
{ 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
bu "numaralandırmayı" dize yerine istekte yapmayı değerlendirdik, ancak son birkaç yılda değişen istem değerlerinin izin verilen listesi gibi görünüyor. Bazı iç iş ortakları için de bazı belgelenmemiş istem değerleri vardır, bu nedenle "sabit listesi" yerine genel "dize" türü seçimi
PromptValue: { CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }Tür
{ CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }
version
version: "3.8.10"Tür
"3.8.10"