UserTokenProvider 인터페이스

패키지:

com.microsoft.bot.builder

Maven 아티팩트:

com.microsoft.bot:bot-builder:4.14.3

public interface UserTokenProvider

OAuth 공급자입니다.

메서드 요약

한정자 및 형식	메서드 및 설명
abstract java.util.concurrent.CompletableFuture<TokenResponse>	exchangeToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, TokenExchangeRequest exchangeRequest) Single Sign-On과 같은 토큰 교환 작업을 수행합니다.
abstract java.util.concurrent.CompletableFuture<TokenResponse>	exchangeToken(TurnContext turnContext, String connectionName, String userId, TokenExchangeRequest exchangeRequest) Single Sign-On과 같은 토큰 교환 작업을 수행합니다.
abstract java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>>	getAadTokens(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String[] resourceUrls, String userId) 사용자 지정된 앱자격 증명을 사용하여 구성된 연결에서 특정 리소스에 대한 Azure Active Directory 토큰을 검색합니다.
default java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>>	getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls) 구성된 연결에서 특정 리소스에 대한 Azure Active Directory 토큰을 검색합니다.
abstract java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>>	getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls, String userId) 구성된 연결에서 특정 리소스에 대한 Azure Active Directory 토큰을 검색합니다.
abstract java.util.concurrent.CompletableFuture<java.lang.String>	getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName) 사용자 지정된 앱자격 증명을 사용하여 연결 이름에 대한 로그인을 위해 사용자에게 보낼 원시 로그인 링크를 가져옵니다.
abstract java.util.concurrent.CompletableFuture<java.lang.String>	getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect) 사용자 지정된 앱자격 증명을 사용하여 연결 이름에 대한 로그인을 위해 사용자에게 보낼 원시 로그인 링크를 가져옵니다.
abstract java.util.concurrent.CompletableFuture<java.lang.String>	getOAuthSignInLink(TurnContext turnContext, String connectionName) 연결 이름에 대한 로그인을 위해 사용자에게 보낼 원시 로그인 링크를 가져옵니다.
abstract java.util.concurrent.CompletableFuture<java.lang.String>	getOAuthSignInLink(TurnContext turnContext, String connectionName, String userId, String finalRedirect) 연결 이름에 대한 로그인을 위해 사용자에게 보낼 원시 로그인 링크를 가져옵니다.
abstract java.util.concurrent.CompletableFuture<SignInResource>	getSignInResource(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect) 연결 이름에 대한 로그인을 위해 사용자에게 보낼 원시 로그인 링크를 가져옵니다.
abstract java.util.concurrent.CompletableFuture<SignInResource>	getSignInResource(TurnContext turnContext, String connectionName) 연결 이름에 대한 로그인을 위해 사용자에게 보낼 원시 로그인 링크를 가져옵니다.
abstract java.util.concurrent.CompletableFuture<SignInResource>	getSignInResource(TurnContext turnContext, String connectionName, String userId, String finalRedirect) 연결 이름에 대한 로그인을 위해 사용자에게 보낼 원시 로그인 링크를 가져옵니다.
abstract java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>>	getTokenStatus(TurnContext context, AppCredentials oAuthAppCredentials, String userId, String includeFilter) 사용자 지정된 앱자격 증명을 사용하여 지정된 사용자에 대해 구성된 각 연결의 토큰 상태를 검색합니다.
default java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>>	getTokenStatus(TurnContext turnContext, String userId) 지정된 사용자에 대해 구성된 각 연결의 토큰 상태를 검색합니다.
abstract java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>>	getTokenStatus(TurnContext turnContext, String userId, String includeFilter) 지정된 사용자에 대해 구성된 각 연결의 토큰 상태를 검색합니다.
abstract java.util.concurrent.CompletableFuture<TokenResponse>	getUserToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String magicCode) 사용자 지정된 앱자격 증명을 사용하여 로그인 흐름에 있는 사용자의 토큰을 검색하려고 시도합니다.
abstract java.util.concurrent.CompletableFuture<TokenResponse>	getUserToken(TurnContext turnContext, String connectionName, String magicCode) 로그인 흐름에 있는 사용자의 토큰을 검색하려고 시도합니다.
default java.util.concurrent.CompletableFuture<java.lang.Void>	signOutUser(TurnContext turnContext) 토큰 서버를 사용하여 사용자를 로그아웃합니다.
abstract java.util.concurrent.CompletableFuture<java.lang.Void>	signOutUser(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId) 사용자 지정된 앱자격 증명을 사용하여 토큰 서버로 사용자를 로그아웃합니다.
abstract java.util.concurrent.CompletableFuture<java.lang.Void>	signOutUser(TurnContext turnContext, String connectionName, String userId) 토큰 서버를 사용하여 사용자를 로그아웃합니다.

