AuthenticationOptions interface
맵 컨트롤이 Azure Maps 서비스에서 인증하는 방법을 지정하는 옵션입니다.
- Extends
속성
aad |
Azure AD 등록된 앱 ID입니다. Azure AD 테넌트에서 등록된 앱의 앱 ID입니다. AAD 인증 유형에 대해 지정해야 합니다. |
aad |
로그인에 사용할 AAD instance.
AAD 인증 유형을 사용할 때 선택적으로 지정할 수 있습니다.
기본적으로 |
aad |
로 지정된 |
auth |
필요에 따라 MSAL.js 라이브러리에서 기존 |
auth |
사용할 인증 메커니즘입니다. |
client |
Azure Maps 클라이언트 ID입니다. 맵 계정을 식별하는 데 사용되는 고유 식별자입니다. 항상 지정하는 것이 좋지만 AAD 및 익명 인증 유형에 대해 지정해야 합니다. |
get |
익명/sas 인증 메커니즘과 함께 사용할 콜백입니다. 이 콜백은 인증 토큰으로의 해결을 담당합니다. 예를 들어 엔드포인트에서 CORS로 보호되는 토큰을 페치합니다. |
sas |
필요에 따라 sas 인증을 위한 초기 토큰을 제공합니다. |
subscription |
Azure Maps 계정의 구독 키입니다. 구독 키 인증 유형에 대해 지정해야 합니다. |
메서드
set |
AAD 암시적 허용 메커니즘을 구성하는 데 필요한 인증 옵션을 설정합니다. |
set |
sas 인증 방법을 구성하는 데 필요한 옵션을 설정합니다. |
set |
구독 키 인증 메커니즘을 구성하는 데 필요한 옵션을 설정합니다. |
set |
익명 인증 방법을 구성하는 데 필요한 옵션을 설정합니다. |
속성 세부 정보
aadAppId
Azure AD 등록된 앱 ID입니다. Azure AD 테넌트에서 등록된 앱의 앱 ID입니다. AAD 인증 유형에 대해 지정해야 합니다.
aadAppId?: string
속성 값
string
aadInstance
로그인에 사용할 AAD instance.
AAD 인증 유형을 사용할 때 선택적으로 지정할 수 있습니다.
기본적으로 https://login.microsoftonline.com/
instance 사용됩니다.
aadInstance?: string
속성 값
string
aadTenant
로 지정된 aadAppId
등록된 앱을 소유하는 AAD 테넌트입니다.
AAD 인증 유형에 대해 지정해야 합니다.
aadTenant?: string
속성 값
string
authContext
필요에 따라 MSAL.js 라이브러리에서 기존 PublicClientApplication
을 제공합니다.
이 인증 컨텍스트는 AAD 토큰을 획득하는 데 사용됩니다.
AAD 인증 유형에만 사용됩니다.
이 인증 컨텍스트는 와 동일한 AAD 앱 ID this.aadAppId
를 사용하도록 구성해야 합니다.
이 값이 제공되지 않으면 모든 맵 인스턴스가 자체 프라이빗 인증 컨텍스트를 공유합니다.
authContext?: PublicClientApplication
속성 값
PublicClientApplication
authType
clientId
Azure Maps 클라이언트 ID입니다. 맵 계정을 식별하는 데 사용되는 고유 식별자입니다. 항상 지정하는 것이 좋지만 AAD 및 익명 인증 유형에 대해 지정해야 합니다.
clientId?: string
속성 값
string
getToken
익명/sas 인증 메커니즘과 함께 사용할 콜백입니다. 이 콜백은 인증 토큰으로의 해결을 담당합니다. 예를 들어 엔드포인트에서 CORS로 보호되는 토큰을 페치합니다.
getToken?: getAuthTokenCallback
속성 값
sasToken
필요에 따라 sas 인증을 위한 초기 토큰을 제공합니다.
sasToken?: string
속성 값
string
subscriptionKey
Azure Maps 계정의 구독 키입니다. 구독 키 인증 유형에 대해 지정해야 합니다.
subscriptionKey?: string
속성 값
string
메서드 세부 정보
setAadProperties(string, string, string, string, PublicClientApplication)
AAD 암시적 허용 메커니즘을 구성하는 데 필요한 인증 옵션을 설정합니다.
function setAadProperties(clientId: string, aadAppId: string, aadTenant: string, aadInstance?: string, authContext?: PublicClientApplication)
매개 변수
- clientId
-
string
Azure Maps 계정의 클라이언트 ID
- aadAppId
-
string
Azure AD 앱 ID
- aadTenant
-
string
Azure AD 테넌트 이름
- aadInstance
-
string
선택적 Azure AD 인스턴스
- authContext
-
PublicClientApplication
MSAL.js 라이브러리의 선택 사항 PublicClientApplication
setSasCallbackFunction(getAuthTokenCallback)
sas 인증 방법을 구성하는 데 필요한 옵션을 설정합니다.
function setSasCallbackFunction(getTokenCallback: getAuthTokenCallback)
매개 변수
- getTokenCallback
- getAuthTokenCallback
인증 토큰으로의 해결을 담당하는 콜백 함수입니다.
setSubscriptionKey(string)
구독 키 인증 메커니즘을 구성하는 데 필요한 옵션을 설정합니다.
function setSubscriptionKey(key: string)
매개 변수
- key
-
string
setTokenCallbackFunction(getAuthTokenCallback)
익명 인증 방법을 구성하는 데 필요한 옵션을 설정합니다.
function setTokenCallbackFunction(getTokenCallback: getAuthTokenCallback)
매개 변수
- getTokenCallback
- getAuthTokenCallback
인증 토큰으로의 해결을 담당하는 콜백 함수입니다.