@azure/msal-common package

클래스

AuthError

MSAL.js 라이브러리에서 throw된 일반 오류 클래스입니다.

AuthenticationHeaderParser

지원되는 HTTP 응답 인증 헤더를 구문 분석하여 기본 권한 부여 흐름 외부에서 사용할 수 있는 헤더 챌린지 값을 추출하고 반환하는 도우미 클래스입니다.

CacheError

캐시에 오류가 있을 때 발생하는 오류

ClientAuthError

브라우저에서 실행되는 클라이언트 코드에 오류가 있을 때 오류가 발생합니다.

ClientConfigurationError

MSAL.js 라이브러리 구성에 오류가 있을 때 오류가 발생합니다.

InteractionRequiredAuthError

사용자 상호 작용이 필요할 때 오류가 발생합니다.

Logger

특정 위치에 대한 메시지 로깅을 용이하게 하는 클래스입니다.

NetworkError

네트워크 관련 오류를 나타냅니다.

PerformanceClient
PlatformBrokerError

자세한 broker 정보를 유지하는 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

다음 서명이 있는 계정 개체:

  • homeAccountId - 이 계정 개체의 홈 계정 식별자
  • environment - 발급자의 도메인이 나타내는 토큰을 발급한 엔터티(예: login.microsoftonline.com)
  • tenantId - 이 계정이 속한 전체 테넌트 또는 조직 ID
  • 사용자 이름 - 이 계정을 나타내는 id_token preferred_username 클레임
  • localAccountId - 이 계정 개체에 대한 로컬 테넌트별 계정 identifer(일반적으로 레거시 사례에 사용됨)
  • name - 계정의 전체 이름(지정된 이름 및 가족 이름 포함)
  • idToken - 원시 ID 토큰
  • idTokenClaims - 개체에 ID 토큰의 클레임이 포함되어 있습니다.
  • nativeAccountId - 사용자의 네이티브 계정 ID
  • tenantProfiles - 계정이 브라우저에서 인증한 각 테넌트에 대한 테넌트 프로필 개체의 맵
  • dataBoundary - clientInfo에서 추출된 데이터 경계
ActiveAccountFilters
AppMetadataEntity

앱 메타데이터 캐시 유형

ApplicationTelemetry

요청에 따라 전송된 원격 분석 정보

  • appName: 애플리케이션의 고유 문자열 이름
  • appVersion: MSAL을 사용하는 애플리케이션 버전
AuthenticationResult

