@azure/msal-common package

Sınıflar

AuthError	MSAL.js kitaplığı tarafından genel hata sınıfı oluşturuldu.
AuthenticationHeaderParser	Bu, temel yetkilendirme akışlarının dışında kullanılabilecek üst bilgi sınaması değerlerini ayıklamak ve döndürmek için desteklenen HTTP yanıt kimlik doğrulama üst bilgilerini ayrıştıran bir yardımcı sınıfıdır.
CacheError	Önbellekte hata olduğunda hata oluştu
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.
InteractionRequiredAuthError	Kullanıcı etkileşimi gerektiğinde hata oluştu.
Logger	İletilerin belirli bir yere kaydedilmesini kolaylaştıran sınıf.
NetworkError	Ağ ile ilgili hataları temsil eder
PerformanceClient
PlatformBrokerError	Ayrıntılı aracı bilgilerini koruyan MSAL Çalışma Zamanı hataları için hata sınıfı
ProtocolUtils	OAuth 2.0 protokolüne özgü değerler için yardımcılar sağlayan sınıf
ScopeSet	ScopeSet sınıfı bir kapsam kümesi oluşturur. Kapsamlar büyük/küçük harfe duyarsız, benzersiz değerlerdir, bu nedenle JS'de Set nesnesi bu sınıf için uygulanması en mantıklıdır. Tüm kapsamlar kırpılır ve dizelerin benzersiz olmasını sağlamak için kesişim ve birleşim işlevlerindeki küçük harf dizelerine dönüştürülür.
ServerError	Sunucu koduyla ilgili bir hata olduğunda ( örneğin, kullanılamaz durumda olduğunda) hata oluştu.
StubPerformanceClient
UrlString	Url dizelerinde çeşitli dönüştürmeler gerçekleştirebilen URL nesne sınıfı.
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

Arabirimler

ICrypto	Kitaplık tarafından kullanılan şifreleme işlevleri arabirimi
ILoggerCallback
INetworkModule	Arka uç istekleri göndermek için istemci ağ arabirimi.
IPerformanceClient
IPerformanceMeasurement
IUri	URI bileşenlerini açıklayan arabirim.
PreQueueEvent
IAppTokenProvider
ICachePlugin
IGuidGenerator
INativeBrokerPlugin
ISerializableTokenCache

Tür Diğer Adları

