@azure/msal-common package

クラス

AuthError

MSAL.js ライブラリによってスローされる一般的なエラー クラス。

AuthenticationHeaderParser

これは、サポートされている HTTP 応答認証ヘッダーを解析して、基本的な承認フローの外部で使用できるヘッダー チャレンジ値を抽出して返すヘルパー クラスです。

CacheError

キャッシュにエラーがある場合にスローされるエラー

ClientAuthError

ブラウザーで実行されているクライアント コードにエラーがある場合にスローされるエラー。

ClientConfigurationError

MSAL.js ライブラリの構成にエラーがある場合にスローされるエラーです。

InteractionRequiredAuthError

ユーザーの操作が必要な場合にスローされるエラー。

Logger

特定の場所へのメッセージのログ記録を容易にするクラス。

NetworkError

ネットワーク関連のエラーを表します

PerformanceClient
PlatformBrokerError

詳細なブローカー情報を保持する MSAL ランタイム エラーのエラー クラス

ProtocolUtils

OAuth 2.0 プロトコル固有の値のヘルパーを提供するクラス

ScopeSet

ScopeSet クラスは、一連のスコープを作成します。 スコープでは大文字と小文字が区別されず、一意の値であるため、JS の Set オブジェクトは、このクラスに対して実装するのが最も理にかなっています。 文字列の一意性を確保するために、すべてのスコープがトリミングされ、交差関数と共用体関数の小文字の文字列に変換されます。

ServerError

サーバー コードでエラーが発生した場合にスローされるエラー (使用不可など)。

StubPerformanceClient
UrlString

URL 文字列に対してさまざまな変換を実行できる URL オブジェクト クラス。

TokenCacheContext

このクラス インスタンスは、メモリの変更を追跡するのに役立ち、永続キャッシュの読み取りと書き込みの決定を容易にします。

インターフェイス

ICrypto

ライブラリで使用される暗号関数のインターフェイス

ILoggerCallback
INetworkModule

バックエンド要求を送信するクライアント ネットワーク インターフェイス。

IPerformanceClient
IPerformanceMeasurement
IUri

URI コンポーネントを記述するインターフェイス。

PreQueueEvent
IAppTokenProvider
ICachePlugin
IGuidGenerator
INativeBrokerPlugin
ISerializableTokenCache

型エイリアス

AccessTokenEntity

アクセス トークン キャッシュの種類

AccountFilter

アカウント: <home_account_id>-<environment>-<realm*>

AccountInfo

次のシグネチャを持つ Account オブジェクト:

  • homeAccountId - このアカウント オブジェクトのホーム アカウント識別子
  • environment - 発行者のドメインによって表されるトークンを発行したエンティティ (例: login.microsoftonline.com)
  • tenantId - このアカウントが属する完全なテナントまたは組織 ID
  • username - preferred_usernameこのアカウントを表すid_tokenの要求
  • localAccountId - 通常はレガシ ケースで使用される、このアカウント オブジェクトのローカル、テナント固有のアカウント identifer
  • name - アカウントのフル ネーム (指定された名前とファミリ名を含む)
  • idToken - 生 ID トークン
  • idTokenClaims - オブジェクトに ID トークンからの要求が含まれています
  • nativeAccountId - ユーザーのネイティブ アカウント ID
  • tenantProfiles - アカウントがブラウザーで認証した各テナントのテナント プロファイル オブジェクトのマップ
  • dataBoundary - clientInfo から抽出されたデータ境界
ActiveAccountFilters
AppMetadataEntity

アプリ メタデータ キャッシュの種類

ApplicationTelemetry

要求時に送信されるテレメトリ情報

  • appName: アプリケーションの一意の文字列名
  • appVersion: MSAL を使用したアプリケーションのバージョン
AuthenticationResult

機関のトークン エンドポイントから返される結果。

  • uniqueId - ID トークンからの要求oidまたはsub
  • tenantId - ID トークンからの要求tid
  • scopes - それぞれのトークンに対して検証されるスコープ
  • account - 現在サインインしているユーザーのアカウント オブジェクト表現
  • idToken - 応答の一部として受信した ID トークン
  • idTokenClaims - MSAL 関連 ID トークン要求
  • accessToken - 応答の一部として受信したアクセス トークンまたは SSH 証明書
  • fromCache - トークンがキャッシュから来たかどうかを示すブール値
  • expiresOn - アクセス トークンの相対的な有効期限を表す Javascript Date オブジェクト
  • extExpiresOn - サーバーが停止した場合のアクセス トークンの延長相対有効期限を表す Javascript Date オブジェクト
  • refreshOn - アクセス トークンを更新する必要があるまでの相対時間を表す Javascript Date オブジェクト
  • state - 要求でユーザーによって渡される値
  • familyId - 家族 ID 識別子(通常は更新トークンにのみ使用されます)
  • requestId - 応答の一部として返される要求 ID
AuthorityOptions
AuthorizationCodePayload