권한의 토큰 엔드포인트에서 반환된 결과입니다.

  • uniqueId - oid 또는 sub ID 토큰에서 클레임
  • tenantId - tid ID 토큰에서 클레임
  • 범위 - 각 토큰에 대해 유효성이 검사되는 범위
  • 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 - MSAL이 토큰을 획득할 기관, STS(보안 토큰 서비스)의 URL입니다. 기본값은 https://login.microsoftonline.com/common입니다. 모든 요청에 동일한 권한을 사용하는 경우 권한 엔드포인트를 여러 번 해결하지 않으려면 요청이 아닌 클라이언트 애플리케이션 개체에 대해 권한을 설정해야 합니다.
  • correlationId - 원격 분석을 위해 종단 간 요청을 추적하기 위해 요청당 고유한 GUID 집합입니다.
  • 범위 - 애플리케이션이 액세스를 요청하는 범위의 배열입니다.
  • authenticationScheme - 검색된 토큰의 유형입니다. 기본값은 "Bearer"입니다. "pop" 또는 "SSH" 형식일 수도 있습니다.
  • claims - 모든 /authorize 및 /token 호출에 추가될 문자열화된 클레임 요청
  • shrClaims - 서명된 HTTP 요청에 추가될 문자열화된 클레임 개체입니다.
  • shrNonce - 서명된 HTTP 요청에 추가될 암호화되고 base64URL로 인코딩된 서버 생성 타임스탬프입니다.
  • shrOptions - 서명된 HTTP 요청에 대한 옵션을 포함하는 개체입니다.
  • resourceRequestMethod - 리소스에서 데이터를 요청하는 데 사용되는 HTTP 요청 유형입니다(예: "GET", "POST" 등). 소유 증명 흐름에 사용됩니다.
  • resourceRequestUri - 토큰이 사용될 URI입니다. 소유 증명 흐름에 사용됩니다.
  • sshJwk - SSH 인증서로 서명할 수 있는 공개 키를 나타내는 문자열화된 JSON 웹 키입니다.
  • sshKid - 위에서 언급한 SSH 공개 키를 고유하게 식별하는 키 ID입니다.
  • azureCloudOptions - 사용자가 퍼블릭/소버린 클라우드 ID를 제공할 수 있는 편리한 문자열 열거형
  • requestedClaimsHash - 요청된 클레임 문자열의 SHA 256 해시 문자열로, 요청된 클레임으로 토큰을 필터링할 수 있도록 액세스 토큰 캐시 키의 일부로 사용됩니다.
  • tokenQueryParameters - 문자열에서 /token 호출에 추가된 사용자 지정 쿼리 매개 변수의 문자열 맵
  • tokenBodyParameters - /token call의 본문에 추가된 사용자 지정 매개 변수의 문자열 맵에 문자열
  • storeInCache - 캐시에 토큰을 저장할지 여부를 나타내는 부울 값을 포함하는 개체입니다(기본값은 true).
  • scenarioId - 사용자 지정 사용자 프롬프트를 추적하는 시나리오 ID
  • popKid - PoP 토큰 요청에 대한 공개 키를 식별하는 키 ID
  • embeddedClientId - 포함된 클라이언트 ID입니다. 지정된 경우 broker 클라이언트 ID(brk_client_id) 및 리디렉션 URI(brk_redirect_uri) 매개 변수가 구성의 값으로 설정되고, 있는 경우 해당 추가 매개 변수를 재정의합니다.
  • httpMethod - /authorize 요청에 사용할 HTTP 메서드입니다. 기본값은 GET이지만 요청에 본문 매개 변수가 필요한 경우 POST로 설정할 수 있습니다.
  • authorizePostBodyParameters - httpMethod가 POST로 설정된 경우 /authorize 호출의 본문에 추가된 사용자 지정 매개 변수의 문자열 맵에 문자열
  • skipBrokerClaims - true이고 조정된 흐름이 사용되는 경우(예: broker 매개 변수 또는 embeddedClientId가 있는 경우) 구성의 clientCapabilities는 클레임에서 제외됩니다. 는 조정되지 않은 흐름에 대해 무시됩니다.
CacheOptions

ClientConfiguration 개체에서 자격 증명 캐시 기본 설정을 구성하는 데 사용합니다.

  • claimsBasedCachingEnabled - 클레임 해시에 따라 토큰을 캐시해야 하는지 여부를 설정합니다. 기본값은 false입니다.
CcsCredential
ClientInfo

uid: 사용자 ID utid: 테넌트 ID xms_tdbr: 선택 사항으로 구성된 클라이언트 정보 개체이며, 미국 이외의 테넌트에 대해서만

CommonAuthorizationCodeRequest

유효한 권한 부여 코드를 교환하는 서버에서 토큰을 획득하기 위해 사용자가 전달한 요청 개체(OAuth2.0 권한 부여 코드 흐름의 두 번째 다리)

  • 범위 - 애플리케이션이 액세스를 요청하는 범위의 배열입니다.
  • claims - 모든 /authorize 및 /token 호출에 추가될 문자열화된 클레임 요청
  • authority: - MSAL이 토큰을 획득할 기관, STS(보안 토큰 서비스)의 URL입니다. 클라이언트 애플리케이션 개체에 권한이 설정되면 해당 값이 재정의됩니다. 값을 재정의하면 매번 기관 유효성 검사가 수행됩니다. 모든 요청에 동일한 권한을 사용하는 경우 요청 대신 애플리케이션 개체에 설정합니다.
  • 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