AccessTokenEntity	Erişim belirteci önbellek türü
AccountFilter	Hesap: <home_account_id-environment-realm>><<*>
AccountInfo	Aşağıdaki imzaya sahip hesap nesnesi: homeAccountId - Bu hesap nesnesi için giriş hesabı tanımlayıcısı environment - Verenin etki alanı tarafından temsil edilen belirteci veren varlık (örneğin, login.microsoftonline.com) tenantId - Bu hesabın ait olduğu tam kiracı veya kuruluş kimliği username - Bu hesabı temsil eden id_token preferred_username talebi localAccountId - Genellikle eski durumlarda kullanılan bu hesap nesnesi için yerel, kiracıya özgü hesap identifer name - Verilen ad ve aile adı dahil olmak üzere hesabın tam adı idToken - ham kimlik belirteci idTokenClaims - Nesne kimlik belirtecinden talepler içeriyor nativeAccountId - Kullanıcının yerel hesap kimliği tenantProfiles - Hesabın tarayıcıda kimlik doğrulaması yaptığı her kiracı için kiracı profili nesnelerinin haritası dataBoundary - clientInfo'dan ayıklanan veri sınırı
ActiveAccountFilters
AppMetadataEntity	Uygulama Meta VeriSi Önbellek Türü
ApplicationTelemetry	İstek üzerine gönderilen telemetri bilgileri appName: Bir uygulamanın benzersiz dize adı appVersion: MSAL kullanan uygulamanın sürümü
AuthenticationResult	Sonuç, yetkilinin belirteç uç noktasından döndürülür. uniqueId - oid veya sub kimlik belirtecinden talep tenantId - tid kimlik belirtecinden talep scopes - İlgili belirteç için doğrulanan kapsamlar account - Şu anda oturum açmış olan kullanıcının hesap nesnesi gösterimi idToken - Yanıtın bir parçası olarak alınan kimlik belirteci idTokenClaims - MSAL ile ilgili kimlik belirteci talepleri accessToken - Yanıt kapsamında alınan erişim belirteci veya SSH sertifikası fromCache - Belirtecin önbellekten gelip gelmediğini belirten Boole değeri expiresOn - Erişim belirtecinin göreli süre sonunu temsil eden Javascript Date nesnesi extExpiresOn - Sunucu kesintisi durumunda erişim belirtecinin genişletilmiş göreli süre sonunu temsil eden Javascript Date nesnesi refreshOn - Erişim belirtecinin yenilenmesi gerekene kadar göreli zamanı temsil eden Javascript Date nesnesi state - İstekte kullanıcı tarafından geçirilen değer familyId - Aile kimliği tanımlayıcısı, genellikle yalnızca yenileme belirteçleri için kullanılır requestId - Yanıtın bir parçası olarak döndürülen istek kimliği
AuthorityOptions
AuthorizationCodePayload	Kod yanıtı sorgu dizesi veya parçası işlendikten sonra yanıt döndürüldü.
AuthorizeResponse	/authorize uç noktası tarafından döndürülebilecek yanıt özellikleri
AzureCloudOptions	AzureCloudInstance'a özgü seçenekler azureCloudInstance - soverign ve genel bulut yetkilileri için kısa notasyon sağlayan dize sabit listesi kiracı - kiracı bilgilerini sağlamak için sağlama
AzureRegion
AzureRegionConfiguration
BaseAuthRequest	BaseAuthRequest authority - Yetkilinin URL'si, MSAL'nin belirteçleri edineceği güvenlik belirteci hizmeti (STS). Varsayılan değer https://login.microsoftonline.com/common’dır. Tüm istekler için aynı yetkiliyi kullanıyorsanız, yetkili uç noktalarının birden çok kez çözümlenmemesi için yetkilinin istekte değil istemci uygulama nesnesinde ayarlanması gerekir. correlationId - Telemetri amacıyla bir isteği uçtan uca izlemek için istek başına benzersiz GUID kümesi. scopes - Uygulamanın erişim istediği kapsam dizisi. authenticationScheme - Alınan belirtecin türü. Varsayılan olarak "Taşıyıcı" olur. "pop" veya "SSH" de yazılabilir. claims - Tüm /authorize ve /token çağrılarına eklenecek bir dizeli talep isteği shrClaims - İmzalı HTTP İsteğine eklenecek dizeli talep nesnesi shrNonce - İmzalı HTTP İsteğine eklenecek, şifrelenmiş ve base64URL kodlanmış sunucu tarafından oluşturulan bir zaman damgası. shrOptions - İmzalı HTTP İsteği seçeneklerini içeren nesne resourceRequestMethod - Kaynaktan veri istemek için kullanılan HTTP İstek türü (örneğin, "GET", "POST", vb.). Sahiplik kanıtı akışları için kullanılır. resourceRequestUri - Belirtecin kullanılacağı URI. Sahiplik kanıtı akışları için kullanılır. sshJwk - SSH sertifikası tarafından imzalanabilir bir ortak anahtarı temsil eden dizeli JSON Web Anahtarı. sshKid - Yukarıda belirtilen SSH ortak anahtarını benzersiz olarak tanımlayan anahtar kimliği. azureCloudOptions - Kullanıcıların genel/bağımsız bulut kimlikleri sağlaması için kolaylık dizesi sabit listeleri requestedClaimsHash - İstenen talep dizesinin SHA 256 karma dizesi, belirteçlerin istenen taleplere göre filtrelenebilmesi için erişim belirteci önbellek anahtarının parçası olarak kullanılır tokenQueryParameters - /token çağrısına eklenen özel sorgu parametrelerinin dize eşlemesine dize tokenBodyParameters - /token çağrısının gövdesine eklenen özel parametrelerin dize eşlemesine dize storeInCache - Belirteçlerin önbellekte depolanıp depolanmayacağını belirten boole değerleri içeren nesne (varsayılan değer doğrudur) scenarioId - Özel kullanıcı istemlerini izlemek için senaryo kimliği popKid - PoP belirteci isteğinin ortak anahtarını tanımlamak için anahtar kimliği embeddedClientId - Katıştırılmış istemci kimliği. Belirtildiğinde, aracı istemci kimliği (brk_client_id) ve yeniden yönlendirme uri'si (brk_redirect_uri) parametreleri yapılandırmadaki değerlerle ayarlanır ve varsa ilgili ek parametreler geçersiz kılınabilir. httpMethod - /authorize isteği için kullanılacak HTTP yöntemi. Varsayılan olarak GET olur, ancak istek gövde parametreleri gerektiriyorsa POST olarak ayarlanabilir authorizePostBodyParameters - httpMethod POST olarak ayarlandığında /authorize çağrısının gövdesine eklenen özel parametrelerin dize eşlemesine dize skipBrokerClaims - True ve aracılı bir akış kullanıldığında (örneğin, aracı parametreleri veya embeddedClientId mevcut olduğunda), yapılandırmadan clientCapabilities taleplerden dışlanır; aracısız akışlar için yoksayılır.
CacheOptions	ClientConfiguration nesnesinde kimlik bilgisi önbellek tercihlerini yapılandırmak için bunu kullanın claimsBasedCachingEnabled - Belirteçlerin talep karması temelinde önbelleğe alınıp alınmayacağını ayarlar. Varsayılan değer false'tur.
CcsCredential
ClientInfo	şunlardan oluşan istemci bilgileri nesnesi: uid: kullanıcı kimliği utid: kiracı kimliği xms_tdbr: isteğe bağlı, yalnızca ABD dışı kiracılar için
CommonAuthorizationCodeRequest	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 scopes - Uygulamanın erişim istediği kapsam dizisi. claims - Tüm /authorize ve /token çağrılarına eklenecek bir dizeli talep isteği authority: - Yetkilinin URL'si, MSAL'nin belirteçleri edineceği güvenlik belirteci hizmeti (STS). İstemci uygulama nesnesinde yetkili ayarlanırsa bu, bu değeri geçersiz kılar. Değerin geçersiz kılınmış olması, her seferinde yetki doğrulamasının gerçekleşmesine neden olur. Tüm istekler için aynı yetkili kullanılacaksa, istekler yerine uygulama nesnesinde ayarlayın. correlationId - Telemetri amacıyla bir isteği uçtan uca izlemek için istek başına benzersiz GUID kümesi. redirectUri - Kullanıcı kimlik bilgilerini ve onayları girdikten sonra yetkilinin yeniden yönlendirileceği uygulamanızın yeniden yönlendirme URI'si. Portalda kaydettiğiniz yeniden yönlendirme URI'lerinden biriyle tam olarak eşleşmelidir code - Kullanıcının akışın ilk ayağında edindiği authorization_code. codeVerifier - authorization_code elde etmek için kullanılan code_verifier. Yetkilendirme kodu verme isteğinde PKCE kullanıldıysa gereklidir. Daha fazla bilgi için bkz. PKCE RFC: https://tools.ietf.org/html/rfc7636 resourceRequestMethod - Kaynaktan veri istemek için kullanılan HTTP İstek türü (örneğin, "GET", "POST", vb.). Sahiplik kanıtı akışları için kullanılır. resourceRequestUri - Belirtecin kullanılacağı URI. Sahiplik kanıtı akışları için kullanılır. enableSpaAuthCode - Spa yetkilendirme kodunun (yalnızca gizli istemciler) kapsamını etkinleştirir tokenQueryParameters - /token çağrısına eklenen özel sorgu parametrelerinin dize eşlemesine dize
CommonAuthorizationUrlRequest	Kullanıcı tarafından sunucudan kod almak için geçirilen istek nesnesi (yetkilendirme kodu verme akışının ilk ayağı) scopes - Uygulamanın erişim istediği kapsam dizisi. claims - Tüm /authorize ve /token çağrılarına eklenecek bir dizeli talep isteği authority - Uygulamanın belirteçleri aldığı yetkilinin URL'si. correlationId - Telemetri amacıyla bir isteği uçtan uca izlemek için istek başına benzersiz GUID kümesi. redirectUri - Kimlik doğrulaması yanıtlarının uygulamanız tarafından alınabildiği yeniden yönlendirme URI'si. Azure portalında kayıtlı yeniden yönlendirme URI'lerinden biriyle tam olarak eşleşmelidir. extraScopesToConsent - Kullanıcının önceden onay alması gerektiğinde farklı bir kaynağın kapsamları. responseMode - Kimlik doğrulama sonucunu uygulamanıza göndermek için kullanılacak yöntemi belirtir. Sorgu, form_post veya parça olabilir. Hiçbir değer geçirilmezse, varsayılan olarak sorgulanır. codeChallenge - Kod Exchange (PKCE) için Anahtar Kanıtı aracılığıyla yetkilendirme kodu verme işleminin güvenliğini sağlamak için kullanılır. Daha fazla bilgi için bkz. PKCE RCF:https://tools.ietf.org/html/rfc7636 codeChallengeMethod - Kod sınama parametresi için kod doğrulayıcıyı kodlamak için kullanılan yöntem. "Düz" veya "S256" olabilir. Dışlanırsa, kod sınaması düz metin olarak kabul edilir. Daha fazla bilgi için bkz. PKCE RCF: https://tools.ietf.org/html/rfc7636 state - İstekte bulunan ve belirteç yanıtında da döndürülen bir değer. Rastgele oluşturulan benzersiz bir değer genellikle siteler arası istek sahteciliği saldırılarını önlemek için kullanılır. Durum, kimlik doğrulama isteği gerçekleşmeden önce kullanıcının uygulamadaki durumu hakkındaki bilgileri kodlamak için de kullanılır. prompt - Gerekli kullanıcı etkileşiminin türünü gösterir. oturum açma: kullanıcıyı bu istekte kimlik bilgilerini girmeye zorlar, çoklu oturum açma yok olarak niteler: kullanıcının etkileşimli bir istemle sunulmamasını sağlar. İstek çoklu oturum açma yoluyla tamamlanamazsa, uç nokta bir interaction_required hata onayı döndürür: Kullanıcı oturum açtığında OAuth onayı iletişim kutusunu tetikler ve kullanıcıdan uygulamaya select_account izinler vermesini ister: oturumdaki tüm hesapları listelemek için hesap seçimi deneyimi sağlamak için çoklu oturum açmayı kesintiye uğratır veya anımsanan hesaplar ya da farklı bir hesap oluşturma özelliğini kullanmayı seçme seçeneği: oturum açma deneyimi yerine kullanıcıyı hesap oluşturma deneyimine yönlendirir no_session: kullanıcının kimliği doğrulanırken mevcut oturum belirtecini okumaz. Kullanıcının kimliği başarıyla doğrulandıktan sonra, EVO kullanıcı için yeni bir oturum oluşturmaz. YALNıZCA DAHILI KULLANıM IÇIN. account - GetAccount API'sinden alınan AccountInfo. Hem loginHint hem de sid parametreleri sağlanmazsa login_hint oluşturmak için belirli senaryolarda kullanılır. loginHint - Kullanıcı adını/e-posta adresini önceden biliyorsanız, kullanıcının oturum açma sayfasının kullanıcı adı/e-posta adresi alanını önceden doldurmak için kullanılabilir. Uygulamalar genellikle yeniden kimlik doğrulaması sırasında bu parametreyi kullanır ve preferred_username talebi kullanılarak kullanıcı adını önceki bir oturum açmadan ayıklar. sid - Oturum kimliği, oturum için benzersiz tanımlayıcı. Kimlik belirteçlerinde isteğe bağlı talep olarak kullanılabilir. domainHint - Kullanıcının oturum açmak için kullanması gereken kiracı veya etki alanı hakkında bir ipucu sağlar. Etki alanı ipucunun değeri, kiracı için kayıtlı bir etki alanıdır. extraQueryParameters - /authorize çağrısına eklenen özel sorgu parametrelerinin dize eşlemesine dize tokenQueryParameters - /token çağrısına eklenen özel sorgu parametrelerinin dize eşlemesine dize nonce - İstekte bulunan ve kimlik belirtecinde döndürülen değer. Rastgele oluşturulan benzersiz bir değer genellikle yeniden yürütme saldırılarını azaltmak için kullanılır. resourceRequestMethod - Kaynaktan veri istemek için kullanılan HTTP İstek türü (örneğin, "GET", "POST", vb.). Sahiplik kanıtı akışları için kullanılır. resourceRequestUri - Belirtecin kullanılacağı URI. Sahiplik kanıtı akışları için kullanılır.
CommonEndSessionRequest	CommonEndSessionRequest account - Oturumu kapatılacak hesap nesnesi. Bu hesaba bağlı tüm belirteçler temizlenir. postLogoutRedirectUri - Oturumu kapatıldıktan sonra sayfasına gitmek için URI. correlationId - Telemetri amacıyla bir isteği uçtan uca izlemek için istek başına benzersiz GUID kümesi. idTokenHint - B2C tarafından ilke tarafından gerekirse oturumun kapatılıp doğrulanmadığını doğrulamak için kullanılan Kimlik Belirteci state - Oturumu kapatma uç noktasına yapılan istekte yer alan ve oturum kapatma sonrası yeniden yönlendirmesi sonrasında sorgu dizesinde döndürülecek bir değer logoutHint - Oturum kapatmada sunucu hesabı seçicisini atlamak için oturumu kapatılan hesabı belirten dize extraQueryParameters - /authorize çağrısına eklenen özel sorgu parametrelerinin dize eşlemesine dize
CommonRefreshTokenRequest	CommonRefreshTokenRequest scopes - Uygulamanın erişim istediği kapsam dizisi. claims - Tüm /authorize ve /token çağrılarına eklenecek bir dizeli talep isteği authority - Yetkilinin URL'si, MSAL'nin belirteçleri edineceği güvenlik belirteci hizmeti (STS). correlationId - Telemetri amacıyla bir isteği uçtan uca izlemek için istek başına benzersiz GUID kümesi. refreshToken - Kimlik sağlayıcısına yapılan önceki bir istekten döndürülen yenileme belirteci. resourceRequestMethod - Kaynaktan veri istemek için kullanılan HTTP İstek türü (örneğin, "GET", "POST", vb.). Sahiplik kanıtı akışları için kullanılır. resourceRequestUri - Belirtecin kullanılacağı URI. Sahiplik kanıtı akışları için kullanılır. forceCache - Önbellekte hesap olmadığında MSAL'yi yenileme belirteci akışı yanıtını önbelleğe almak için zorlar. Geçiş senaryoları için kullanılır. tokenQueryParameters - /token çağrısına eklenen özel sorgu parametrelerinin dize eşlemesine dize
CommonSilentFlowRequest	Kimlik bilgilerini sessizce almak için kullanıcı tarafından geçirilen SilentFlow parametreleri scopes - Uygulamanın erişim istediği kapsam dizisi. claims - Tüm /authorize ve /token çağrılarına eklenecek dizeli talep isteği. Sessiz bir isteğe dahil edildiğinde önbellek araması atlanır ve belirteç yenilenir. authority - Uygulamanın belirteçleri aldığı yetkilinin URL'si. correlationId - Telemetri amacıyla bir isteği uçtan uca izlemek için istek başına benzersiz GUID kümesi. account - Kimlik bilgilerini bulmak için hesap varlığı. forceRefresh - Doğruysa sessiz istekleri ağ çağrıları yapmaya zorlar. resourceRequestMethod - Kaynaktan veri istemek için kullanılan HTTP İstek türü (örneğin, "GET", "POST", vb.). Sahiplik kanıtı akışları için kullanılır. resourceRequestUri - Belirtecin kullanılacağı URI. Sahiplik kanıtı akışları için kullanılır. tokenQueryParameters - /token çağrısına eklenen özel sorgu parametrelerinin dize eşlemesine dize
CredentialEntity	Kimlik Bilgisi Önbellek Türü
CredentialFilter	Kimlik bilgisi: <home_account_id*>-<environment-credential_type-client_id-realm>><><<*>-<target*>-<scheme*>
ExternalTokenResponse	Dış belirteçleri önbelleğe yüklemek için kullanılan yanıt nesnesi. token_type: Belirteç türü değerini gösterir. AZURE AD'nin desteklediği tek tür Taşıyıcı'dır. kapsam: access_token geçerli olduğu kapsamlar. expires_in: Erişim belirtecinin geçerli olduğu süre (saniye). id_token: JSON Web Belirteci (JWT). Uygulama, oturum açan kullanıcı hakkında bilgi istemek için bu belirtecin segmentlerinin kodunu çözebilir. refresh_token: OAuth 2.0 yenileme belirteci. Uygulama, geçerli erişim belirtecinin süresi dolduktan sonra bu belirteci kullanarak ek erişim belirteçleri alabilir. access_token: İstenen erişim belirteci. Uygulama, web API'si gibi güvenli kaynakta kimlik doğrulaması yapmak için bu belirteci kullanabilir. client_info: İstemci bilgileri nesnesi
IdTokenEntity	Kimlik Belirteci Önbellek Türü
InProgressPerformanceEvent
LibraryStateObject	Dizeleştirilmiş, kodlanmış ve durum değerinde gönderilen nesneyi tanımlayan tür. Aşağıdakileri içerir: id - bu isteğin benzersiz tanımlayıcısı ts - isteğin yapıldığı zamana ait zaman damgası. Belirteç süre sonunun yanlış hesaplanmadığından emin olmak için kullanılır. platformState - platformdan gönderilen dize değeri.
LoggerOptions	Yapılandırma nesnesinde günlükçü seçeneklerini yapılandırarak MSAL'nin yaptığı günlüğü yapılandırmak için bunu kullanın loggerCallback - Günlükçü için geri çağırma piiLoggingEnabled - Pii günlüğünün etkinleştirilip etkinleştirilmediğini ayarlar logLevel - Günlüğe kaydetmenin gerçekleştiği düzeyi ayarlar correlationId - Günlükçü tarafından yazdırılan correlationId değerini ayarlar
NetworkRequestOptions	Ağ isteği API'lerinin izin verdiği seçenekler.
NetworkResponse
OIDCOptions	OIDC protokol modu seçenekleri.
PerformanceCallbackFunction
PerformanceEvent	İstek ve uygulama hakkındaki meta veriler de dahil olmak üzere kitaplık tarafından alınan performans ölçümü.
PkceCodes	PkceCodes türü, PKCE kod sınaması ve doğrulayıcı çiftleri içeren nesnelerin yapısını açıklar
QueueMeasurement	Kuyruk ölçüm türü
RefreshTokenEntity	Belirteç Önbellek Türünü Yenile
RequestStateObject	Yetkilendirme isteğinde hizmete gönderilen dizeli ve kodlanmış nesneyi tanımlayan tür.
RequestThumbprint	Benzersiz bir istek parmak izini temsil eden tür.
ServerAuthorizationTokenResponse	Sunucu yetkilendirme kodu isteğinden seri durumdan çıkarılmış yanıt nesnesi. token_type: Belirteç türü değerini gösterir. Taşıyıcı veya pop olabilir. kapsam: access_token geçerli olduğu kapsamlar. expires_in: Erişim belirtecinin geçerli olduğu süre (saniye). refresh_in: Süre sonu ne olursa olsun bir belirtecin yenilenmesi gereken süreyi hesaplar. ext_expires_in: Sunucu yanıt vermiyorsa erişim belirtecinin geçerli olduğu süre (saniye). access_token: İstenen erişim belirteci. Uygulama, web API'si gibi güvenli kaynakta kimlik doğrulaması yapmak için bu belirteci kullanabilir. refresh_token: OAuth 2.0 yenileme belirteci. Uygulama, geçerli erişim belirtecinin süresi dolduktan sonra bu belirteci kullanarak ek erişim belirteçleri alabilir. id_token: JSON Web Belirteci (JWT). Uygulama, oturum açan kullanıcı hakkında bilgi istemek için bu belirtecin segmentlerinin kodunu çözebilir. key_id: İsteğin bağlı olduğu ortak anahtarı benzersiz olarak tanımlayan bir dize. Hata durumunda: error: Oluşan hata türlerini sınıflandırmak için kullanılabilecek ve hatalara tepki vermek için kullanılabilen bir hata kodu dizesi. error_description: Bir geliştiricinin kimlik doğrulama hatasının kök nedenini tanımlamasına yardımcı olabilecek belirli bir hata iletisi. error_codes: Tanılamada yardımcı olabilecek STS'ye özgü hata kodlarının listesi. zaman damgası: Hatanın oluştuğu saat. trace_id: tanılamada yardımcı olabilecek istek için benzersiz bir tanımlayıcı. correlation_id: bileşenler arasında tanılamada yardımcı olabilecek istek için benzersiz bir tanımlayıcı. durum: ağ isteğinin yanıt durumu
ServerTelemetryEntity
ServerTelemetryRequest
ShrOptions
SignedHttpRequest
SignedHttpRequestParameters
StaticAuthorityOptions
StoreInCache	Belirteçlerin önbellekte depolanıp depolanmayacağını denetler. false olarak ayarlanırsa belirteçler yine alınabilir ve döndürülebilir ancak daha sonra almak üzere önbelleğe alınmaz.
StringDict	queryParams, extraQueryParams ve talepleri desteklemek için tür Key-Value
SubMeasurement
SystemOptions	Yapılandırma nesnesinde belirteç yenileme bilgilerini yapılandırmak için bunu kullanın tokenRenewalOffsetSeconds - Süre dolmadan önce belirteci yenilemek için gereken uzaklık penceresini ayarlar
TenantProfile	Aynı kullanıcı için kiracılar arasında değişen hesap ayrıntıları
ThrottlingEntity
TokenClaims	MSAL tarafından bilinen Kimlik Belirteci taleplerini açıklayan tür.
TokenKeys
AppTokenProviderParameters	IAppTokenProvider genişletilebilirliği için giriş nesnesi. MSAL, AppTokenProviderResult oluşturmaya yardımcı olmak için kullanılabilecek bu nesneyi oluşturur. correlationId - istekle ilişkili bağıntı kimliği tenantId - Belirtecin sağlanması gereken kiracı kimliği scopes - Belirtecin sağlanması gereken kapsamlar claims - belirtecin karşılaması gereken ek talepler
AppTokenProviderResult	IAppTokenProvider genişletilebilirliği için çıkış nesnesi. accessToken - AppTokenProviderParameters istek verilerini karşılayan, genellikle JWT biçiminde gerçek erişim belirteci expiresInSeconds - belirteçlerin süresi dolmadan önce geçmesi gereken süre (saniye olarak). AAD belirteci yanıtındaki "expires_in" alanına benzer. refreshInSeconds - belirtecin proaktif olarak yenilenmeden önce ne kadar süresi olduğunu. AAD belirteci yanıtındaki "refresh_in" alanına benzer.
ClientAssertion	Gizli İstemciler için İstemci Onaylama kimlik bilgileri
ClientAssertionCallback
ClientAssertionConfig
CommonClientCredentialRequest	CommonClientCredentialRequest scopes - Uygulamanın erişim istediği kapsam dizisi. authority - Yetkilinin URL'si, MSAL'nin belirteçleri edineceği güvenlik belirteci hizmeti (STS). correlationId - Telemetri amacıyla bir isteği uçtan uca izlemek için istek başına benzersiz GUID kümesi. skipCache - Belirteç önbelleği aramasını atlayın ve isteği yeni bir belirteç almak için yetkiliye zorlayın. Varsayılan değer false'tur. preferredAzureRegionOptions - Kullanıcının tercih ettiği azure bölgesinin seçenekleri tokenQueryParameters - /token çağrısına eklenen özel sorgu parametrelerinin dize eşlemesine dize
CommonDeviceCodeRequest	Oauth2 cihaz kodu akışı için parametreler. scopes - Uygulamanın erişim istediği kapsam dizisi. authority: - Yetkilinin URL'si, MSAL'nin belirteçleri edineceği güvenlik belirteci hizmeti (STS). İstemci uygulama nesnesinde yetkili ayarlanırsa bu, bu değeri geçersiz kılar. Değerin geçersiz kılınmış olması, her seferinde yetki doğrulamasının gerçekleşmesine neden olur. Tüm istekler için aynı yetkili kullanılacaksa, istekler yerine uygulama nesnesinde ayarlayın. correlationId - Telemetri amacıyla bir isteği uçtan uca izlemek için istek başına benzersiz GUID kümesi. deviceCodeCallback - Cihaz kodu yanıtı içeren geri arama. İleti son kullanıcıya gösterilmelidir. Son kullanıcı daha sonra verification_uri gidebilir, user_code giriş yapabilir ve kimlik bilgilerini giriş yapabilir. cancel - Cihaz kodu uç noktasının yoklamasını iptal etmek için Boole değeri. Kullanıcı ayrı bir cihazda kimlik doğrulaması yaparken, MSAL cihaz kodu yanıtında belirtilen aralık için güvenlik belirteci hizmetinin belirteç uç noktasını yoklar (genellikle 15 dakika). Yoklamayı durdurmak ve isteği iptal etmek için cancel=true değerini ayarlayın. resourceRequestMethod - Kaynaktan veri istemek için kullanılan HTTP İstek türü (örneğin, "GET", "POST", vb.). Sahiplik kanıtı akışları için kullanılır. resourceRequestUri - Belirtecin kullanılacağı URI. Sahiplik kanıtı akışları için kullanılır. zaman aşımı - Kullanıcının cihaz kodu uç noktasını yoklaması için açıkça yapılandırdığı saniye cinsinden zaman aşımı süresi. Bu sürenin sonunda; cihaz kodunun süresinin henüz dolmadığını varsayarsak; cihaz kodu yoklaması durdurulur ve istek iptal edilir. Cihaz kodu süre sonu penceresi her zaman bu ayarlanan süreye göre önceliklidir. extraQueryParameters - Sorgu dizesine eklenen özel sorgu parametrelerinin dize eşlemesine dize
CommonOnBehalfOfRequest	scopes - Uygulamanın erişim istediği kapsam dizisi. authority - Yetkilinin URL'si, MSAL'nin belirteçleri edineceği güvenlik belirteci hizmeti (STS). correlationId - Telemetri amacıyla bir isteği uçtan uca izlemek için istek başına benzersiz GUID kümesi. oboAssertion - Orta katman API'sine gönderilen erişim belirteci. Bu belirtecin, bu OBO isteğini yapan bir uygulama hedef kitlesine sahip olması gerekir. skipCache - Belirteç önbelleği aramasını atlayın ve isteği yeni bir belirteç almak için yetkiliye zorlayın. Varsayılan değer false'tur. tokenQueryParameters - /token çağrısına eklenen özel sorgu parametrelerinin dize eşlemesine dize
CommonUsernamePasswordRequest	Kimlik bilgilerini almak için kullanıcı tarafından geçirilen CommonUsernamePassword 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. scopes - Uygulamanın erişim istediği kapsam dizisi. claims - Tüm /authorize ve /token çağrılarına eklenecek dizeli talep isteği. Sessiz bir isteğe dahil edildiğinde önbellek araması atlanır ve belirteç yenilenir. authority - Uygulamanın belirteçleri aldığı yetkilinin URL'si. correlationId - Telemetri amacıyla bir isteği uçtan uca izlemek için istek başına benzersiz GUID kümesi. username - istemcinin kullanıcı adı parola - kimlik bilgileri tokenQueryParameters - /token çağrısına eklenen özel sorgu parametrelerinin dize eşlemesine dize
DeviceCodeResponse	Cihaz kodu akışı için gerekli bilgileri içeren güvenlik belirteci hizmeti cihaz kodu uç noktası tarafından döndürülen DeviceCode. userCode: Doğrulama URI'sinde kimlik doğrulaması yaparken kullanıcının sağlaması gereken kod deviceCode: Erişim belirteci isteğine dahil edilmesi gereken kod verificationUri: Kullanıcının kimlik doğrulaması yaptığı URI expiresIn: Cihaz kodunun saniyeler içinde sona erme süresi interval: STS'nin yoklanması gereken aralık ileti: kullanıcıya görüntülenmesi gereken ileti
NativeRequest
NativeSignOutRequest
ServerDeviceCodeResponse