コード応答クエリ文字列またはフラグメントの処理後に返される応答。

AuthorizeResponse

/authorize エンドポイントによって返される可能性がある応答プロパティ

AzureCloudOptions

AzureCloudInstance 固有のオプション

  • azureCloudInstance - soverign およびパブリック クラウド機関に短い表記を提供する文字列列挙型
  • tenant - テナント情報を提供するためのプロビジョニング
AzureRegion
AzureRegionConfiguration
BaseAuthRequest

BaseAuthRequest

  • authority - 機関の URL、MSAL がトークンを取得するセキュリティ トークン サービス (STS)。 既定値は https://login.microsoftonline.com/common です。 すべての要求に同じ権限を使用する場合は、権限エンドポイントを複数回解決しないように、要求ではなくクライアント・アプリケーション・オブジェクトに権限を設定する必要があります。
  • correlationId - テレメトリの目的で要求をエンドツーエンドでトレースするために要求ごとに設定される一意の GUID。
  • scopes - アプリケーションがアクセスを要求しているスコープの配列。
  • authenticationScheme - 取得されたトークンの種類。 既定値は "Bearer" です。 "pop" または "SSH" と入力することもできます。
  • claims - すべての /authorize および /token 呼び出しに追加される文字列化された要求要求
  • shrClaims - 署名付き HTTP 要求に追加される文字列化された要求オブジェクト
  • shrNonce - 暗号化され base64URL でエンコードされたサーバー生成のタイムスタンプ。これは、署名済み HTTP 要求に追加されます。
  • shrOptions - 署名付き HTTP 要求のオプションを含むオブジェクト
  • resourceRequestMethod - リソースからのデータ要求に使用される HTTP 要求の種類 ("GET"、"POST"など)。 所有証明フローに使用されます。
  • resourceRequestUri - トークンが使用される URI。 所有証明フローに使用されます。
  • sshJwk - SSH 証明書によって署名できる公開キーを表す文字列化された JSON Web キー。
  • sshKid - 上記の SSH 公開キーを一意に識別するキー ID。
  • azureCloudOptions - ユーザーがパブリック/ソブリン クラウド ID を提供するための便利な文字列列挙型
  • requestedClaimsHash - 要求された要求文字列の SHA 256 ハッシュ文字列。アクセス トークン キャッシュ キーの一部として使用されるため、要求された要求によってトークンをフィルター処理できます
  • tokenQueryParameters - /token 呼び出しに追加されたカスタム クエリ パラメーターの文字列マップへの文字列
  • tokenBodyParameters - /token 呼び出しの本文に追加されたカスタム パラメーターの文字列マップへの文字列
  • storeInCache - トークンをキャッシュに格納するかどうかを示すブール値を含むオブジェクト (既定値は true)
  • scenarioId - カスタム ユーザー プロンプトを追跡するシナリオ ID
  • popKid - PoP トークン要求の公開キーを識別するためのキー ID
  • embeddedClientId - 埋め込みクライアント ID。指定すると、ブローカー クライアント ID (brk_client_id) パラメーターとリダイレクト URI (brk_redirect_uri) パラメーターが構成の値で設定され、対応する追加パラメーターが存在する場合はオーバーライドされます。
  • httpMethod - /authorize 要求に使用する HTTP メソッド。 既定値は GET ですが、要求に本文パラメーターが必要な場合は POST に設定できます
  • authorizePostBodyParameters - httpMethod が POST に設定されている場合に/authorize 呼び出しの本文に追加されたカスタム パラメーターの文字列マップへの文字列
  • skipBrokerClaims - true でブローカー フローが使用されている場合 (たとえば、ブローカー パラメーターまたは embeddedClientId が存在する場合)、構成からの clientCapabilities は要求から除外されます。非ブローカー フローでは無視されます。
CacheOptions

これを使用して、ClientConfiguration オブジェクトで資格情報キャッシュの基本設定を構成します

  • claimsBasedCachingEnabled - 要求ハッシュに基づいてトークンをキャッシュするかどうかを設定します。 既定値は falseです。
CcsCredential
ClientInfo

次で構成されるクライアント情報オブジェクト: uid: user id utid: tenant id xms_tdbr: optional, only for non-US tenants

CommonAuthorizationCodeRequest