메서드 세부 정보

exchangeToken

public abstract CompletableFuture exchangeToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

Single Sign-On과 같은 토큰 교환 작업을 수행합니다.

매개 변수:

turnContext - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

oAuthAppCredentials - OAuth용 AppCredentials입니다.

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

userId - 토큰과 연결된 사용자 ID입니다.

exchangeRequest - 교환 요청 세부 정보( 교환할 토큰 또는 교환할 URI)입니다.

반환:

CompletableFuture가 완료되면 교환된 토큰이 반환됩니다.

exchangeToken

public abstract CompletableFuture exchangeToken(TurnContext turnContext, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

Single Sign-On과 같은 토큰 교환 작업을 수행합니다.

매개 변수:

turnContext - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

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

userId - 토큰과 연결된 사용자 ID입니다.

exchangeRequest - 교환 요청 세부 정보( 교환할 토큰 또는 교환할 URI)입니다.

반환:

CompletableFuture가 완료되면 교환된 토큰이 반환됩니다.

getAadTokens

public abstract CompletableFuture> getAadTokens(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String[] resourceUrls, String userId)

사용자 지정된 AppCredentials를 사용하여 구성된 연결에서 특정 리소스에 대한 Azure Active Directory 토큰을 검색합니다.

매개 변수:

context - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

oAuthAppCredentials - OAuth용 AppCredentials입니다.

connectionName - 이 봇으로 구성된 Azure Active Directory 연결의 이름입니다.

resourceUrls - 토큰을 검색할 리소스 URL 목록입니다.

userId - 토큰을 검색할 사용자 ID입니다. null을 전달하는 경우 userId는 TurnContext의 작업에서 가져옵니다.

반환:

해당 TokenResponse에 대한 resourceUrl 사전입니다.

getAadTokens

public default CompletableFuture> getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls)

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

매개 변수:

turnContext - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

connectionName - 이 봇으로 구성된 Azure Active Directory 연결의 이름입니다.

resourceUrls - 토큰을 검색할 리소스 URL 목록입니다.

반환:

해당 TokenResponse에 대한 resourceUrl 사전입니다.

getAadTokens

public abstract CompletableFuture> getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls, String userId)

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

매개 변수:

turnContext - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

connectionName - 이 봇으로 구성된 Azure Active Directory 연결의 이름입니다.

resourceUrls - 토큰을 검색할 리소스 URL 목록입니다.

userId - 토큰을 검색할 사용자 ID입니다. null을 전달하는 경우 userId는 ITurnContext의 작업에서 가져옵니다.

반환:

해당 TokenResponse에 대한 resourceUrl 사전입니다.

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName)

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

매개 변수:

turnContext - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

oAuthAppCredentials - OAuth용 AppCredentials입니다.

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

반환:

실행 대기 중인 작업을 나타내는 CompletableFuture입니다. CompletableFuture가 성공적으로 완료되면 결과에 원시 로그인 링크가 포함됩니다.

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

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

매개 변수:

turnContext - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

oAuthAppCredentials - OAuth용 AppCredentials입니다.

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

userId - 토큰과 연결할 사용자 ID입니다.

finalRedirect - OAuth 흐름이 리디렉션할 최종 URL입니다.

반환:

실행 대기 중인 작업을 나타내는 CompletableFuture입니다. CompletableFuture가 성공적으로 완료되면 결과에 원시 로그인 링크가 포함됩니다.

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, String connectionName)

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

매개 변수:

turnContext - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

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

반환:

실행할 큐에 대기 중인 작업을 나타내는 작업입니다. 작업이 성공적으로 완료되면 결과에 원시 로그인 링크가 포함됩니다.

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

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

매개 변수:

turnContext - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

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

userId - 토큰과 연결할 사용자 ID입니다.

finalRedirect - OAuth 흐름이 리디렉션할 최종 URL입니다.

반환:

실행할 큐에 대기 중인 작업을 나타내는 작업입니다. 작업이 성공적으로 완료되면 결과에 원시 로그인 링크가 포함됩니다.