서버에서 코드를 검색하기 위해 사용자가 전달한 요청 개체(권한 부여 코드 부여 흐름의 첫 번째 다리)

  • 범위 - 애플리케이션이 액세스를 요청하는 범위의 배열입니다.
  • claims - 모든 /authorize 및 /token 호출에 추가될 문자열화된 클레임 요청
  • authority - 애플리케이션이 토큰을 획득하는 권한의 URL입니다.
  • correlationId - 원격 분석을 위해 종단 간 요청을 추적하기 위해 요청당 고유한 GUID 집합입니다.
  • redirectUri - 애플리케이션에서 인증 응답을 받을 수 있는 리디렉션 URI입니다. Azure 포털에 등록된 리디렉션 URI 중 하나와 정확히 일치해야 합니다.
  • extraScopesToConsent - 사용자가 동의가 선행되어야 하는 경우 다른 리소스에 대한 범위입니다.
  • responseMode - 앱에 인증 결과를 보내는 데 사용해야 하는 메서드를 지정합니다. 쿼리, form_post 또는 조각일 수 있습니다. 값이 전달되지 않으면 기본적으로 쿼리가 사용됩니다.
  • codeChallenge - PKCE(코드 Exchange 키 증명)를 통해 권한 부여 코드 부여를 보호하는 데 사용됩니다. 자세한 내용은 PKCE RCF를 참조하세요.https://tools.ietf.org/html/rfc7636
  • codeChallengeMethod - 코드 챌린지 매개 변수에 대한 코드 검증 도구를 인코딩하는 데 사용되는 메서드입니다. "일반" 또는 "S256"일 수 있습니다. 제외되는 경우 코드 챌린지는 일반 텍스트로 간주됩니다. 자세한 내용은 PKCE RCF를 참조하세요. https://tools.ietf.org/html/rfc7636
  • state - 토큰 응답에도 반환되는 요청에 포함된 값입니다. 임의로 생성된 고유 값은 일반적으로 교차 사이트 요청 위조 공격을 방지하는 데 사용됩니다. 상태는 인증 요청이 발생하기 전에 앱에서 사용자의 상태에 대한 정보를 인코딩하는 데도 사용됩니다.
  • prompt - 필요한 사용자 상호 작용 유형을 나타냅니다. 로그인: 사용자가 해당 요청에 자격 증명을 입력하도록 강제하여 Single Sign-On 없음을 부정합니다. 그러면 사용자에게 대화형 프롬프트가 표시되지 않습니다. Single Sign-On을 통해 요청을 완료할 수 없는 경우 엔드포인트는 interaction_required 오류 동의를 반환합니다. 사용자가 로그인한 후 OAuth 동의 대화 상자를 트리거하여 사용자에게 앱 select_account 권한을 부여하도록 요청합니다. 세션의 모든 계정 또는 기억된 계정 또는 다른 계정 만들기를 사용하도록 선택하는 옵션을 나열하는 계정 선택 환경을 제공하는 Single Sign-=On을 중단합니다. 는 사용자를 인증할 때 기존 세션 토큰을 읽지 않는 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 토큰
  • 상태 - 로그아웃 후 리디렉션 시 쿼리 문자열에 반환되는 로그아웃 엔드포인트에 대한 요청에 포함된 값입니다.
  • logoutHint - 로그아웃할 때 서버 계정 선택기를 건너뛰기 위해 로그아웃 중인 계정을 지정하는 문자열입니다.
  • extraQueryParameters - /authorize 호출에 추가된 사용자 지정 쿼리 매개 변수의 문자열 맵에 문자열
CommonRefreshTokenRequest

CommonRefreshTokenRequest

  • 범위 - 애플리케이션이 액세스를 요청하는 범위의 배열입니다.
  • claims - 모든 /authorize 및 /token 호출에 추가될 문자열화된 클레임 요청
  • authority - MSAL이 토큰을 획득할 기관, STS(보안 토큰 서비스)의 URL입니다.
  • correlationId - 원격 분석을 위해 종단 간 요청을 추적하기 위해 요청당 고유한 GUID 집합입니다.
  • refreshToken - 이전 요청에서 ID 공급자로 반환된 새로 고침 토큰입니다.
  • resourceRequestMethod - 리소스에서 데이터를 요청하는 데 사용되는 HTTP 요청 유형입니다(예: "GET", "POST" 등). 소유 증명 흐름에 사용됩니다.
  • resourceRequestUri - 토큰이 사용될 URI입니다. 소유 증명 흐름에 사용됩니다.
  • forceCache - 캐시에 계정이 없는 경우 MSAL이 새로 고침 토큰 흐름 응답을 캐시하도록 합니다. 마이그레이션 시나리오에 사용됩니다.
  • tokenQueryParameters - 문자열에서 /token 호출에 추가된 사용자 지정 쿼리 매개 변수의 문자열 맵