Numaralandırmalar

LogLevel	Günlük iletisi düzeyi.
PerformanceEventStatus	Performans olayının durumu.
PerformanceEvents	tarafından izlenen işlemlerin numaralandırması, performanslarının PerformanceClient tarafından ölçülmüş olmasıdır.

İşlevler

buildAccountToCache(CacheManager, Authority, string, (input: string) => string, string, TokenClaims, string, string, null | string, AuthorizationCodePayload, string, Logger)
buildClientInfo(string, (input: string) => string)	server clientInfo dizesinden bir istemci bilgi nesnesi derleme işlevi
buildClientInfoFromHomeAccountId(string)	Önbelleğe alınmış homeAccountId dizesinden istemci bilgi nesnesi derleme işlevi
buildStaticAuthorityOptions(Partial<AuthorityOptions>)
buildTenantProfile(string, string, string, TokenClaims)	Kiracı profili oluşturma
createAuthError(string, string)
createCacheError(unknown)	CacheError nesnesindeki tarayıcı hatalarını sarmalama yardımcı işlevi
createClientAuthError(string, string)
createClientConfigurationError(string)
createInteractionRequiredAuthError(string)	InteractionRequiredAuthError oluşturur
createNetworkError(AuthError, number, Record<string, string>, Error)	Başarısız bir ağ isteği için NetworkError nesnesi oluşturur
formatAuthorityUri(string)
getRequestThumbprint(string, BaseAuthRequest, string)
getTenantIdFromIdTokenClaims(TokenClaims)	Kullanılabilir kimlik belirteci taleplerinden aşağıdaki önceliğe sahip kimlik bilgisi bölgesi olarak ayarlanan tenantId değerini alır: tid - belirteç bir Azure AD kiracısından alındıysa tid mevcut olur tfp - belirteç modern bir B2C kiracısından alındıysa tfp mevcut olmalıdır acr - belirteç eski bir B2C kiracısından alınırsa acr, bölge büyük/küçük harfe duyarlı olmayan karşılaştırma gereksinimlerine uyacak şekilde Küçük Harfle Ayrılmış olarak mevcut olmalıdır
tenantIdMatchesHomeTenant(string, string)	tenantId değeri homeAccountId değerinin utid bölümüyle eşleşiyorsa true döndürür
updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)	Geçirilen kimlik belirteci taleplerinden alınan kiracı profiline göre değişen hesap bilgilerini kiracıya özgü hesap bilgileriyle değiştirir