有効な承認コードを交換するサーバーからトークンを取得するようにユーザーが渡したオブジェクトを要求する (OAuth2.0 承認コード フローの第 2 段階)

  • scopes - アプリケーションがアクセスを要求しているスコープの配列。
  • claims - すべての /authorize および /token 呼び出しに追加される文字列化された要求要求
  • authority: - 機関の URL、MSAL がトークンを取得するセキュリティ トークン サービス (STS)。 クライアント・アプリケーション・オブジェクトに権限が設定されている場合、その値はオーバーライドされます。 値をオーバーライドすると、毎回機関の検証が行われます。 すべての要求に同じ権限が使用される場合は、要求の代わりにアプリケーション・オブジェクトに設定します。
  • correlationId - テレメトリの目的で要求をエンドツーエンドでトレースするために要求ごとに設定される一意の GUID。
  • redirectUri - ユーザーが資格情報と同意を入力した後に機関がリダイレクトするアプリのリダイレクト URI。 ポータルに登録したリダイレクト URI のいずれかと完全に一致している必要があります
  • code - ユーザーがフローの最初の区間で取得したauthorization_code。
  • codeVerifier - authorization_codeを取得するために使用されたのと同じcode_verifier。 承認コード付与要求で PKCE が使用された場合に必要です。詳細については、PKCE RFC を参照してください。 https://tools.ietf.org/html/rfc7636
  • resourceRequestMethod - リソースからのデータ要求に使用される HTTP 要求の種類 ("GET"、"POST"など)。 所有証明フローに使用されます。
  • resourceRequestUri - トークンが使用される URI。 所有証明フローに使用されます。
  • enableSpaAuthCode - Spa 承認コードの記述を有効にします (機密クライアントのみ)
  • tokenQueryParameters - /token 呼び出しに追加されたカスタム クエリ パラメーターの文字列マップへの文字列
CommonAuthorizationUrlRequest

サーバーからコードを取得するためにユーザーによって渡されたオブジェクトを要求する (承認コード付与フローの最初の区間)

  • scopes - アプリケーションがアクセスを要求しているスコープの配列。
  • claims - すべての /authorize および /token 呼び出しに追加される文字列化された要求要求
  • authority - アプリケーションがトークンを取得する機関の URL。
  • correlationId - テレメトリの目的で要求をエンドツーエンドでトレースするために要求ごとに設定される一意の GUID。
  • redirectUri - アプリケーションが認証応答を受信できるリダイレクト URI。 Azure ポータルに登録されているリダイレクト URI のいずれかと完全に一致している必要があります。
  • extraScopesToConsent - ユーザーが事前に同意する必要がある場合の別のリソースのスコープ。
  • responseMode - 認証結果をアプリに送信するために使用するメソッドを指定します。 クエリ、form_post、フラグメントを指定できます。 値が渡されない場合は、既定でクエリが実行されます。
  • codeChallenge - Proof of Key for Code Exchange (PKCE) を使用して承認コード付与をセキュリティで保護するために使用されます。 詳細については、PKCE RCF を参照してください。https://tools.ietf.org/html/rfc7636
  • codeChallengeMethod - コード チャレンジ パラメーターのコード検証ツールをエンコードするために使用されるメソッド。 "plain" または "S256" を指定できます。 除外した場合、コード チャレンジはプレーンテキストと見なされます。 詳細については、PKCE RCF を参照してください。 https://tools.ietf.org/html/rfc7636
  • state - トークン応答にも返される要求に含まれる値。 ランダムに生成された一意の値は、通常、クロスサイト リクエスト フォージェリ攻撃を防ぐために使用されます。 状態は、認証要求が発生する前のアプリ内のユーザーの状態に関する情報をエンコードするためにも使用されます。
  • prompt - 必要なユーザー操作の種類を示します。 login: ユーザーがその要求に対して資格情報を入力するように強制し、シングル サインオンなしを否定します。これにより、ユーザーに対話型プロンプトが表示されなくなります。 シングル サインオンを使用して要求を完了できない場合、エンドポイントは interaction_required エラーの同意を返します。ユーザーがサインインした後に OAuth 同意ダイアログがトリガーされ、ユーザーにアプリへのアクセス許可の付与を求めるselect_account: セッション内のすべてのアカウントまたは記憶されているアカウントを一覧表示するアカウント選択エクスペリエンスを提供するシングル サインオンが中断されます。または、別のアカウント作成を使用することを選択するオプションが提供されます。 は、ログイン エクスペリエンスの代わりにユーザーをアカウント作成エクスペリエンスに誘導no_session:ユーザーを認証するときに既存のセッション トークンを読み取りません。 ユーザーが正常に認証されると、EVO はユーザーの新しいセッションを作成しません。 内部使用のみ。
  • account - getAccount API から取得した AccountInfo。 loginHint パラメーターと sid パラメーターの両方が指定されていない場合は、特定のシナリオでlogin_hintを生成するために使用されます。
  • loginHint - ユーザー名/メール アドレスがわかっている場合は、ユーザーのサインイン ページのユーザー名/メール アドレス フィールドを事前に入力するために使用できます。 多くの場合、アプリは再認証時にこのパラメーターを使用します。これは、preferred_username要求を使用して以前のサインインからユーザー名を既に抽出しています。
  • sid - セッション ID、セッションの一意識別子。 ID トークンの省略可能な要求として使用できます。
  • domainHint - ユーザーがサインインに使用するテナントまたはドメインに関するヒントを提供します。 ドメイン ヒントの値は、テナントの登録済みドメインです。
  • extraQueryParameters - /authorize 呼び出しに追加されたカスタム クエリ パラメーターの文字列マップへの文字列
  • tokenQueryParameters - /token 呼び出しに追加されたカスタム クエリ パラメーターの文字列マップへの文字列
  • nonce - ID トークンで返される要求に含まれる値。 ランダムに生成された一意の値は、通常、リプレイ攻撃を軽減するために使用されます。
  • resourceRequestMethod - リソースからデータを要求するために使用される HTTP 要求の種類 ("GET"、"POST"など)。 所有証明フローに使用されます。
  • resourceRequestUri - トークンが使用される URI。 所有証明フローに使用されます。
