CustomAuthPublicClientApplication class

지정된 구성 및 컨트롤러를 사용하여 PublicClientApplication의 새 인스턴스를 만들어 네이티브 인증 흐름을 시작합니다.

static function create(config: CustomAuthConfiguration): Promise<ICustomAuthPublicClientApplication>

매개 변수

반품

• CustomAuthPublicClientApplication 인스턴스로 확인되는 약속

브라우저 캐시에서 현재 계정을 가져옵니다.

function getCurrentAccount(accountRetrievalInputs?: CustomAuthActionInputs): GetAccountResult

매개 변수

반품

• 계정 가져오기 작업의 결과

암호 재설정 흐름을 시작합니다. 이 메서드는 암호 재설정을 완료하기 위한 추가 작업(코드 제출)을 트리거합니다. 예외가 throw된 경우 오류 세부 정보가 포함된 결과를 만듭니다.

function resetPassword(resetPasswordInputs: ResetPasswordInputs): Promise<ResetPasswordStartResult>

매개 변수

반품

• ResetPasswordStartResult로 확인되는 약속

로그인 흐름을 시작합니다. 이 메서드는 로그인을 완료하거나 로그인을 완료하는 데 필요한 추가 작업(암호, 코드 등)을 생성합니다. 예외가 throw된 경우 오류 세부 정보가 포함된 결과를 만듭니다.

function signIn(signInInputs: SignInInputs): Promise<SignInResult>

매개 변수

반품

• SignInResult로 확인되는 약속

등록 흐름을 시작합니다. 이 메서드는 등록을 완료하거나 등록을 완료하는 데 필요한 추가 작업(암호, 코드 등)을 생성합니다. 예외가 throw된 경우 오류 세부 정보가 포함된 결과를 만듭니다.

function signUp(signUpInputs: SignUpInputs): Promise<SignUpResult>

매개 변수

반품

• SignUpResult로 확인되는 약속

이 함수는 eSTS 토큰 엔드포인트에서 권한 부여 코드(코드로 전달됨)를 사용합니다. 이 권한 부여 코드는 기밀 클라이언트를 사용하여 서버 쪽을 획득하여 spa_code 획득해야 합니다. 이 API는 정상적인 권한 부여 코드 획득 및 상환을 위해 결정되지 않습니다.

이 권한 부여 코드의 상환에는 기밀 클라이언트가 획득했기 때문에 PKCE가 필요하지 않습니다.

function acquireTokenByCode(request: AuthorizationCodeRequest): Promise<AuthenticationResult>

매개 변수

반품

이 함수가 완료될 때 이행되거나 오류가 발생한 경우 거부되는 약속입니다.

상속된 개체 PublicClientApplication.acquireTokenByCode

사용자의 브라우저에서 팝업 창을 열어 API에 대한 access_token 가져오려는 경우에 사용합니다.

function acquireTokenPopup(request: PopupRequest): Promise<AuthenticationResult>

매개 변수

반품

이 함수가 완료될 때 이행되거나 오류가 발생한 경우 거부되는 약속입니다.

상속된 개체 PublicClientApplication.acquireTokenPopup

사용자의 브라우저 창을 권한 부여 엔드포인트로 리디렉션하여 API에 대한 access_token 가져오려는 경우에 사용합니다. 이 함수는 페이지를 리디렉션하므로 이 함수 다음에 오는 코드는 실행되지 않습니다.

중요: Promise의 해결에 종속된 코드는 사용하지 않는 것이 좋습니다. 이 함수는 현재 브라우저 창에서 멀리 이동합니다. 현재 이 함수에서 실행되는 코드의 비동기 특성을 반영하기 위해 Promise를 반환합니다.

function acquireTokenRedirect(request: RedirectRequest): Promise<void>

매개 변수

반품

상속된 개체 PublicClientApplication.acquireTokenRedirect

지정된 범위 집합에 대한 액세스 토큰을 자동으로 획득합니다. 병렬 요청이 이루어지면 현재 처리 중인 프라미스를 반환합니다.

function acquireTokenSilent(silentRequest: SilentRequest): Promise<AuthenticationResult>

매개 변수

반품

• 이 함수가 완료될 때 이행되거나 오류가 발생한 경우 거부되는 약속입니다. 개체를 AuthenticationResult 반환합니다.

상속된 개체 PublicClientApplication.acquireTokenSilent

배열에 이벤트 콜백 추가

function addEventCallback(callback: EventCallbackFunction, eventTypes?: EventType[]): null | string

매개 변수

반품

상속된 개체 PublicClientApplication.addEventCallback