CommonSilentFlowRequest

사용자가 자격 증명을 자동으로 검색하기 위해 전달한 SilentFlow 매개 변수

  • 범위 - 애플리케이션이 액세스를 요청하는 범위의 배열입니다.
  • 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: 토큰 형식 값을 나타냅니다. Azure AD에서 지원하는 유일한 형식은 Bearer입니다.
  • 범위: access_token 유효한 범위입니다.
  • expires_in: 액세스 토큰이 유효한 기간(초)입니다.
  • id_token: JWT(JSON 웹 토큰)입니다. 앱에서 이 토큰의 세그먼트를 디코딩하여 로그인한 사용자에 대한 정보를 요청할 수 있습니다.
  • refresh_token: OAuth 2.0 새로 고침 토큰입니다. 앱은 현재 액세스 토큰이 만료된 후 이 토큰을 사용하여 추가 액세스 토큰을 획득할 수 있습니다.
  • access_token: 요청된 액세스 토큰입니다. 앱에서 이 토큰을 사용하여 보안 리소스(예: 웹 API)를 인증할 수 있습니다.
  • client_info: 클라이언트 정보 개체
IdTokenEntity

ID 토큰 캐시 유형

InProgressPerformanceEvent
LibraryStateObject

상태 값으로 문자열화, 인코딩 및 전송되는 개체를 정의하는 형식입니다. 다음을 포함합니다.

  • id - 이 요청에 대한 고유 식별자
  • ts - 요청이 만들어진 시간에 대한 타임스탬프입니다. 토큰 만료가 잘못 계산되지 않도록 하는 데 사용됩니다.
  • platformState - 플랫폼에서 전송된 문자열 값입니다.
LoggerOptions

Configuration 개체에서 로거 옵션을 구성하여 MSAL이 수행하는 로깅을 구성하는 데 사용합니다.

  • loggerCallback - 로거에 대한 콜백
  • piiLoggingEnabled - pii 로깅을 사용할 수 있는지 여부를 설정합니다.
  • logLevel - 로깅이 발생하는 수준 설정
  • correlationId - 로거가 인쇄한 correlationId를 설정합니다.
NetworkRequestOptions

네트워크 요청 API에서 허용하는 옵션입니다.

NetworkResponse
OIDCOptions

OIDC 프로토콜 모드에 대한 옵션입니다.

PerformanceCallbackFunction
PerformanceEvent

요청 및 애플리케이션에 대한 메타데이터를 포함하여 라이브러리에서 수행한 성능 측정입니다.

PkceCodes

PkceCodes 형식은 PKCE 코드 챌린지 및 검증 도구 쌍을 포함하는 개체의 구조를 설명합니다.

QueueMeasurement

큐 측정 유형

RefreshTokenEntity

새로 고침 토큰 캐시 유형

RequestStateObject

권한 부여 요청에서 서비스로 전송되는 문자열화되고 인코딩된 개체를 정의하는 형식입니다.

RequestThumbprint

고유한 요청 지문을 나타내는 형식입니다.

ServerAuthorizationTokenResponse

서버 권한 부여 코드 요청에서 역직렬화된 응답 개체입니다.

  • token_type: 토큰 형식 값을 나타냅니다. 전달자 또는 팝일 수 있습니다.
  • 범위: access_token 유효한 범위입니다.
  • expires_in: 액세스 토큰이 유효한 기간(초)입니다.
  • refresh_in: 만료와 관계없이 토큰을 갱신해야 하는 기간을 유추합니다.
  • ext_expires_in: 서버가 응답하지 않는 경우 액세스 토큰이 유효한 기간(초)입니다.
  • access_token: 요청된 액세스 토큰입니다. 앱에서 이 토큰을 사용하여 보안 리소스(예: 웹 API)를 인증할 수 있습니다.
  • refresh_token: OAuth 2.0 새로 고침 토큰입니다. 앱은 현재 액세스 토큰이 만료된 후 이 토큰을 사용하여 추가 액세스 토큰을 획득할 수 있습니다.
  • id_token: JWT(JSON 웹 토큰)입니다. 앱에서 이 토큰의 세그먼트를 디코딩하여 로그인한 사용자에 대한 정보를 요청할 수 있습니다.
  • key_id: 요청이 바인딩된 공개 키를 고유하게 식별하는 문자열입니다.