CommonEndSessionRequest

CommonEndSessionRequest

  • account - ログアウトされる Account オブジェクト。 このアカウントに関連付けられているすべてのトークンがクリアされます。
  • postLogoutRedirectUri - ログアウト後のページに移動する URI。
  • correlationId - テレメトリの目的で要求をエンドツーエンドでトレースするために要求ごとに設定される一意の GUID。
  • idTokenHint - ポリシーで必要な場合にログアウトを検証するために B2C によって使用される ID トークン
  • state - ログアウト 後のリダイレクト時にクエリ文字列に返されるログアウト エンドポイントへの要求に含まれる値
  • logoutHint - ログアウト時にサーバー アカウント ピッカーをスキップするためにログアウトするアカウントを指定する文字列
  • extraQueryParameters - /authorize 呼び出しに追加されたカスタム クエリ パラメーターの文字列マップへの文字列
CommonRefreshTokenRequest

CommonRefreshTokenRequest

  • scopes - アプリケーションがアクセスを要求しているスコープの配列。
  • claims - すべての /authorize および /token 呼び出しに追加される文字列化された要求要求
  • authority - 機関の URL、MSAL がトークンを取得するセキュリティ トークン サービス (STS)。
  • correlationId - テレメトリの目的で要求をエンドツーエンドでトレースするために要求ごとに設定される一意の GUID。
  • refreshToken - 以前の要求から ID プロバイダーに返された更新トークン。
  • resourceRequestMethod - リソースからデータを要求するために使用される HTTP 要求の種類 ("GET"、"POST"など)。 所有証明フローに使用されます。
  • resourceRequestUri - トークンが使用される URI。 所有証明フローに使用されます。
  • forceCache - キャッシュにアカウントがない場合に、更新トークン フロー応答をキャッシュするように MSAL に強制します。 移行シナリオに使用されます。
  • tokenQueryParameters - /token 呼び出しに追加されたカスタム クエリ パラメーターの文字列マップへの文字列
CommonSilentFlowRequest

ユーザーが資格情報をサイレントモードで取得するために渡される SilentFlow パラメーター

  • scopes - アプリケーションがアクセスを要求しているスコープの配列。
  • claims - すべての /authorize および /token 呼び出しに追加される文字列化された要求要求。 サイレント要求に含めると、キャッシュ参照がスキップされ、トークンが更新されます。
  • authority - アプリケーションがトークンを取得する機関の URL。
  • correlationId - テレメトリの目的で要求をエンドツーエンドでトレースするために要求ごとに設定される一意の GUID。
  • account - 資格情報を参照するアカウント エンティティ。
  • forceRefresh - true の場合、ネットワーク呼び出しを強制的にサイレント要求します。
  • resourceRequestMethod - リソースからのデータ要求に使用される HTTP 要求の種類 ("GET"、"POST"など)。 所有証明フローに使用されます。
  • resourceRequestUri - トークンが使用される URI。 所有証明フローに使用されます。
  • tokenQueryParameters - /token 呼び出しに追加されたカスタム クエリ パラメーターの文字列マップへの文字列
CredentialEntity

資格情報キャッシュの種類

CredentialFilter

資格情報: <home_account_id*>-<environment>-<credential_type>-<client_id>-<realm*>-<target*>-<scheme*>

ExternalTokenResponse

キャッシュする外部トークンの読み込みに使用される応答オブジェクト。

  • token_type: トークンの種類の値を示します。 AD でサポートAzure唯一の種類は Bearer です。
  • scope: access_tokenが有効なスコープ。
  • expires_in: アクセス トークンの有効期間 (秒単位)。
  • id_token: JSON Web トークン (JWT)。 アプリは、このトークンのセグメントをデコードして、サインインしたユーザーに関する情報を要求することができます。
  • refresh_token: OAuth 2.0 更新トークン。 アプリでは、現在のアクセス トークンの有効期限が切れた後に、このトークンを使用して追加のアクセス トークンを取得できます。
  • access_token: 要求されたアクセス トークン。 アプリはこのトークンを使用して、Web API など、保護されたリソースに対して認証できます。
  • client_info: クライアント情報オブジェクト
IdTokenEntity

ID トークン キャッシュの種類

InProgressPerformanceEvent
LibraryStateObject

文字列化され、エンコードされ、状態値で送信されるオブジェクトを定義する型。 次のものが含まれます。

  • id - この要求の一意の識別子
  • ts - 要求が行われた時刻のタイムスタンプ。 トークンの有効期限が正しく計算されないようにするために使用されます。
  • platformState - プラットフォームから送信される文字列値。