getSignInResource

public abstract CompletableFuture getSignInResource(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

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

매개 변수:

turnContext - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

oAuthAppCredentials - OAuth에 대한 자격 증명입니다.

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

userId - 토큰과 연결할 사용자 ID입니다.

finalRedirect - OAuth 흐름이 리디렉션할 최종 URL입니다.

반환:

실행 대기 중인 작업을 나타내는 CompletableFuture입니다. CompletableFuture가 성공적으로 완료되면 결과에 원시 로그인 링크가 포함됩니다.

getSignInResource

public abstract CompletableFuture getSignInResource(TurnContext turnContext, String connectionName)

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

매개 변수:

turnContext - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

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

반환:

실행 대기 중인 작업을 나타내는 CompletableFuture입니다. CompletableFuture가 성공적으로 완료되면 결과에 원시 로그인 링크가 포함됩니다.

getSignInResource

public abstract CompletableFuture getSignInResource(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

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

매개 변수:

turnContext - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

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

userId - 토큰과 연결할 사용자 ID입니다.

finalRedirect - OAuth 흐름이 리디렉션할 최종 URL입니다.

반환:

실행 대기 중인 작업을 나타내는 CompletableFuture입니다. CompletableFuture가 성공적으로 완료되면 결과에 원시 로그인 링크가 포함됩니다.

getTokenStatus

public abstract CompletableFuture> getTokenStatus(TurnContext context, AppCredentials oAuthAppCredentials, String userId, String includeFilter)

사용자 지정된 AppCredentials를 사용하여 지정된 사용자에 대해 구성된 각 연결의 토큰 상태를 검색합니다.

매개 변수:

context - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

oAuthAppCredentials - OAuth용 AppCredentials입니다.

userId - 토큰 상태가 검색되는 사용자 ID입니다.

includeFilter - 포함할 연결의 선택적 쉼표로 구분된 목록입니다. 비어 있으면 구성된 모든 연결에 대한 토큰 상태가 반환됩니다.

반환:

TokenStatus의 배열입니다.

getTokenStatus

public default CompletableFuture> getTokenStatus(TurnContext turnContext, String userId)

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

매개 변수:

turnContext - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

userId - 토큰 상태가 검색되는 사용자 ID입니다.

반환:

TokenStatus의 배열입니다.

getTokenStatus

public abstract CompletableFuture> getTokenStatus(TurnContext turnContext, String userId, String includeFilter)

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

매개 변수:

turnContext - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

userId - 토큰 상태가 검색되는 사용자 ID입니다.

includeFilter - 포함할 연결의 쉼표로 구분된 목록입니다. 비어 있으면 구성된 모든 연결에 대한 토큰 상태가 반환됩니다.

반환:

TokenStatus의 배열입니다.

getUserToken

public abstract CompletableFuture getUserToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String magicCode)

사용자 지정된 AppCredentials를 사용하여 로그인 흐름에 있는 사용자의 토큰을 검색하려고 시도합니다.

매개 변수:

turnContext - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

oAuthAppCredentials - OAuth용 AppCredentials입니다.

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

magicCode - (선택 사항) 선택적 사용자가 유효성을 검사할 코드를 입력했습니다.

반환:

토큰 응답입니다.

getUserToken

public abstract CompletableFuture getUserToken(TurnContext turnContext, String connectionName, String magicCode)

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

매개 변수:

turnContext - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

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

magicCode - (선택 사항) 선택적 사용자가 유효성을 검사할 코드를 입력했습니다.

반환:

토큰 응답입니다.

signOutUser

public default CompletableFuture signOutUser(TurnContext turnContext)

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

매개 변수:

turnContext - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

반환:

실행할 큐에 대기 중인 작업을 나타내는 작업입니다.

signOutUser

public abstract CompletableFuture signOutUser(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId)

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

매개 변수:

turnContext - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

oAuthAppCredentials - OAuth용 AppCredentials입니다.

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

userId - 로그아웃할 사용자의 사용자 ID입니다.

반환:

실행 대기 중인 작업을 나타내는 CompletableFuture입니다.

signOutUser

public abstract CompletableFuture signOutUser(TurnContext turnContext, String connectionName, String userId)

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

매개 변수:

turnContext - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

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

userId - 로그아웃할 사용자의 사용자 ID입니다.

반환:

실행할 큐에 대기 중인 작업을 나타내는 작업입니다.