성능 이벤트를 수신하도록 콜백을 등록합니다.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

매개 변수

반품

상속된 개체 PublicClientApplication.addPerformanceCallback

브라우저 캐시에서 토큰 및 계정을 지웁니다.

function clearCache(logoutRequest?: ClearCacheRequest): Promise<void>

매개 변수

반품

상속된 개체 PublicClientApplication.clearCache

StandardController를 만들고 PublicClientApplication에 전달합니다.

static function createPublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>

매개 변수

반품

상속된 개체 PublicClientApplication.createPublicClientApplication

다른 브라우저 탭 또는 창의 localstorage에서 사용자 계정이 추가되거나 제거될 때 이벤트를 내보내는 이벤트 수신기를 제거합니다.

function disableAccountStorageEvents()

상속된 개체 PublicClientApplication.disableAccountStorageEvents

다른 브라우저 탭 또는 창의 localstorage에서 사용자 계정을 추가하거나 제거할 때 이벤트를 내보내는 이벤트 수신기를 추가합니다.

function enableAccountStorageEvents()

상속된 개체 PublicClientApplication.enableAccountStorageEvents

전달된 계정 필터와 일치하는 캐시에 있는 첫 번째 계정을 반환합니다.

function getAccount(accountFilter: AccountFilter): null | AccountInfo

매개 변수

반품

제공된 필터와 일치하는 캐시에 있는 첫 번째 계정이거나, 계정을 찾을 수 없는 경우 null입니다.

상속된 개체 PublicClientApplication.getAccount

homeAccountId와 일치하는 로그인한 계정을 반환합니다. (성공적으로 로그인할 때 계정 개체가 생성됨) 또는 일치하는 계정을 찾을 수 없는 경우 null

function getAccountByHomeId(homeAccountId: string): null | AccountInfo

매개 변수

반품

MSAL에 저장된 계정 개체

상속된 개체 PublicClientApplication.getAccountByHomeId

localAccountId와 일치하는 로그인한 계정을 반환합니다. (성공적으로 로그인할 때 계정 개체가 생성됨) 또는 일치하는 계정을 찾을 수 없는 경우 null

function getAccountByLocalId(localId: string): null | AccountInfo

매개 변수

반품

MSAL에 저장된 계정 개체

상속된 개체 PublicClientApplication.getAccountByLocalId

사용자 이름과 일치하는 로그인한 계정을 반환합니다. (성공적으로 로그인할 때 계정 개체가 생성됨) 또는 일치하는 계정을 찾을 수 없는 경우 null입니다. 이 API는 편의를 위해 제공되지만 최상의 안정성을 위해 getAccountById를 사용해야 합니다.

function getAccountByUsername(userName: string): null | AccountInfo

매개 변수

반품

MSAL에 저장된 계정 개체

상속된 개체 PublicClientApplication.getAccountByUsername

현재 활성 계정을 가져옵니다.

function getActiveAccount(): null | AccountInfo

반품

상속된 개체 PublicClientApplication.getActiveAccount

선택적 필터와 일치하는 캐시의 모든 계정을 반환합니다. 필터가 제공되지 않으면 모든 계정이 반환됩니다.

function getAllAccounts(accountFilter?: AccountFilter): AccountInfo[]

매개 변수

반품

캐시에 있는 AccountInfo 개체의 배열

상속된 개체 PublicClientApplication.getAllAccounts

로거 인스턴스를 반환합니다.

function getLogger(): Logger

반품

상속된 개체 PublicClientApplication.getLogger

애플리케이션의 토큰 캐시를 가져옵니다.

function getTokenCache(): ITokenCache

반품

상속된 개체 PublicClientApplication.getTokenCache

리디렉션 흐름 중에 PublicClientApplication 개체가 로드된 후 사용자가 이벤트를 발생시키는 이벤트 처리기 함수입니다. 이는 리디렉션 인증 흐름과 관련된 모든 페이지 로드에서 호출되어야 합니다.

function handleRedirectPromise(hash?: string): Promise<null | AuthenticationResult>

매개 변수

반품

토큰 응답 또는 null입니다. 반환 값이 null이면 인증 리디렉션이 검색되지 않았습니다.

상속된 개체 PublicClientApplication.handleRedirectPromise

AuthenticationResult 개체의 토큰 및 계정으로 캐시를 하이드레이트합니다.

function hydrateCache(result: AuthenticationResult, request: PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>): Promise<void>

매개 변수

반품

상속된 개체 PublicClientApplication.hydrateCache

