@azure/msal-node package
クラス
| AuthError |
MSAL.js ライブラリによってスローされる一般的なエラー クラス。 |
| ClientApplication |
すべての ClientApplication の基本抽象クラス - パブリックと社外秘 |
| ClientAssertion |
機密クライアント フローで使用される jwt ベアラー型のクライアント アサーション |
| ClientAuthError |
ブラウザーで実行されているクライアント コードにエラーがある場合にスローされるエラー。 |
| ClientConfigurationError |
MSAL.js ライブラリの構成にエラーがある場合にスローされるエラーです。 |
| ClientCredentialClient |
OAuth2.0 クライアント資格情報の付与 |
| ConfidentialClientApplication |
このクラスは、機密クライアント アプリケーション (webApp、webAPI) のトークンを取得するために使用されます。 機密クライアント アプリケーションは、アプリケーション シークレット、クライアント証明書/アサーションを必要に応じて構成します |
| CryptoProvider |
このクラスは、MSAL ノードの暗号化インターフェイスを実装します。これにより、base64 エンコードとデコードを実行し、暗号的にランダムな GUID を生成し、PKCE を使用して OAuth 承認コード フローのコードExchange仕様の Proof Key を実装できます (rfc here: https://tools.ietf.org/html/rfc7636)。 |
| DeviceCodeClient |
OAuth2.0 デバイス コード クライアント |
| DistributedCachePlugin |
キャッシュにデータをシリアル化し、キャッシュからデータを逆シリアル化するキャッシュ プラグイン |
| InteractionRequiredAuthError |
ユーザーの操作が必要な場合にスローされるエラー。 |
| Logger |
特定の場所へのメッセージのログ記録を容易にするクラス。 |
| ManagedIdentityApplication |
マネージド ID を初期化し、サービスを識別するクラス |
| OnBehalfOfClient |
On-Behalf-Of クライアント |
| PublicClientApplication |
このクラスは、パブリック クライアント アプリケーション (デスクトップ、モバイル) のトークンを取得するために使用されます。 パブリック クライアント アプリケーションは、アプリケーション シークレットを安全に格納するために信頼されていないため、ユーザーの名前でのみトークンを要求できます。 |
| ServerError |
サーバー コードでエラーが発生した場合にスローされるエラー (使用不可など)。 |
| TokenCache |
インメモリ トークン キャッシュ マネージャー |
| TokenCacheContext |
このクラス インスタンスは、メモリの変更を追跡するのに役立ち、永続キャッシュの読み取りと書き込みの決定を容易にします。 |
| UsernamePasswordClient |
Oauth2.0 パスワード付与クライアント 注: パスワード付与と純粋なテスト目的でのみパブリック クライアントをサポートしています |
インターフェイス
| IAppTokenProvider | |
| ICacheClient |
ゲッターとセッターを定義するキャッシュのインターフェイス |
| ICachePlugin | |
| IConfidentialClientApplication |
パブリック API 署名を定義する ConfidentialClientApplication クラスのインターフェイス |
| ILoopbackClient |
LoopbackClient のインターフェイス。既定のループバック サーバーをカスタム実装に置き換えることができます。 |
| INativeBrokerPlugin | |
| INetworkModule |
バックエンド要求を送信するクライアント ネットワーク インターフェイス。 |
| IPartitionManager |
キャッシュ内のデータの ID に使用されるキーを取得する getter メソッドを定義するインターフェイス |
| IPublicClientApplication |
パブリック API シグネチャを定義する PublicClientApplication クラスのインターフェイス |
| ISerializableTokenCache | |
| ITokenCache |
キャッシュ API へのアクセスを許可する、クライアントのトークン キャッシュ インターフェイス |
型エイリアス
| AccountInfo |
次のシグネチャを持つ Account オブジェクト:
|
| AppTokenProviderParameters |
IAppTokenProvider 拡張機能の入力オブジェクト。 MSAL によってこのオブジェクトが作成されます。このオブジェクトは、AppTokenProviderResult の作成に使用できます。
|
| AppTokenProviderResult |
IAppTokenProvider 拡張機能の出力オブジェクト。
|
| AuthenticationResult |
機関のトークン エンドポイントから返される結果。
|
| AuthorizationCodePayload |
コード応答クエリ文字列またはフラグメントの処理後に返される応答。 |
| AuthorizationCodeRequest |
有効な承認コードを交換するサーバーからトークンを取得するようにユーザーが渡したオブジェクトを要求する (OAuth2.0 承認コード フローの第 2 段階)
|
| AuthorizationUrlRequest |
サーバーからコードを取得するためにユーザーによって渡されたオブジェクトを要求する (承認コード付与フローの最初の区間)
|
| AuthorizeResponse |
/authorize エンドポイントによって返される可能性がある応答プロパティ |
| AzureCloudOptions |
AzureCloudInstance 固有のオプション
|
| BrokerOptions |
これを使用して、以下のブローカー オプションを構成します。
注: これらのオプションは、承認コード フローを使用する PublicClientApplications でのみ使用できます。 |
| CacheKVStore |
メモリ内キャッシュのキー値ストア |
| CacheOptions |
これを使用して、次のキャッシュ構成オプションを構成します。
|
| ClientAssertionCallback | |
| ClientCredentialRequest |
CommonClientCredentialRequest
|
| Configuration |
構成オブジェクトを使用して MSAL を構成し、クライアント アプリケーション オブジェクトを初期化する
|
| DeviceCodeRequest |
Oauth2 デバイス コード フローのパラメーター。
|
| IdTokenClaims |
MSAL によって認識される ID トークン要求を記述する型。 |
| InMemoryCache |
定義された型を持つメモリ内データ オブジェクトを処理する断続的な型 |
| InteractiveRequest |
acquireTokenInteractive API を構成するためにユーザーが渡したオブジェクトを要求する
|
| JsonCache |
アプリのインスタンス化中に構成に提供されたキャッシュ BLOB から読み取られたキャッシュ形式 |
| ManagedIdentityConfiguration | |
| ManagedIdentityIdParams | |
| ManagedIdentityRequestParams |
ManagedIdentityRequest
|
| NetworkRequestOptions |
ネットワーク要求 API で許可されるオプション。 |
| NetworkResponse | |
| NodeAuthOptions |
|
| NodeSystemOptions |
ロガーと http クライアント オプションを構成するための型
|
| NodeTelemetryOptions | |
| OnBehalfOfRequest |
|
| RefreshTokenRequest |
CommonRefreshTokenRequest
|
| SerializedAccessTokenEntity |
アクセス トークンの資格情報の種類 |
| SerializedAccountEntity |
アカウントの種類 |
| SerializedAppMetadataEntity |
AppMetadata 型 |
| SerializedIdTokenEntity |
Idtoken 資格情報の種類 |
| SerializedRefreshTokenEntity |
更新トークンの資格情報の種類 |
| SignOutRequest | |
| SilentFlowRequest |
ユーザーが資格情報をサイレントモードで取得するために渡される SilentFlow パラメーター
|
| UsernamePasswordRequest |
ユーザーが資格情報を取得するために渡される UsernamePassword パラメーター注: 最新の OAuth 2.0 セキュリティのベスト カレント プラクティスでは、パスワードの付与が完全に禁止されています。 このフローは、内部テスト用に追加されます。
|
列挙型
| LogLevel |
ログ メッセージ レベル。 |
変数
| Azure |
|
| Managed |
マネージド ID ソース名 |
| Protocol |
MSAL でサポートされているプロトコル モード。 |
| Response |
response_modeに使用できる値 |
| Auth |
エラー コードとメッセージで使用される文字列定数を含む AuthErrorMessage クラス。 |
| Client |
エラー コードとメッセージで使用される文字列定数。 |
| Client |
エラー コードとメッセージで使用される文字列定数を含む ClientConfigurationErrorMessage クラス。 |
| Interaction |
SDK によって定義された相互作用が必要なエラー |
| Prompt |
文字列ではなく要求でこの "enum" を作成することを検討しました。ただし、プロンプト値の許可されたリストは、過去数年間にわたって変化し続けているようです。 一部の内部パートナーには文書化されていないプロンプト値もあります。そのため、"enum" ではなくジェネリック "string" 型を選択します |
| version |
変数の詳細
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" }型
{ 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
マネージド ID ソース名
ManagedIdentitySourceNames: { APP_SERVICE: "AppService", AZURE_ARC: "AzureArc", CLOUD_SHELL: "CloudShell", DEFAULT_TO_IMDS: "DefaultToImds", IMDS: "Imds", MACHINE_LEARNING: "MachineLearning", SERVICE_FABRIC: "ServiceFabric" }型
{ APP_SERVICE: "AppService", AZURE_ARC: "AzureArc", CLOUD_SHELL: "CloudShell", DEFAULT_TO_IMDS: "DefaultToImds", IMDS: "Imds", MACHINE_LEARNING: "MachineLearning", SERVICE_FABRIC: "ServiceFabric" }
ProtocolMode
MSAL でサポートされているプロトコル モード。
ProtocolMode: { AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }型
{ AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }
ResponseMode
response_modeに使用できる値
ResponseMode: { FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }型
{ FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }
AuthErrorMessage
警告
この API は非推奨になりました。
Use AuthErrorCodes instead
エラー コードとメッセージで使用される文字列定数を含む AuthErrorMessage クラス。
AuthErrorMessage: { postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }型
{ postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }
ClientAuthErrorMessage
警告
この API は非推奨になりました。
Use ClientAuthErrorCodes instead
エラー コードとメッセージで使用される文字列定数。
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 } }型
{ 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
警告
この API は非推奨になりました。
Use ClientConfigurationErrorCodes instead
エラー コードとメッセージで使用される文字列定数を含む ClientConfigurationErrorMessage クラス。
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 } }型
{ 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
警告
この API は非推奨になりました。
Use InteractionRequiredAuthErrorCodes instead
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 } }型
{ 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
文字列ではなく要求でこの "enum" を作成することを検討しました。ただし、プロンプト値の許可されたリストは、過去数年間にわたって変化し続けているようです。 一部の内部パートナーには文書化されていないプロンプト値もあります。そのため、"enum" ではなくジェネリック "string" 型を選択します
PromptValue: { CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }型
{ CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }
version
version: "3.8.10"型
"3.8.10"