오류 발생 시:

  • 오류: 발생하는 오류 유형을 분류하는 데 사용할 수 있고 오류에 대응하는 데 사용할 수 있는 오류 코드 문자열입니다.
  • error_description: 개발자가 인증 오류의 근본 원인을 식별하는 데 도움이 되는 특정 오류 메시지입니다.
  • error_codes: 진단에 도움이 될 수 있는 STS 관련 오류 코드 목록입니다.
  • timestamp: 오류가 발생한 시간입니다.
  • trace_id: 진단에 도움이 될 수 있는 요청에 대한 고유 식별자입니다.
  • correlation_id: 구성 요소 간 진단에 도움이 될 수 있는 요청에 대한 고유 식별자입니다.
  • 상태: 네트워크 요청의 응답 상태
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
  • 범위 - 토큰을 제공해야 하는 범위
  • 클레임 - 토큰이 충족해야 하는 추가 클레임
AppTokenProviderResult

IAppTokenProvider 확장성에 대한 출력 개체입니다.

  • accessToken - 요청 데이터 AppTokenProviderParameters를 충족하는 실제 액세스 토큰(일반적으로 JWT 형식)입니다.
  • expiresInSeconds - 토큰이 만료되기 전까지의 기간(초)입니다. AAD 토큰 응답의 "expires_in" 필드와 유사합니다.
  • refreshInSeconds - 토큰을 사전에 새로 고쳐야 하는 기간입니다. AAD 토큰 응답의 "refresh_in" 필드와 유사합니다.
ClientAssertion

기밀 클라이언트에 대한 클라이언트 어설션 자격 증명

ClientAssertionCallback
ClientAssertionConfig
CommonClientCredentialRequest

CommonClientCredentialRequest

  • 범위 - 애플리케이션이 액세스를 요청하는 범위의 배열입니다.
  • authority - MSAL이 토큰을 획득할 기관, STS(보안 토큰 서비스)의 URL입니다.
  • correlationId - 원격 분석을 위해 종단 간 요청을 추적하기 위해 요청당 고유한 GUID 집합입니다.
  • skipCache - 토큰 캐시 조회를 건너뛰고 권한을 강제로 요청하여 새 토큰을 가져옵니다. 기본값은 false입니다.
  • preferredAzureRegionOptions - 사용자가 선호하는 Azure 지역의 옵션
  • tokenQueryParameters - 문자열에서 /token 호출에 추가된 사용자 지정 쿼리 매개 변수의 문자열 맵
CommonDeviceCodeRequest

Oauth2 디바이스 코드 흐름에 대한 매개 변수입니다.

  • 범위 - 애플리케이션이 액세스를 요청하는 범위의 배열입니다.
  • authority: - MSAL이 토큰을 획득할 기관, STS(보안 토큰 서비스)의 URL입니다. 클라이언트 애플리케이션 개체에 권한이 설정되면 해당 값이 재정의됩니다. 값을 재정의하면 매번 기관 유효성 검사가 수행됩니다. 모든 요청에 동일한 권한을 사용하는 경우 요청 대신 애플리케이션 개체에 설정합니다.
  • correlationId - 원격 분석을 위해 종단 간 요청을 추적하기 위해 요청당 고유한 GUID 집합입니다.
  • deviceCodeCallback - 디바이스 코드 응답을 포함하는 콜백입니다. 최종 사용자에게 메시지가 표시되어야 합니다. 그런 다음 최종 사용자는 verification_uri 이동하여 user_code 입력하고 자격 증명을 입력할 수 있습니다.
  • cancel - 디바이스 코드 엔드포인트의 폴링을 취소하려면 부울입니다. 사용자가 별도의 디바이스에서 인증하는 동안 MSAL은 디바이스 코드 응답에 지정된 간격(일반적으로 15분)에 대한 보안 토큰 서비스의 토큰 엔드포인트를 폴링합니다. 폴링을 중지하고 요청을 취소하려면 cancel=true를 설정합니다.
  • resourceRequestMethod - 리소스에서 데이터를 요청하는 데 사용되는 HTTP 요청 유형입니다(예: "GET", "POST" 등). 소유 증명 흐름에 사용됩니다.
  • resourceRequestUri - 토큰이 사용될 URI입니다. 소유 증명 흐름에 사용됩니다.
  • timeout - 사용자가 디바이스 코드 엔드포인트 폴링에 대해 명시적으로 구성하는 시간 제한 기간(초)입니다. 이 기간이 끝나면 디바이스 코드가 아직 만료되지 않았다고 가정합니다. 디바이스 코드 폴링이 중지되고 요청이 취소됩니다. 디바이스 코드 만료 기간은 항상 이 설정 기간보다 우선합니다.
  • extraQueryParameters - 쿼리 문자열에 추가된 사용자 지정 쿼리 매개 변수의 문자열 맵에 문자열