Değişkenler

AADAuthorityConstants	AAD Yetkilisi ile ilgili dize sabitleri
AuthenticationScheme	Kimlik doğrulama isteğinin türü
AuthorityType	MSAL tarafından desteklenen yetkili türleri.
AzureCloudInstance
CacheAccountType	Önbellekteki hesap türleri
CacheOutcome	Kimlik sağlayıcısından erişim belirtecinin getirilmenin nedenini belirtir
CacheType	Tüm önbellek türlerini birleştirme
CcsCredentialType
ClaimsRequestKeys	Talep isteği anahtarları
CredentialType	Önbellekte depolanan Kimlik Bilgisi Türü
EncodingTypes
GrantType	izin verilen grant_type
HeaderNames	İstek üst bilgisi adları
HttpMethod
HttpStatus
JsonWebTokenTypes
OAuthResponseType	response_type için izin verilen değerler
PasswordGrantConstants	Parola verme parametreleri
PersistentCacheKeys	Kullanıcı oturum açtığında kalan kalıcı önbellek anahtarları MSAL.
ProtocolMode	MSAL tarafından desteklenen protokol modları.
ResponseMode	response_mode için izin verilen değerler
ServerResponseType	sunucu yanıt türü için izin verilen değerler
AuthErrorMessage	Hata kodları ve iletiler tarafından kullanılan dize sabitlerini içeren AuthErrorMessage sınıfı.
ClientAuthErrorMessage	Hata kodları ve iletiler tarafından kullanılan dize sabitleri.
ClientConfigurationErrorMessage	Hata kodları ve iletiler tarafından kullanılan dize sabitlerini içeren ClientConfigurationErrorMessage sınıfı.
CodeChallengeMethodValues	codeVerifier için izin verilen değerler
Constants
DEFAULT_CRYPTO_IMPLEMENTATION
DEFAULT_SYSTEM_OPTIONS
DEFAULT_TOKEN_RENEWAL_OFFSET_SEC
Errors
IntFields
InteractionRequiredAuthErrorMessage	SDK tarafından tanımlanan etkileşim gerekli hatalar
OIDC_DEFAULT_SCOPES
ONE_DAY_IN_MS
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
StubbedNetworkModule
THE_FAMILY_ID
ThrottlingConstants	Azaltmayla ilgili sabitler
version