LoggerOptions

これを使用して、構成オブジェクトでロガー オプションを構成することで、MSAL が行うログ記録を構成します。

  • loggerCallback - ロガーのコールバック
  • piiLoggingEnabled - pii ログが有効かどうかを設定します
  • logLevel - ログ記録が発生するレベルを設定します
  • correlationId - ロガーによって出力される correlationId を設定します
NetworkRequestOptions

ネットワーク要求 API で許可されるオプション。

NetworkResponse
OIDCOptions

OIDC プロトコル モードのオプション。

PerformanceCallbackFunction
PerformanceEvent

要求とアプリケーションに関するメタデータを含む、ライブラリによって取得されたパフォーマンス測定。

PkceCodes

PkceCodes 型は、PKCE コード チャレンジと検証ツールのペアを含むオブジェクトの構造を記述します

QueueMeasurement

キュー測定の種類

RefreshTokenEntity

更新トークン キャッシュの種類

RequestStateObject

承認要求でサービスに送信される文字列化およびエンコードされたオブジェクトを定義する型。

RequestThumbprint

一意の要求の拇印を表す型。

ServerAuthorizationTokenResponse

サーバー承認コード要求から逆シリアル化された応答オブジェクト。

  • token_type: トークンの種類の値を示します。 ベアラーまたはポップのいずれかを指定できます。
  • scope: access_tokenが有効なスコープ。
  • expires_in: アクセス トークンの有効期間 (秒単位)。
  • refresh_in: 有効期限に関係なく、トークンを更新する期間を推定します。
  • ext_expires_in: サーバーが応答していない場合、アクセス トークンが有効な期間 (秒単位)。
  • access_token: 要求されたアクセス トークン。 アプリはこのトークンを使用して、Web API など、保護されたリソースに対して認証できます。
  • refresh_token: OAuth 2.0 更新トークン。 アプリでは、現在のアクセス トークンの有効期限が切れた後に、このトークンを使用して追加のアクセス トークンを取得できます。
  • id_token: JSON Web トークン (JWT)。 アプリは、このトークンのセグメントをデコードして、サインインしたユーザーに関する情報を要求することができます。
  • key_id: 要求がバインドされている公開キーを一意に識別する文字列。

エラーが発生した場合:

  • error: 発生するエラーの種類を分類するために使用でき、エラーに対応するために使用できるエラー コード文字列。
  • error_description: 開発者が認証エラーの根本原因を特定するのに役立つ特定のエラー メッセージ。
  • error_codes: 診断に役立つ STS 固有のエラー コードの一覧。
  • timestamp: エラーが発生した時刻。
  • trace_id: 診断に役立つ要求の一意識別子。
  • correlation_id: コンポーネント間の診断に役立つ要求の一意識別子。
  • status: ネットワーク要求の応答状態
ServerTelemetryEntity
ServerTelemetryRequest
ShrOptions
SignedHttpRequest
SignedHttpRequestParameters
StaticAuthorityOptions
StoreInCache

トークンをキャッシュに格納するかどうかを制御します。 false に設定した場合、トークンは引き続き取得されて返される可能性がありますが、後で取得するためにキャッシュされることはありません。

StringDict

queryParams、extraQueryParams、要求をサポートする型を Key-Value する

SubMeasurement
SystemOptions

これを使用して、Configuration オブジェクトでトークンの更新情報を構成します

  • tokenRenewalOffsetSeconds - 有効期限が切れる前にトークンを更新するために必要なオフセットのウィンドウを設定します
TenantProfile

同じユーザーのテナントによって異なるアカウントの詳細

ThrottlingEntity
TokenClaims

MSAL によって認識される ID トークン要求を記述する型。

TokenKeys
AppTokenProviderParameters

IAppTokenProvider 拡張機能の入力オブジェクト。 MSAL によってこのオブジェクトが作成されます。このオブジェクトは、AppTokenProviderResult の作成に使用できます。

  • correlationId - 要求に関連付けられている関連付け ID
  • tenantId - トークンを指定する必要があるテナント ID
  • scopes - トークンを指定する必要があるスコープ
  • claims - トークンが満たす必要がある追加の要求
AppTokenProviderResult

IAppTokenProvider 拡張機能の出力オブジェクト。

  • accessToken - 要求データ AppTokenProviderParameters を満たす実際のアクセス トークン (通常は JWT 形式)
  • expiresInSeconds - トークンが期限切れになるまでの時間 (秒単位)。 AAD トークン応答の "expires_in" フィールドに似ています。
  • refreshInSeconds - トークンが事前に更新されるまでの時間。 AAD トークン応答の "refresh_in" フィールドに似ています。
ClientAssertion

機密クライアントのクライアント アサーション資格情報

ClientAssertionCallback
ClientAssertionConfig
CommonClientCredentialRequest