CommonOnBehalfOfRequest
  • 범위 - 애플리케이션이 액세스를 요청하는 범위의 배열입니다.
  • authority - MSAL이 토큰을 획득할 기관, STS(보안 토큰 서비스)의 URL입니다.
  • correlationId - 원격 분석을 위해 종단 간 요청을 추적하기 위해 요청당 고유한 GUID 집합입니다.
  • oboAssertion - 중간 계층 API로 전송된 액세스 토큰입니다. 이 토큰에는 이 OBO 요청을 만드는 앱의 대상이 있어야 합니다.
  • skipCache - 토큰 캐시 조회를 건너뛰고 권한을 강제로 요청하여 새 토큰을 가져옵니다. 기본값은 false입니다.
  • tokenQueryParameters - 문자열에서 /token 호출에 추가된 사용자 지정 쿼리 매개 변수의 문자열 맵
CommonUsernamePasswordRequest

사용자가 자격 증명을 검색하기 위해 전달한 CommonUsernamePassword 매개 변수 참고: 최신 OAuth 2.0 보안 모범 사례는 암호 부여를 완전히 허용하지 않습니다. 이 흐름은 내부 테스트를 위해 추가됩니다.

  • 범위 - 애플리케이션이 액세스를 요청하는 범위의 배열입니다.
  • claims - 모든 /authorize 및 /token 호출에 추가될 문자열화된 클레임 요청입니다. 자동 요청에 포함되면 캐시 조회를 건너뛰고 토큰이 새로 고쳐집니다.
  • authority - 애플리케이션이 토큰을 획득하는 권한의 URL입니다.
  • correlationId - 원격 분석을 위해 종단 간 요청을 추적하기 위해 요청당 고유한 GUID 집합입니다.
  • 사용자 이름 - 클라이언트의 사용자 이름
  • password - 자격 증명
  • 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)

server 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 테넌트 acr에서 토큰을 획득하는 경우 대/소문자를 구분하지 않는 비교 요구 사항과 일치하도록 다운케이스가 있어야 합니다.
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

허용되는 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

문자열 대신 요청에서 이 "열거형"을 만드는 것을 고려했습니다. 그러나 허용된 프롬프트 값 목록이 지난 몇 년 동안 계속 변경된 것처럼 보입니다. 일부 내부 파트너도 문서화되지 않은 프롬프트 값이 있으므로 "열거형" 대신 제네릭 "문자열" 형식을 선택합니다.

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)

server 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

이 계정 개체에 대한 로컬 계정 identifer

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

호출자에게 다시 throw되는 오류

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 테넌트 acr에서 토큰을 획득하는 경우 대/소문자를 구분하지 않는 비교 요구 사항과 일치하도록 다운케이스가 있어야 합니다.
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

허용되는 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

문자열 대신 요청에서 이 "열거형"을 만드는 것을 고려했습니다. 그러나 허용된 프롬프트 값 목록이 지난 몇 년 동안 계속 변경된 것처럼 보입니다. 일부 내부 파트너도 문서화되지 않은 프롬프트 값이 있으므로 "열거형" 대신 제네릭 "문자열" 형식을 선택합니다.

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"