İşlev Ayrıntıları

buildAccountToCache(CacheManager, Authority, string, (input: string) => string, string, TokenClaims, string, string, null | string, AuthorizationCodePayload, string, Logger)

function buildAccountToCache(cacheStorage: CacheManager, authority: Authority, homeAccountId: string, base64Decode: (input: string) => string, correlationId: string, idTokenClaims?: TokenClaims, clientInfo?: string, environment?: string, claimsTenantId?: null | string, authCodePayload?: AuthorizationCodePayload, nativeAccountId?: string, logger?: Logger): AccountEntity

Parametreler

cacheStorage

CacheManager

authority

Authority

homeAccountId

string

base64Decode

(input: string) => string

correlationId

string

idTokenClaims

TokenClaims

clientInfo

string

environment

string

claimsTenantId

null | string

authCodePayload

AuthorizationCodePayload

nativeAccountId

string

logger

Logger

Döndürülenler

AccountEntity

buildClientInfo(string, (input: string) => string)

server clientInfo dizesinden bir istemci bilgi nesnesi derleme işlevi

function buildClientInfo(rawClientInfo: string, base64Decode: (input: string) => string): ClientInfo

Parametreler

rawClientInfo

string

base64Decode

(input: string) => string

Döndürülenler

ClientInfo