CommonClientCredentialRequest

  • scopes - アプリケーションがアクセスを要求しているスコープの配列。
  • authority - 機関の URL、MSAL がトークンを取得するセキュリティ トークン サービス (STS)。
  • correlationId - テレメトリの目的で要求をエンドツーエンドでトレースするために要求ごとに設定される一意の GUID。
  • skipCache - トークン キャッシュの検索をスキップし、新しいトークンを取得するために機関に要求を強制します。 既定値は false です。
  • preferredAzureRegionOptions - ユーザーの優先 Azure リージョンのオプション
  • tokenQueryParameters - /token 呼び出しに追加されたカスタム クエリ パラメーターの文字列マップへの文字列
CommonDeviceCodeRequest

Oauth2 デバイス コード フローのパラメーター。

  • scopes - アプリケーションがアクセスを要求しているスコープの配列。
  • authority: - 機関の URL、MSAL がトークンを取得するセキュリティ トークン サービス (STS)。 クライアント・アプリケーション・オブジェクトに権限が設定されている場合、その値はオーバーライドされます。 値をオーバーライドすると、毎回機関の検証が行われます。 すべての要求に同じ権限が使用される場合は、要求の代わりにアプリケーション・オブジェクトに設定します。
  • correlationId - テレメトリの目的で要求をエンドツーエンドでトレースするために要求ごとに設定される一意の GUID。
  • deviceCodeCallback - デバイス コード応答を含むコールバック。 エンド ユーザーにメッセージを表示する必要があります。 エンド ユーザーは、verification_uriに移動し、user_codeを入力し、資格情報を入力できます。
  • cancel - デバイス コード エンドポイントのポーリングを取り消すブール値。 ユーザーが別のデバイスで認証されている間、MSAL は、デバイス コード応答で指定された間隔 (通常は 15 分) のセキュリティ トークン サービスのトークン エンドポイントをポーリングします。 ポーリングを停止して要求を取り消すには、cancel=true を設定します。
  • resourceRequestMethod - リソースからのデータ要求に使用される HTTP 要求の種類 ("GET"、"POST"など)。 所有証明フローに使用されます。
  • resourceRequestUri - トークンが使用される URI。 所有証明フローに使用されます。
  • timeout - ユーザーがデバイス コード エンドポイントのポーリング用に明示的に構成するタイムアウト期間 (秒単位)。 この期間の終了時。デバイス コードの有効期限がまだ切れていないと仮定します。デバイス コードのポーリングが停止され、要求が取り消されました。 デバイス コードの有効期限ウィンドウは、この設定された期間よりも常に優先されます。
  • extraQueryParameters - クエリ文字列に追加されたカスタム クエリ パラメーターの文字列マップへの文字列
CommonOnBehalfOfRequest
  • scopes - アプリケーションがアクセスを要求しているスコープの配列。
  • authority - 機関の URL、MSAL がトークンを取得するセキュリティ トークン サービス (STS)。
  • correlationId - テレメトリの目的で要求をエンドツーエンドでトレースするために要求ごとに設定される一意の GUID。
  • oboAssertion - 中間層 API に送信されたアクセス トークン。 このトークンには、この OBO 要求を行うアプリの対象ユーザーが必要です。
  • skipCache - トークン キャッシュの検索をスキップし、新しいトークンを取得するために機関に要求を強制します。 既定値は false です。
  • tokenQueryParameters - /token 呼び出しに追加されたカスタム クエリ パラメーターの文字列マップへの文字列
CommonUsernamePasswordRequest

資格情報を取得するためにユーザーによって渡される CommonUsernamePassword パラメーター注: 最新の OAuth 2.0 Security Best Current Practice では、パスワードの許可が完全に禁止されます。 このフローは、内部テスト用に追加されます。

  • scopes - アプリケーションがアクセスを要求しているスコープの配列。
  • claims - すべての /authorize および /token 呼び出しに追加される文字列化された要求要求。 サイレント要求に含めると、キャッシュ参照がスキップされ、トークンが更新されます。
  • authority - アプリケーションがトークンを取得する機関の URL。
  • correlationId - テレメトリの目的で要求をエンドツーエンドでトレースするために要求ごとに設定される一意の GUID。
  • username - クライアントのユーザー名
  • password - credentials
  • tokenQueryParameters - /token 呼び出しに追加されたカスタム クエリ パラメーターの文字列マップへの文字列
DeviceCodeResponse

デバイス コード フローに必要な情報を含む、セキュリティ トークン サービスのデバイス コード エンドポイントによって返される DeviceCode。

  • userCode: 検証 URI で認証するときにユーザーが指定する必要があるコード
  • deviceCode: アクセス トークンの要求に含める必要があるコード
  • verificationUri: ユーザーが認証できる URI
  • expiresIn: デバイス コードの有効期限 (秒単位)
  • interval: STS をポーリングする間隔
  • message: ユーザーに表示する必要があるメッセージ
NativeRequest
NativeSignOutRequest
ServerDeviceCodeResponse

列挙型

