@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 オブジェクト:
|
| ActiveAccountFilters | |
| AppMetadataEntity |
アプリ メタデータ キャッシュの種類 |
| ApplicationTelemetry |
要求時に送信されるテレメトリ情報
|
| AuthenticationResult |
機関のトークン エンドポイントから返される結果。
|
| AuthorityOptions | |
| AuthorizationCodePayload |
コード応答クエリ文字列またはフラグメントの処理後に返される応答。 |
| AuthorizeResponse |
/authorize エンドポイントによって返される可能性がある応答プロパティ |
| AzureCloudOptions |
AzureCloudInstance 固有のオプション
|
| AzureRegion | |
| AzureRegionConfiguration | |
| BaseAuthRequest |
BaseAuthRequest
|
| CacheOptions |
これを使用して、ClientConfiguration オブジェクトで資格情報キャッシュの基本設定を構成します
|
| CcsCredential | |
| ClientInfo |
次で構成されるクライアント情報オブジェクト: uid: user id utid: tenant id xms_tdbr: optional, only for non-US tenants |
| CommonAuthorizationCodeRequest |
有効な承認コードを交換するサーバーからトークンを取得するようにユーザーが渡したオブジェクトを要求する (OAuth2.0 承認コード フローの第 2 段階)
|
| CommonAuthorizationUrlRequest |
サーバーからコードを取得するためにユーザーによって渡されたオブジェクトを要求する (承認コード付与フローの最初の区間)
|
| CommonEndSessionRequest |
CommonEndSessionRequest
|
| CommonRefreshTokenRequest |
CommonRefreshTokenRequest
|
| CommonSilentFlowRequest |
ユーザーが資格情報をサイレントモードで取得するために渡される SilentFlow パラメーター
|
| CredentialEntity |
資格情報キャッシュの種類 |
| CredentialFilter |
資格情報: <home_account_id*>-<environment>-<credential_type>-<client_id>-<realm*>-<target*>-<scheme*> |
| ExternalTokenResponse |
キャッシュする外部トークンの読み込みに使用される応答オブジェクト。
|
| IdTokenEntity |
ID トークン キャッシュの種類 |
| InProgressPerformanceEvent | |
| LibraryStateObject |
文字列化され、エンコードされ、状態値で送信されるオブジェクトを定義する型。 次のものが含まれます。
|
| LoggerOptions |
これを使用して、構成オブジェクトでロガー オプションを構成することで、MSAL が行うログ記録を構成します。
|
| NetworkRequestOptions |
ネットワーク要求 API で許可されるオプション。 |
| NetworkResponse | |
| OIDCOptions |
OIDC プロトコル モードのオプション。 |
| PerformanceCallbackFunction | |
| PerformanceEvent |
要求とアプリケーションに関するメタデータを含む、ライブラリによって取得されたパフォーマンス測定。 |
| PkceCodes |
PkceCodes 型は、PKCE コード チャレンジと検証ツールのペアを含むオブジェクトの構造を記述します |
| QueueMeasurement |
キュー測定の種類 |
| RefreshTokenEntity |
更新トークン キャッシュの種類 |
| RequestStateObject |
承認要求でサービスに送信される文字列化およびエンコードされたオブジェクトを定義する型。 |
| RequestThumbprint |
一意の要求の拇印を表す型。 |
| ServerAuthorizationTokenResponse |
サーバー承認コード要求から逆シリアル化された応答オブジェクト。
エラーが発生した場合:
|
| ServerTelemetryEntity | |
| ServerTelemetryRequest | |
| ShrOptions | |
| SignedHttpRequest | |
| SignedHttpRequestParameters | |
| StaticAuthorityOptions | |
| StoreInCache |
トークンをキャッシュに格納するかどうかを制御します。 false に設定した場合、トークンは引き続き取得されて返される可能性がありますが、後で取得するためにキャッシュされることはありません。 |
| StringDict |
queryParams、extraQueryParams、要求をサポートする型を Key-Value する |
| SubMeasurement | |
| SystemOptions |
これを使用して、Configuration オブジェクトでトークンの更新情報を構成します
|
| TenantProfile |
同じユーザーのテナントによって異なるアカウントの詳細 |
| ThrottlingEntity | |
| TokenClaims |
MSAL によって認識される ID トークン要求を記述する型。 |
| TokenKeys | |
| AppTokenProviderParameters |
IAppTokenProvider 拡張機能の入力オブジェクト。 MSAL によってこのオブジェクトが作成されます。このオブジェクトは、AppTokenProviderResult の作成に使用できます。
|
| AppTokenProviderResult |
IAppTokenProvider 拡張機能の出力オブジェクト。
|
| ClientAssertion |
機密クライアントのクライアント アサーション資格情報 |
| ClientAssertionCallback | |
| ClientAssertionConfig | |
| CommonClientCredentialRequest |
CommonClientCredentialRequest
|
| CommonDeviceCodeRequest |
Oauth2 デバイス コード フローのパラメーター。
|
| CommonOnBehalfOfRequest |
|
| CommonUsernamePasswordRequest |
資格情報を取得するためにユーザーによって渡される CommonUsernamePassword パラメーター注: 最新の OAuth 2.0 Security Best Current Practice では、パスワードの許可が完全に禁止されます。 このフローは、内部テスト用に追加されます。
|
| DeviceCodeResponse |
デバイス コード フローに必要な情報を含む、セキュリティ トークン サービスのデバイス コード エンドポイントによって返される DeviceCode。
|
| NativeRequest | |
| NativeSignOutRequest | |
| ServerDeviceCodeResponse | |
列挙型
| LogLevel |
ログ メッセージ レベル。 |
| PerformanceEventStatus |
パフォーマンス イベントの状態。 |
| PerformanceEvents |
インストルメント化された操作の列挙には、PerformanceClient によってパフォーマンスが測定されます。 |
関数
変数
| AADAuthority |
AAD 機関に関連する文字列定数 |
| Authentication |
認証要求の種類 |
| Authority |
MSAL でサポートされる権限の種類。 |
| Azure |
|
| Cache |
キャッシュ内のアカウントの種類 |
| Cache |
ID プロバイダーからアクセス トークンをフェッチする理由を指定します |
| Cache |
すべてのキャッシュの種類を結合する |
| Ccs |
|
| Claims |
要求キー |
| Credential |
キャッシュに格納されている資格情報の種類 |
| Encoding |
|
| Grant |
allowed grant_type |
| Header |
要求ヘッダー名 |
| Http |
|
| Http |
|
| Json |
|
| OAuth |
response_typeに使用できる値 |
| Password |
パスワード付与パラメーター |
| Persistent |
ユーザーのログイン中に保持される永続的キャッシュ キー MSAL。 |
| Protocol |
MSAL でサポートされているプロトコル モード。 |
| Response |
response_modeに使用できる値 |
| Server |
サーバー応答の種類に使用できる値 |
| Auth |
エラー コードとメッセージで使用される文字列定数を含む AuthErrorMessage クラス。 |
| Client |
エラー コードとメッセージで使用される文字列定数。 |
| Client |
エラー コードとメッセージで使用される文字列定数を含む ClientConfigurationErrorMessage クラス。 |
| Code |
codeVerifier に使用できる値 |
| Constants | |
| DEFAULT_CRYPTO_IMPLEMENTATION | |
| DEFAULT_SYSTEM_OPTIONS | |
| DEFAULT_TOKEN_RENEWAL_OFFSET_SEC | |
| Errors | |
| Int |
|
| Interaction |
SDK によって定義された相互作用が必要なエラー |
| OIDC_DEFAULT_SCOPES | |
| ONE_DAY_IN_MS | |
| Prompt |
文字列ではなく要求でこの "enum" を作成することを検討しました。ただし、プロンプト値の許可されたリストは、過去数年間にわたって変化し続けているようです。 一部の内部パートナーには文書化されていないプロンプト値もあります。そのため、"enum" ではなくジェネリック "string" 型を選択します |
| Stubbed |
|
| THE_FAMILY_ID | |
| Throttling |
調整に関連する定数 |
| 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 を取得し、次の優先順位で資格情報領域として設定します。
- tid - トークンがAzure AD テナントから取得された場合、tid が存在します
- tfp - トークンが最新の B2C テナントから取得された場合、tfp が存在する必要があります
- 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_SYSTEM_OPTIONS
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
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"