buildClientInfoFromHomeAccountId(string)

Önbelleğe alınmış homeAccountId dizesinden istemci bilgi nesnesi derleme işlevi

function buildClientInfoFromHomeAccountId(homeAccountId: string): ClientInfo

Parametreler

homeAccountId

string

Döndürülenler

ClientInfo

buildStaticAuthorityOptions(Partial<AuthorityOptions>)

function buildStaticAuthorityOptions(authOptions: Partial<AuthorityOptions>): StaticAuthorityOptions

Parametreler

authOptions

Partial<AuthorityOptions>

Döndürülenler

StaticAuthorityOptions

buildTenantProfile(string, string, string, TokenClaims)

Kiracı profili oluşturma

function buildTenantProfile(homeAccountId: string, localAccountId: string, tenantId: string, idTokenClaims?: TokenClaims): TenantProfile

Parametreler

homeAccountId

string

Bu hesap nesnesi için giriş hesabı tanımlayıcısı

localAccountId

string

Bu hesap nesnesi için yerel hesap identifer

tenantId

string

Bu hesabın ait olduğu tam kiracı veya kuruluş kimliği

idTokenClaims

TokenClaims

Kimlik belirtecinden talepler

Döndürülenler

TenantProfile

createAuthError(string, string)

function createAuthError(code: string, additionalMessage?: string): AuthError

Parametreler

code

string

additionalMessage

string

Döndürülenler

AuthError

createCacheError(unknown)

CacheError nesnesindeki tarayıcı hatalarını sarmalama yardımcı işlevi

function createCacheError(e: unknown): CacheError

Parametreler

e

unknown

Döndürülenler

CacheError

createClientAuthError(string, string)

function createClientAuthError(errorCode: string, additionalMessage?: string): ClientAuthError

Parametreler

errorCode

string

additionalMessage

string

Döndürülenler

ClientAuthError

createClientConfigurationError(string)

function createClientConfigurationError(errorCode: string): ClientConfigurationError

Parametreler

errorCode

string

Döndürülenler

ClientConfigurationError

createInteractionRequiredAuthError(string)

InteractionRequiredAuthError oluşturur

function createInteractionRequiredAuthError(errorCode: string): InteractionRequiredAuthError

Parametreler

errorCode

string

Döndürülenler

InteractionRequiredAuthError

createNetworkError(AuthError, number, Record<string, string>, Error)

Başarısız bir ağ isteği için NetworkError nesnesi oluşturur

function createNetworkError(error: AuthError, httpStatus?: number, responseHeaders?: Record<string, string>, additionalError?: Error): NetworkError

Parametreler

error

AuthError

Arayana geri döndürülecek hata

httpStatus

number

Ağ isteğinin durum kodu

responseHeaders

Record<string, string>

Kullanılabilir olduğunda ağ isteğinin yanıt üst bilgileri

additionalError

Error

Döndürülenler

NetworkError

NetworkError nesnesi

formatAuthorityUri(string)

function formatAuthorityUri(authorityUri: string): string

Parametreler

authorityUri

string

Döndürülenler

string

getRequestThumbprint(string, BaseAuthRequest, string)

function getRequestThumbprint(clientId: string, request: BaseAuthRequest, homeAccountId?: string): RequestThumbprint

Parametreler

clientId

string

request

BaseAuthRequest

homeAccountId

string

Döndürülenler

RequestThumbprint

getTenantIdFromIdTokenClaims(TokenClaims)

Kullanılabilir kimlik belirteci taleplerinden aşağıdaki önceliğe sahip kimlik bilgisi bölgesi olarak ayarlanan tenantId değerini alır:

1. tid - belirteç bir Azure AD kiracısından alındıysa tid mevcut olur
2. tfp - belirteç modern bir B2C kiracısından alındıysa tfp mevcut olmalıdır
3. acr - belirteç eski bir B2C kiracısından alınırsa acr, bölge büyük/küçük harfe duyarlı olmayan karşılaştırma gereksinimlerine uyacak şekilde Küçük Harfle Ayrılmış olarak mevcut olmalıdır

function getTenantIdFromIdTokenClaims(idTokenClaims?: TokenClaims): string | null

Parametreler

idTokenClaims

TokenClaims

Döndürülenler

string | null

tenantIdMatchesHomeTenant(string, string)

tenantId değeri homeAccountId değerinin utid bölümüyle eşleşiyorsa true döndürür

function tenantIdMatchesHomeTenant(tenantId?: string, homeAccountId?: string): boolean

Parametreler

