다음을 통해 공유

UserTokenClient class

  • 참조
패키지:
botframework-connector

액세스 사용자 토큰 서비스에 대한 클라이언트입니다.

메서드

exchangeToken(string, string, string, TokenExchangeRequest)

Single Sign-On과 같은 토큰 교환 작업을 수행합니다.
getAadTokens(string, string, string[], string)

구성된 연결에서 특정 리소스에 대한 Azure Active Directory 토큰을 검색합니다.
getSignInResource(string, Activity, string)

연결 이름에 대한 로그인을 위해 사용자에게 보낼 원시 로그인 링크를 가져옵니다.
getTokenStatus(string, string, string)

지정된 사용자에 대해 구성된 각 연결의 토큰 상태를 검색합니다.
getUserToken(string, string, string, string)

로그인 흐름에 있는 사용자의 토큰을 검색하려고 시도합니다.
signOutUser(string, string, string)

토큰 서버를 사용하여 사용자를 로그아웃합니다.

메서드 세부 정보

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>

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>>

해당 TokenResponseresourceUrls의 사전입니다.

getSignInResource(string, Activity, string)

연결 이름에 대한 로그인을 위해 사용자에게 보낼 원시 로그인 링크를 가져옵니다.

function getSignInResource(connectionName: string, activity: Activity, finalRediect: string): Promise<SignInUrlResponse>

매개 변수

connectionName

string

사용할 인증 연결의 이름입니다.

activity

Activity

작업은 토큰 교환 상태를 파생시킬.

finalRediect

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[]>

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>

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>