@azure/msal-node package
Klassen
| AuthError |
Algemene foutklasse die is gegenereerd door de MSAL.js-bibliotheek. |
| ClientApplication |
Abstracte basisklasse voor alle ClientApplications - openbaar en vertrouwelijk |
| ClientAssertion |
Clientverklaring van het type jwt-bearer dat wordt gebruikt in vertrouwelijke clientstromen |
| ClientAuthError |
Er is een fout opgetreden wanneer er een fout optreedt in de clientcode die wordt uitgevoerd in de browser. |
| ClientConfigurationError |
Er is een fout opgetreden wanneer er een fout optreedt in de configuratie van de MSAL.js-bibliotheek. |
| ClientCredentialClient |
OAuth2.0-clientreferentie verlenen |
| ConfidentialClientApplication |
Deze klasse moet worden gebruikt voor het verkrijgen van tokens voor vertrouwelijke clienttoepassingen (webApp, webAPI). Vertrouwelijke clienttoepassingen configureren toepassingsgeheimen, clientcertificaten/asserties indien van toepassing |
| CryptoProvider |
Deze klasse implementeert de crypto-interface van het MSAL-knooppunt, waarmee het base64-codering en -decodering kan uitvoeren, cryptografisch willekeurige GUID's genereert en proof key for Code Exchange specificaties voor de OAuth-autorisatiecodestroom implementeert met behulp van PKCE (rfc hier: https://tools.ietf.org/html/rfc7636). |
| DeviceCodeClient |
OAuth2.0-apparaatcodeclient |
| DistributedCachePlugin |
Cache-invoegtoepassing waarmee gegevens naar de cache worden geserialiseerd en gegevens uit de cache worden gedeserialiseerd |
| InteractionRequiredAuthError |
Er is een fout opgetreden wanneer gebruikersinteractie is vereist. |
| Logger |
Klasse die het vastleggen van berichten naar een specifieke locatie vereenvoudigt. |
| ManagedIdentityApplication |
Klasse voor het initialiseren van een beheerde identiteit en het identificeren van de service |
| OnBehalfOfClient |
On-Behalf-Of-client |
| PublicClientApplication |
Deze klasse moet worden gebruikt voor het verkrijgen van tokens voor openbare clienttoepassingen (desktop, mobiel). Openbare clienttoepassingen worden niet vertrouwd om toepassingsgeheimen veilig op te slaan en kunnen daarom alleen tokens aanvragen in de naam van een gebruiker. |
| ServerError |
Er is een fout opgetreden wanneer er een fout optreedt met de servercode, bijvoorbeeld niet beschikbaar. |
| TokenCache |
Cachebeheer voor tokens in het geheugen |
| TokenCacheContext |
Dit klasse-exemplaar helpt bij het bijhouden van de geheugenwijzigingen, waardoor beslissingen kunnen worden gelezen van en geschreven naar de permanente cache |
| UsernamePasswordClient |
Oauth2.0 Password grant client Opmerking: we ondersteunen alleen openbare clients voor het verlenen van wachtwoorden en voor uitsluitend testdoeleinden |
Interfaces
| IAppTokenProvider | |
| ICacheClient |
Interface voor de cache die een getter en setter definieert |
| ICachePlugin | |
| IConfidentialClientApplication |
Interface voor de Klasse ConfidentialClientApplication waarmee de openbare API-handtekeningen worden gedefinieerd |
| ILoopbackClient |
Interface voor LoopbackClient waarmee de standaard loopbackserver kan worden vervangen door een aangepaste implementatie. |
| INativeBrokerPlugin | |
| INetworkModule |
Clientnetwerkinterface voor het verzenden van back-endaanvragen. |
| IPartitionManager |
Interface waarmee getter-methoden worden gedefinieerd om sleutels op te halen die worden gebruikt voor identiteitsgegevens in de cache |
| IPublicClientApplication |
Interface voor de PublicClientApplication-klasse die de openbare API-handtekeningen definieert |
| ISerializableTokenCache | |
| ITokenCache |
Tokencacheinterface voor de client, waardoor toegang wordt gegeven tot cache-API's |
Type-aliassen
| AccountInfo |
Accountobject met de volgende handtekening:
|
| AppTokenProviderParameters |
Invoerobject voor de uitbreiding van IAppTokenProvider. MSAL maakt dit object, dat kan worden gebruikt om een AppTokenProviderResult te maken.
|
| AppTokenProviderResult |
Uitvoerobject voor IAppTokenProvider extensiblity.
|
| AuthenticationResult |
Resultaat geretourneerd van het tokeneindpunt van de instantie.
|
| AuthorizationCodePayload |
Antwoord geretourneerd na het verwerken van de querytekenreeks of het fragment van het codeantwoord. |
| AuthorizationCodeRequest |
Aanvraagobject dat door de gebruiker is doorgegeven om een token te verkrijgen van de server die een geldige autorisatiecode uitwisselt (tweede deel van OAuth2.0-autorisatiecodestroom)
|
| AuthorizationUrlRequest |
Aanvraagobject dat door de gebruiker is doorgegeven om een code op te halen van de server (eerste been van autorisatiecode verlenen stroom)
|
| AuthorizeResponse |
Antwoordeigenschappen die kunnen worden geretourneerd door het /authorize-eindpunt |
| AzureCloudOptions |
Specifieke opties voor AzureCloudInstance
|
| BrokerOptions |
Gebruik deze optie om de onderstaande brokeropties te configureren:
Opmerking: deze opties zijn alleen beschikbaar voor PublicClientApplications met behulp van de autorisatiecodestroom |
| CacheKVStore |
Sleutelwaardearchief voor cache in het geheugen |
| CacheOptions |
Gebruik deze optie om de onderstaande cacheconfiguratieopties te configureren:
|
| ClientAssertionCallback | |
| ClientCredentialRequest |
CommonClientCredentialRequest
|
| Configuration |
Het configuratieobject gebruiken om MSAL te configureren en het clienttoepassingsobject te initialiseren
|
| DeviceCodeRequest |
Parameters voor de Oauth2-apparaatcodestroom.
|
| IdTokenClaims |
Type waarmee id-tokenclaims worden beschreven die bekend zijn door MSAL. |
| InMemoryCache |
Onregelmatig type voor het verwerken van in-memory gegevensobjecten met gedefinieerde typen |
| InteractiveRequest |
Aanvraagobject dat door de gebruiker is doorgegeven om acquireTokenInteractive API te configureren
|
| JsonCache |
Cache-indeling gelezen uit de cache-blob die tijdens de app-instantiëring aan de configuratie is verstrekt |
| ManagedIdentityConfiguration | |
| ManagedIdentityIdParams | |
| ManagedIdentityRequestParams |
ManagedIdentityRequest
|
| NetworkRequestOptions |
Opties die zijn toegestaan door API's voor netwerkaanvragen. |
| NetworkResponse | |
| NodeAuthOptions |
|
| NodeSystemOptions |
Type voor het configureren van logboekregistratie en http-clientopties
|
| NodeTelemetryOptions | |
| OnBehalfOfRequest |
|
| RefreshTokenRequest |
CommonRefreshTokenRequest
|
| SerializedAccessTokenEntity |
Referentietype toegangstoken |
| SerializedAccountEntity |
Rekeningstype |
| SerializedAppMetadataEntity |
AppMetadata-type |
| SerializedIdTokenEntity |
Referentietype Idtoken |
| SerializedRefreshTokenEntity |
Referentietype token vernieuwen |
| SignOutRequest | |
| SilentFlowRequest |
SilentFlow-parameters doorgegeven door de gebruiker om referenties op de achtergrond op te halen
|
| UsernamePasswordRequest |
UsernamePassword-parameters die door de gebruiker zijn doorgegeven om referenties op te halen Opmerking: de meest recente best practice voor beveiliging van OAuth 2.0 staat de toekenning van het wachtwoord volledig toe. Deze stroom wordt toegevoegd voor interne tests.
|
Enums
| LogLevel |
Logboekberichtniveau. |
Variabelen
| Azure |
|
| Managed |
Namen van beheerde identiteitsbronnen |
| Protocol |
Protocolmodi die worden ondersteund door MSAL. |
| Response |
toegestane waarden voor response_mode |
| Auth |
AuthErrorMessage-klasse met tekenreeksconstanten die worden gebruikt door foutcodes en berichten. |
| Client |
Tekenreeksconstanten die worden gebruikt door foutcodes en berichten. |
| Client |
ClientConfigurationErrorMessage-klasse met tekenreeksconstanten die worden gebruikt door foutcodes en berichten. |
| Interaction |
Vereiste interactiefouten die zijn gedefinieerd door de SDK |
| Prompt |
We hebben overwogen deze 'enum' in de aanvraag in plaats van tekenreeks te maken, maar het lijkt erop dat de toegestane lijst met promptwaarden de afgelopen jaren is gewijzigd. Er zijn ook enkele niet-gedocumenteerde promptwaarden voor sommige interne partners, vandaar de keuze van het algemene 'tekenreekstype' in plaats van de 'enum' |
| version |
Variabele details
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" }
Type
{ 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
Namen van beheerde identiteitsbronnen
ManagedIdentitySourceNames: { APP_SERVICE: "AppService", AZURE_ARC: "AzureArc", CLOUD_SHELL: "CloudShell", DEFAULT_TO_IMDS: "DefaultToImds", IMDS: "Imds", MACHINE_LEARNING: "MachineLearning", SERVICE_FABRIC: "ServiceFabric" }
Type
{ APP_SERVICE: "AppService", AZURE_ARC: "AzureArc", CLOUD_SHELL: "CloudShell", DEFAULT_TO_IMDS: "DefaultToImds", IMDS: "Imds", MACHINE_LEARNING: "MachineLearning", SERVICE_FABRIC: "ServiceFabric" }
ProtocolMode
Protocolmodi die worden ondersteund door MSAL.
ProtocolMode: { AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }
Type
{ AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }
ResponseMode
toegestane waarden voor response_mode
ResponseMode: { FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }
Type
{ FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }
AuthErrorMessage
Waarschuwing
Deze API is nu afgeschaft.
Use AuthErrorCodes instead
AuthErrorMessage-klasse met tekenreeksconstanten die worden gebruikt door foutcodes en berichten.
AuthErrorMessage: { postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }
Type
{ postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }
ClientAuthErrorMessage
Waarschuwing
Deze API is nu afgeschaft.
Use ClientAuthErrorCodes instead
Tekenreeksconstanten die worden gebruikt door foutcodes en berichten.
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 } }
Type
{ 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
Waarschuwing
Deze API is nu afgeschaft.
Use ClientConfigurationErrorCodes instead
ClientConfigurationErrorMessage-klasse met tekenreeksconstanten die worden gebruikt door foutcodes en berichten.
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 } }
Type
{ 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
Waarschuwing
Deze API is nu afgeschaft.
Use InteractionRequiredAuthErrorCodes instead
Vereiste interactiefouten die zijn gedefinieerd door de 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 } }
Type
{ 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
We hebben overwogen deze 'enum' in de aanvraag in plaats van tekenreeks te maken, maar het lijkt erop dat de toegestane lijst met promptwaarden de afgelopen jaren is gewijzigd. Er zijn ook enkele niet-gedocumenteerde promptwaarden voor sommige interne partners, vandaar de keuze van het algemene 'tekenreekstype' in plaats van de 'enum'
PromptValue: { CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }
Type
{ CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }
version
version: "3.8.10"
Type
"3.8.10"