tenantId

string

homeAccountId

string

Döndürülenler

boolean

updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)

Geçirilen kimlik belirteci taleplerinden alınan kiracı profiline göre değişen hesap bilgilerini kiracıya özgü hesap bilgileriyle değiştirir

function updateAccountTenantProfileData(baseAccountInfo: AccountInfo, tenantProfile?: TenantProfile, idTokenClaims?: TokenClaims, idTokenSecret?: string): AccountInfo

Parametreler

baseAccountInfo

AccountInfo

tenantProfile

TenantProfile

idTokenClaims

TokenClaims

idTokenSecret

string

Döndürülenler

AccountInfo

Değişken Ayrıntıları

AADAuthorityConstants

AAD Yetkilisi ile ilgili dize sabitleri

AADAuthorityConstants: { COMMON: "common", CONSUMERS: "consumers", ORGANIZATIONS: "organizations" }

Tür

{ COMMON: "common", CONSUMERS: "consumers", ORGANIZATIONS: "organizations" }

AuthenticationScheme

Kimlik doğrulama isteğinin türü

AuthenticationScheme: { BEARER: "Bearer", POP: "pop", SSH: "ssh-cert" }

Tür

{ BEARER: "Bearer", POP: "pop", SSH: "ssh-cert" }

AuthorityType

MSAL tarafından desteklenen yetkili türleri.

AuthorityType: { Adfs: 1, Ciam: 3, Default: 0, Dsts: 2 }

Tür

{ Adfs: 1, Ciam: 3, Default: 0, Dsts: 2 }

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" }

CacheAccountType

Önbellekteki hesap türleri

CacheAccountType: { ADFS_ACCOUNT_TYPE: "ADFS", GENERIC_ACCOUNT_TYPE: "Generic", MSAV1_ACCOUNT_TYPE: "MSA", MSSTS_ACCOUNT_TYPE: "MSSTS" }

Tür

{ ADFS_ACCOUNT_TYPE: "ADFS", GENERIC_ACCOUNT_TYPE: "Generic", MSAV1_ACCOUNT_TYPE: "MSA", MSSTS_ACCOUNT_TYPE: "MSSTS" }

CacheOutcome

Kimlik sağlayıcısından erişim belirtecinin getirilmenin nedenini belirtir

CacheOutcome: { CACHED_ACCESS_TOKEN_EXPIRED: "3", FORCE_REFRESH_OR_CLAIMS: "1", NOT_APPLICABLE: "0", NO_CACHED_ACCESS_TOKEN: "2", PROACTIVELY_REFRESHED: "4" }

Tür

{ CACHED_ACCESS_TOKEN_EXPIRED: "3", FORCE_REFRESH_OR_CLAIMS: "1", NOT_APPLICABLE: "0", NO_CACHED_ACCESS_TOKEN: "2", PROACTIVELY_REFRESHED: "4" }

CacheType

Tüm önbellek türlerini birleştirme

CacheType: { ACCESS_TOKEN: 2001, ADFS: 1001, APP_METADATA: 3001, GENERIC: 1004, ID_TOKEN: 2003, MSA: 1002, MSSTS: 1003, REFRESH_TOKEN: 2002, UNDEFINED: 9999 }

Tür

{ ACCESS_TOKEN: 2001, ADFS: 1001, APP_METADATA: 3001, GENERIC: 1004, ID_TOKEN: 2003, MSA: 1002, MSSTS: 1003, REFRESH_TOKEN: 2002, UNDEFINED: 9999 }

CcsCredentialType

CcsCredentialType: { HOME_ACCOUNT_ID: "home_account_id", UPN: "UPN" }

Tür

{ HOME_ACCOUNT_ID: "home_account_id", UPN: "UPN" }

ClaimsRequestKeys

Talep isteği anahtarları

ClaimsRequestKeys: { ACCESS_TOKEN: "access_token", XMS_CC: "xms_cc" }

Tür

{ ACCESS_TOKEN: "access_token", XMS_CC: "xms_cc" }

CredentialType

Önbellekte depolanan Kimlik Bilgisi Türü

CredentialType: { ACCESS_TOKEN: "AccessToken", ACCESS_TOKEN_WITH_AUTH_SCHEME: "AccessToken_With_AuthScheme", ID_TOKEN: "IdToken", REFRESH_TOKEN: "RefreshToken" }

Tür

{ ACCESS_TOKEN: "AccessToken", ACCESS_TOKEN_WITH_AUTH_SCHEME: "AccessToken_With_AuthScheme", ID_TOKEN: "IdToken", REFRESH_TOKEN: "RefreshToken" }

EncodingTypes

EncodingTypes: { BASE64: "base64", HEX: "hex", UTF8: "utf-8" }

Tür

{ BASE64: "base64", HEX: "hex", UTF8: "utf-8" }

GrantType

izin verilen grant_type

GrantType: { AUTHORIZATION_CODE_GRANT: "authorization_code", CLIENT_CREDENTIALS_GRANT: "client_credentials", DEVICE_CODE_GRANT: "device_code", IMPLICIT_GRANT: "implicit", JWT_BEARER: "urn:ietf:params:oauth:grant-type:jwt-bearer", REFRESH_TOKEN_GRANT: "refresh_token", RESOURCE_OWNER_PASSWORD_GRANT: "password" }

Tür

{ AUTHORIZATION_CODE_GRANT: "authorization_code", CLIENT_CREDENTIALS_GRANT: "client_credentials", DEVICE_CODE_GRANT: "device_code", IMPLICIT_GRANT: "implicit", JWT_BEARER: "urn:ietf:params:oauth:grant-type:jwt-bearer", REFRESH_TOKEN_GRANT: "refresh_token", RESOURCE_OWNER_PASSWORD_GRANT: "password" }

HeaderNames

İstek üst bilgisi adları

HeaderNames: { AuthenticationInfo: "Authentication-Info", CCS_HEADER: "X-AnchorMailbox", CONTENT_LENGTH: "Content-Length", CONTENT_TYPE: "Content-Type", RETRY_AFTER: "Retry-After", WWWAuthenticate: "WWW-Authenticate", X_MS_HTTP_VERSION: "x-ms-httpver", X_MS_REQUEST_ID: "x-ms-request-id" }

Tür

{ AuthenticationInfo: "Authentication-Info", CCS_HEADER: "X-AnchorMailbox", CONTENT_LENGTH: "Content-Length", CONTENT_TYPE: "Content-Type", RETRY_AFTER: "Retry-After", WWWAuthenticate: "WWW-Authenticate", X_MS_HTTP_VERSION: "x-ms-httpver", X_MS_REQUEST_ID: "x-ms-request-id" }

HttpMethod

HttpMethod: { GET: "GET", POST: "POST" }

Tür

{ GET: "GET", POST: "POST" }

HttpStatus

HttpStatus: { BAD_REQUEST: 400, CLIENT_ERROR: 400, CLIENT_ERROR_RANGE_END: 499, CLIENT_ERROR_RANGE_START: 400, GATEWAY_TIMEOUT: 504, GONE: 410, MULTI_SIDED_ERROR: 600, NOT_FOUND: 404, REDIRECT: 302, REQUEST_TIMEOUT: 408, SERVER_ERROR: 500, SERVER_ERROR_RANGE_END: 599, SERVER_ERROR_RANGE_START: 500, SERVICE_UNAVAILABLE: 503, SUCCESS: 200, SUCCESS_RANGE_END: 299, SUCCESS_RANGE_START: 200, TOO_MANY_REQUESTS: 429, UNAUTHORIZED: 401 }