WAM 확장에 연결과 같은 비동기 시작 작업을 수행하는 이니셜라이저 함수

function initialize(request?: InitializeApplicationRequest): Promise<void>

매개 변수

반품

상속된 개체 PublicClientApplication.initialize

원격 분석, 로거 등에 전달된 SKU 및 버전을 설정하기 위해 래퍼 라이브러리(Angular 및 React)에서 호출됩니다.

function initializeWrapperLibrary(sku: WrapperSKU, version: string)

매개 변수

상속된 개체 PublicClientApplication.initializeWrapperLibrary

사용자 브라우저에서 팝업 창을 열어 로그인 프로세스를 시작할 때 사용

function loginPopup(request?: PopupRequest): Promise<AuthenticationResult>

매개 변수

반품

이 함수가 완료될 때 이행되거나 오류가 발생한 경우 거부되는 약속입니다.

상속된 개체 PublicClientApplication.loginPopup

사용자의 브라우저를 권한 부여 엔드포인트로 리디렉션하여 로그인 프로세스를 시작할 때 사용합니다. 이 함수는 페이지를 리디렉션하므로 이 함수 다음에 오는 코드는 실행되지 않습니다.

중요: Promise의 해결에 종속된 코드는 사용하지 않는 것이 좋습니다. 이 함수는 현재 브라우저 창에서 멀리 이동합니다. 현재 이 함수에서 실행되는 코드의 비동기 특성을 반영하기 위해 Promise를 반환합니다.

function loginRedirect(request?: RedirectRequest): Promise<void>

매개 변수

반품

상속된 개체 PublicClientApplication.loginRedirect

사용되지 않는 로그아웃 함수입니다. 대신 logoutRedirect 또는 logoutPopup 사용

function logout(logoutRequest?: EndSessionRequest): Promise<void>

매개 변수

반품

상속된 개체 PublicClientApplication.logout

현재 사용자에 대한 로컬 캐시를 지웁니다. 그러면 사용자에게 서버 로그아웃하라는 팝업 창이 열립니다.

function logoutPopup(logoutRequest?: EndSessionPopupRequest): Promise<void>

매개 변수

반품

상속된 개체 PublicClientApplication.logoutPopup

현재 사용자를 로그아웃하고 사용자를 postLogoutRedirectUri로 리디렉션하는 데 사용합니다. 기본 동작은 사용자를 .로 리디렉션하는 것입니다 window.location.href.

function logoutRedirect(logoutRequest?: EndSessionRequest): Promise<void>

매개 변수

반품

상속된 개체 PublicClientApplication.logoutRedirect

콜백 배열에서 제공된 ID를 사용하여 콜백을 제거합니다.

function removeEventCallback(callbackId: string)

매개 변수

상속된 개체 PublicClientApplication.removeEventCallback

addPerformanceCallback에 등록된 콜백을 제거합니다.

function removePerformanceCallback(callbackId: string): boolean

매개 변수

반품

상속된 개체 PublicClientApplication.removePerformanceCallback

활성 계정으로 사용할 계정을 설정합니다. acquireToken API에 계정이 전달되지 않으면 MSAL은 이 활성 계정을 사용합니다.

function setActiveAccount(account: null | AccountInfo)

매개 변수

상속된 개체 PublicClientApplication.setActiveAccount

구성의 기본 로거 집합을 새 로거로 새 구성으로 바꿉니다.

function setLogger(logger: Logger)

매개 변수

상속된 개체 PublicClientApplication.setLogger

탐색 클라이언트 설정

function setNavigationClient(navigationClient: INavigationClient)

매개 변수

상속된 개체 PublicClientApplication.setNavigationClient

이 함수는 숨겨진 iframe을 사용하여 eSTS에서 권한 부여 코드를 가져옵니다. 작동하지 않을 수 있는 경우가 있습니다.

• 지능형 추적 방지의 형태를 사용하는 모든 브라우저
• 서비스에 설정된 세션이 없는 경우

이러한 경우 팝업 또는 전체 프레임 리디렉션 내에서 요청을 수행해야 합니다.

상호 작용이 필요한 경우 prompt=none으로 요청을 보낼 수 없습니다.

새로 고침 토큰이 만료된 경우 서버에서 세션이 계속 있는 한 이 함수를 사용하여 새 토큰 집합을 자동으로 가져올 수 있습니다.

function ssoSilent(request: Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>): Promise<AuthenticationResult>

매개 변수

반품

이 함수가 완료될 때 이행되거나 오류가 발생한 경우 거부되는 약속입니다.

상속된 개체 PublicClientApplication.ssoSilent