LogLevel

ログ メッセージ レベル。

PerformanceEventStatus

パフォーマンス イベントの状態。

PerformanceEvents

インストルメント化された操作の列挙には、PerformanceClient によってパフォーマンスが測定されます。

関数

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

サーバー clientInfo 文字列からクライアント情報オブジェクトを構築する関数

buildClientInfoFromHomeAccountId(string)

キャッシュされた homeAccountId 文字列からクライアント情報オブジェクトを構築する関数

buildStaticAuthorityOptions(Partial<AuthorityOptions>)
buildTenantProfile(string, string, string, TokenClaims)

テナント プロファイルをビルドする

createAuthError(string, string)
createCacheError(unknown)

CacheError オブジェクトでブラウザー エラーをラップするヘルパー関数

createClientAuthError(string, string)
createClientConfigurationError(string)
createInteractionRequiredAuthError(string)

InteractionRequiredAuthError を作成します

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

失敗したネットワーク要求の NetworkError オブジェクトを作成します

formatAuthorityUri(string)
getRequestThumbprint(string, BaseAuthRequest, string)
getTenantIdFromIdTokenClaims(TokenClaims)

使用可能な ID トークン要求から tenantId を取得し、次の優先順位で資格情報領域として設定します。

  1. tid - トークンがAzure AD テナントから取得された場合、tid が存在します
  2. tfp - トークンが最新の B2C テナントから取得された場合、tfp が存在する必要があります
  3. acr - レガシ B2C テナントからトークンが取得された場合、領域の大文字と小文字を区別しない比較要件に合わせて Downcased を提示する必要があります
tenantIdMatchesHomeTenant(string, string)

tenantId が homeAccountId の utid 部分と一致する場合は true を返します。

updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)

渡された ID トークン要求から取得されたテナント プロファイルによって異なるアカウント情報を、テナント固有のアカウント情報に置き換えます

変数

AADAuthorityConstants

AAD 機関に関連する文字列定数

AuthenticationScheme

認証要求の種類

AuthorityType

MSAL でサポートされる権限の種類。

AzureCloudInstance
CacheAccountType

キャッシュ内のアカウントの種類

CacheOutcome

ID プロバイダーからアクセス トークンをフェッチする理由を指定します

CacheType

すべてのキャッシュの種類を結合する

CcsCredentialType
ClaimsRequestKeys

要求キー

CredentialType

キャッシュに格納されている資格情報の種類

EncodingTypes
GrantType

allowed grant_type

HeaderNames

要求ヘッダー名

HttpMethod
HttpStatus
JsonWebTokenTypes
OAuthResponseType

response_typeに使用できる値

PasswordGrantConstants

パスワード付与パラメーター

PersistentCacheKeys

ユーザーのログイン中に保持される永続的キャッシュ キー MSAL。

ProtocolMode

MSAL でサポートされているプロトコル モード。

ResponseMode

response_modeに使用できる値

ServerResponseType

サーバー応答の種類に使用できる値

AuthErrorMessage

エラー コードとメッセージで使用される文字列定数を含む AuthErrorMessage クラス。

ClientAuthErrorMessage

エラー コードとメッセージで使用される文字列定数。

ClientConfigurationErrorMessage

エラー コードとメッセージで使用される文字列定数を含む ClientConfigurationErrorMessage クラス。

CodeChallengeMethodValues

codeVerifier に使用できる値

Constants
DEFAULT_CRYPTO_IMPLEMENTATION
DEFAULT_SYSTEM_OPTIONS
DEFAULT_TOKEN_RENEWAL_OFFSET_SEC
Errors
IntFields
InteractionRequiredAuthErrorMessage

SDK によって定義された相互作用が必要なエラー

OIDC_DEFAULT_SCOPES
ONE_DAY_IN_MS
PromptValue

文字列ではなく要求でこの "enum" を作成することを検討しました。ただし、プロンプト値の許可されたリストは、過去数年間にわたって変化し続けているようです。 一部の内部パートナーには文書化されていないプロンプト値もあります。そのため、"enum" ではなくジェネリック "string" 型を選択します

StubbedNetworkModule
THE_FAMILY_ID
ThrottlingConstants

調整に関連する定数

version

関数の詳細

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

パラメーター

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

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

サーバー clientInfo 文字列からクライアント情報オブジェクトを構築する関数

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

パラメーター

rawClientInfo

string

base64Decode

(input: string) => string

返品

buildClientInfoFromHomeAccountId(string)

キャッシュされた homeAccountId 文字列からクライアント情報オブジェクトを構築する関数

function buildClientInfoFromHomeAccountId(homeAccountId: string): ClientInfo

パラメーター

homeAccountId

string

返品

buildStaticAuthorityOptions(Partial<AuthorityOptions>)

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

パラメーター

authOptions

Partial<AuthorityOptions>

返品

buildTenantProfile(string, string, string, TokenClaims)

テナント プロファイルをビルドする

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

パラメーター

homeAccountId

