UserTokenClientImpl class
- Extends
생성자
| User |
메서드
| exchange |
Single Sign-On과 같은 토큰 교환 작업을 수행합니다. |
| get |
구성된 연결에서 특정 리소스에 대한 Azure Active Directory 토큰을 검색합니다. |
| get |
로그인을 위해 사용자에게 보낼 원시 로그인 리소스를 비동기적으로 가져옵니다. |
| get |
지정된 사용자에 대해 구성된 각 연결의 토큰 상태를 검색합니다. |
| get |
로그인 흐름에 있는 사용자의 토큰을 검색하려고 시도합니다. |
| sign |
토큰 서버를 사용하여 사용자를 로그아웃합니다. |
생성자 세부 정보
UserTokenClientImpl(string, ServiceClientCredentials, string, ConnectorClientOptions)
new UserTokenClientImpl(appId: string, credentials: ServiceClientCredentials, oauthEndpoint: string, connectorClientOptions?: ConnectorClientOptions)매개 변수
- appId
-
string
appId입니다.
- credentials
-
ServiceClientCredentials
OAuth용 AppCredentials입니다.
- oauthEndpoint
-
string
OAuth API 엔드포인트입니다.
- connectorClientOptions
- ConnectorClientOptions
ConnectorClientOptions 개체입니다.
메서드 세부 정보
exchangeToken(string, string, string, TokenExchangeRequest)
Single Sign-On과 같은 토큰 교환 작업을 수행합니다.
function exchangeToken(userId: string, connectionName: string, channelId: string, exchangeRequest: TokenExchangeRequest): Promise<TokenResponse>매개 변수
- userId
-
string
토큰과 연결할 사용자 ID입니다.
- connectionName
-
string
사용할 인증 연결의 이름입니다.
- channelId
-
string
토큰과 연결할 채널 ID입니다.
- exchangeRequest
-
TokenExchangeRequest
교환 요청 세부 정보( 교환할 토큰 또는 교환할 URI)입니다.
반환
Promise<TokenResponse>
작업의 결과를 나타내는 프라미스입니다.
getAadTokens(string, string, string[], string)
구성된 연결에서 특정 리소스에 대한 Azure Active Directory 토큰을 검색합니다.
function getAadTokens(userId: string, connectionName: string, resourceUrls: string[], channelId: string): Promise<Record<string, TokenResponse>>매개 변수
- userId
-
string
토큰과 연결할 사용자 ID입니다.
- connectionName
-
string
사용할 인증 연결의 이름입니다.
- resourceUrls
-
string[]
토큰을 검색할 리소스 URL 목록입니다.
- channelId
-
string
토큰과 연결할 채널 ID입니다.
반환
Promise<Record<string, TokenResponse>>
해당 TokenResponse에 대한 resourceUrl 사전의 약속입니다.
getSignInResource(string, Activity, string)
로그인을 위해 사용자에게 보낼 원시 로그인 리소스를 비동기적으로 가져옵니다.
function getSignInResource(connectionName: string, activity: Activity, finalRedirect: string): Promise<SignInUrlResponse>매개 변수
- connectionName
-
string
사용할 인증 연결의 이름입니다.
- activity
-
Activity
토큰 교환 상태를 파생시킬 활동입니다.
- finalRedirect
-
string
OAuth 흐름이 리디렉션할 최종 URL입니다.
반환
Promise<SignInUrlResponse>
SignInUrlResponse 리소스입니다.
getTokenStatus(string, string, string)
지정된 사용자에 대해 구성된 각 연결의 토큰 상태를 검색합니다.
function getTokenStatus(userId: string, channelId: string, includeFilter: string): Promise<TokenStatus[]>매개 변수
- userId
-
string
토큰과 연결할 사용자 ID입니다.
- channelId
-
string
토큰과 연결할 채널 ID입니다.
- includeFilter
-
string
includeFilter입니다.
반환
Promise<TokenStatus[]>
토큰 상태의 배열이 있는 프라미스입니다.
getUserToken(string, string, string, string)
로그인 흐름에 있는 사용자의 토큰을 검색하려고 시도합니다.
function getUserToken(userId: string, connectionName: string, channelId: string, magicCode: string): Promise<TokenResponse>매개 변수
- userId
-
string
토큰과 연결할 사용자 ID입니다.
- connectionName
-
string
사용할 인증 연결의 이름입니다.
- channelId
-
string
토큰과 연결할 채널 ID입니다.
- magicCode
-
string
(선택 사항) 선택적 사용자가 유효성을 검사할 코드를 입력했습니다.
반환
Promise<TokenResponse>
토큰 응답입니다.
signOutUser(string, string, string)
토큰 서버를 사용하여 사용자를 로그아웃합니다.
function signOutUser(userId: string, connectionName: string, channelId: string): Promise<void>매개 변수
- userId
-
string
토큰과 연결할 사용자 ID입니다.
- connectionName
-
string
사용할 인증 연결의 이름입니다.
- channelId
-
string
토큰과 연결할 채널 ID입니다.
반환
Promise<void>