Tür

{ BAD_REQUEST: 400, CLIENT_ERROR: 400, CLIENT_ERROR_RANGE_END: 499, CLIENT_ERROR_RANGE_START: 400, GATEWAY_TIMEOUT: 504, GONE: 410, MULTI_SIDED_ERROR: 600, NOT_FOUND: 404, REDIRECT: 302, REQUEST_TIMEOUT: 408, SERVER_ERROR: 500, SERVER_ERROR_RANGE_END: 599, SERVER_ERROR_RANGE_START: 500, SERVICE_UNAVAILABLE: 503, SUCCESS: 200, SUCCESS_RANGE_END: 299, SUCCESS_RANGE_START: 200, TOO_MANY_REQUESTS: 429, UNAUTHORIZED: 401 }

JsonWebTokenTypes

JsonWebTokenTypes: { Jwk: "JWK", Jwt: "JWT", Pop: "pop" }

Tür

{ Jwk: "JWK", Jwt: "JWT", Pop: "pop" }

OAuthResponseType

response_type için izin verilen değerler

OAuthResponseType: { CODE: "code", IDTOKEN_TOKEN: "id_token token", IDTOKEN_TOKEN_REFRESHTOKEN: "id_token token refresh_token" }

Tür

{ CODE: "code", IDTOKEN_TOKEN: "id_token token", IDTOKEN_TOKEN_REFRESHTOKEN: "id_token token refresh_token" }

PasswordGrantConstants

Parola verme parametreleri

PasswordGrantConstants: { password: "password", username: "username" }

Tür

{ password: "password", username: "username" }

PersistentCacheKeys

Kullanıcı oturum açtığında kalan kalıcı önbellek anahtarları MSAL.

PersistentCacheKeys: { ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }

Tür

{ ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }

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" }

ServerResponseType

Uyarı

Bu API artık kullanım dışıdır.

Use ResponseMode instead

sunucu yanıt türü için izin verilen değerler

ServerResponseType: { FRAGMENT: "fragment", QUERY: "query" }

Tür

{ 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 } }

CodeChallengeMethodValues

codeVerifier için izin verilen değerler

CodeChallengeMethodValues: { PLAIN: string, S256: string }

Tür

{ PLAIN: string, S256: string }

Constants

Constants: { AAD_INSTANCE_DISCOVERY_ENDPT: string, AAD_TENANT_DOMAIN_SUFFIX: string, ADFS: string, AUTHORIZATION_PENDING: string, AZURE_REGION_AUTO_DISCOVER_FLAG: string, CIAM_AUTH_URL: string, CLAIMS: string, CODE_GRANT_TYPE: string, CONSUMER_UTID: string, DEFAULT_AUTHORITY: string, DEFAULT_AUTHORITY_HOST: string, DEFAULT_COMMON_TENANT: string, DSTS: string, EMAIL_SCOPE: string, EMPTY_STRING: string, FORWARD_SLASH: string, IMDS_ENDPOINT: string, IMDS_TIMEOUT: number, IMDS_VERSION: string, INVALID_INSTANCE: string, KNOWN_PUBLIC_CLOUDS: string[], LIBRARY_NAME: string, NOT_APPLICABLE: string, NOT_AVAILABLE: string, NOT_DEFINED: string, NO_ACCOUNT: string, OFFLINE_ACCESS_SCOPE: string, OPENID_SCOPE: string, PROFILE_SCOPE: string, REGIONAL_AUTH_PUBLIC_CLOUD_SUFFIX: string, RESOURCE_DELIM: string, RT_GRANT_TYPE: string, S256_CODE_CHALLENGE_METHOD: string, SHR_NONCE_VALIDITY: number, SKU: string, URL_FORM_CONTENT_TYPE: string }

Tür

{ AAD_INSTANCE_DISCOVERY_ENDPT: string, AAD_TENANT_DOMAIN_SUFFIX: string, ADFS: string, AUTHORIZATION_PENDING: string, AZURE_REGION_AUTO_DISCOVER_FLAG: string, CIAM_AUTH_URL: string, CLAIMS: string, CODE_GRANT_TYPE: string, CONSUMER_UTID: string, DEFAULT_AUTHORITY: string, DEFAULT_AUTHORITY_HOST: string, DEFAULT_COMMON_TENANT: string, DSTS: string, EMAIL_SCOPE: string, EMPTY_STRING: string, FORWARD_SLASH: string, IMDS_ENDPOINT: string, IMDS_TIMEOUT: number, IMDS_VERSION: string, INVALID_INSTANCE: string, KNOWN_PUBLIC_CLOUDS: string[], LIBRARY_NAME: string, NOT_APPLICABLE: string, NOT_AVAILABLE: string, NOT_DEFINED: string, NO_ACCOUNT: string, OFFLINE_ACCESS_SCOPE: string, OPENID_SCOPE: string, PROFILE_SCOPE: string, REGIONAL_AUTH_PUBLIC_CLOUD_SUFFIX: string, RESOURCE_DELIM: string, RT_GRANT_TYPE: string, S256_CODE_CHALLENGE_METHOD: string, SHR_NONCE_VALIDITY: number, SKU: string, URL_FORM_CONTENT_TYPE: string }

DEFAULT_CRYPTO_IMPLEMENTATION

DEFAULT_CRYPTO_IMPLEMENTATION: ICrypto

Tür

ICrypto

DEFAULT_SYSTEM_OPTIONS

DEFAULT_SYSTEM_OPTIONS: Required<SystemOptions>

Tür

Required<SystemOptions>

DEFAULT_TOKEN_RENEWAL_OFFSET_SEC

DEFAULT_TOKEN_RENEWAL_OFFSET_SEC: 300

Tür

300

Errors

Errors: { CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }

Tür

{ CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }

IntFields

IntFields: ReadonlySet<string>

Tür

ReadonlySet<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 } }

OIDC_DEFAULT_SCOPES

OIDC_DEFAULT_SCOPES: string[]

Tür

string[]

ONE_DAY_IN_MS

ONE_DAY_IN_MS: 86400000

Tür

86400000

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 }

StubbedNetworkModule

StubbedNetworkModule: INetworkModule

Tür

INetworkModule

THE_FAMILY_ID

THE_FAMILY_ID: "1"

Tür

"1"

ThrottlingConstants

Azaltmayla ilgili sabitler

ThrottlingConstants: { DEFAULT_MAX_THROTTLE_TIME_SECONDS: number, DEFAULT_THROTTLE_TIME_SECONDS: number, THROTTLING_PREFIX: string, X_MS_LIB_CAPABILITY_VALUE: string }

Tür

{ DEFAULT_MAX_THROTTLE_TIME_SECONDS: number, DEFAULT_THROTTLE_TIME_SECONDS: number, THROTTLING_PREFIX: string, X_MS_LIB_CAPABILITY_VALUE: string }

version

version: "15.17.0"

Tür

"15.17.0"