string

このアカウント オブジェクトのホーム アカウント識別子

localAccountId

string

このアカウント オブジェクトのローカル アカウント識別子

tenantId

string

このアカウントが属する完全なテナントまたは組織 ID

idTokenClaims
TokenClaims

ID トークンからの要求

返品

createAuthError(string, string)

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

パラメーター

code

string

additionalMessage

string

返品

createCacheError(unknown)

CacheError オブジェクトでブラウザー エラーをラップするヘルパー関数

function createCacheError(e: unknown): CacheError

パラメーター

e

unknown

返品

createClientAuthError(string, string)

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

パラメーター

errorCode

string

additionalMessage

string

返品

createClientConfigurationError(string)

function createClientConfigurationError(errorCode: string): ClientConfigurationError

パラメーター

errorCode

string

返品

createInteractionRequiredAuthError(string)

InteractionRequiredAuthError を作成します

function createInteractionRequiredAuthError(errorCode: string): InteractionRequiredAuthError

パラメーター

errorCode

string

返品

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

失敗したネットワーク要求の NetworkError オブジェクトを作成します

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

パラメーター

error
AuthError

呼び出し元にスローされるエラー

httpStatus

number

ネットワーク要求の状態コード

responseHeaders

Record<string, string>

ネットワーク要求の応答ヘッダー (使用可能な場合)

additionalError

Error

返品

NetworkError オブジェクト

formatAuthorityUri(string)

function formatAuthorityUri(authorityUri: string): string

パラメーター

authorityUri

string

返品

string

getRequestThumbprint(string, BaseAuthRequest, string)

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

パラメーター

clientId

string

request
BaseAuthRequest
homeAccountId

string

返品

getTenantIdFromIdTokenClaims(TokenClaims)

使用可能な ID トークン要求から tenantId を取得し、次の優先順位で資格情報領域として設定します。

  1. tid - トークンがAzure AD テナントから取得された場合、tid が存在します
  2. tfp - トークンが最新の B2C テナントから取得された場合、tfp が存在する必要があります
  3. acr - レガシ B2C テナントからトークンが取得された場合、領域の大文字と小文字を区別しない比較要件に合わせて Downcased を提示する必要があります
function getTenantIdFromIdTokenClaims(idTokenClaims?: TokenClaims): string | null

パラメーター

idTokenClaims
TokenClaims

返品

string | null

tenantIdMatchesHomeTenant(string, string)

tenantId が homeAccountId の utid 部分と一致する場合は true を返します。

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

パラメーター

tenantId

string

homeAccountId

string

返品

boolean

updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)

渡された ID トークン要求から取得されたテナント プロファイルによって異なるアカウント情報を、テナント固有のアカウント情報に置き換えます

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

パラメーター

baseAccountInfo
AccountInfo
tenantProfile
TenantProfile
idTokenClaims
TokenClaims
idTokenSecret

string

返品

変数の詳細

AADAuthorityConstants

AAD 機関に関連する文字列定数

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

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

AuthenticationScheme

認証要求の種類

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

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

AuthorityType

MSAL でサポートされる権限の種類。

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

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

{ 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

キャッシュ内のアカウントの種類

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

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

CacheOutcome

ID プロバイダーからアクセス トークンをフェッチする理由を指定します

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

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

CacheType

すべてのキャッシュの種類を結合する

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

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

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

ClaimsRequestKeys

要求キー

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

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

CredentialType

キャッシュに格納されている資格情報の種類

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

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

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

GrantType

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

{ 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

要求ヘッダー名

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

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

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

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

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

OAuthResponseType

response_typeに使用できる値

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

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

PasswordGrantConstants

パスワード付与パラメーター

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

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

PersistentCacheKeys

ユーザーのログイン中に保持される永続的キャッシュ キー MSAL。

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

{ ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }

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

ServerResponseType

警告

この API は非推奨になりました。

Use ResponseMode instead

サーバー応答の種類に使用できる値

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

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

CodeChallengeMethodValues

codeVerifier に使用できる値

CodeChallengeMethodValues: { PLAIN: string, S256: string }

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

{ 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

DEFAULT_SYSTEM_OPTIONS

DEFAULT_SYSTEM_OPTIONS: Required<SystemOptions>

Required<SystemOptions>

DEFAULT_TOKEN_RENEWAL_OFFSET_SEC

DEFAULT_TOKEN_RENEWAL_OFFSET_SEC: 300

300

Errors

Errors: { CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }

{ CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }

IntFields

IntFields: ReadonlySet<string>

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

OIDC_DEFAULT_SCOPES

OIDC_DEFAULT_SCOPES: string[]

string[]

ONE_DAY_IN_MS

ONE_DAY_IN_MS: 86400000

86400000

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 }

StubbedNetworkModule

StubbedNetworkModule: INetworkModule

THE_FAMILY_ID

THE_FAMILY_ID: "1"

"1"

ThrottlingConstants

調整に関連する定数

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

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

"15.17.0"