UserTokenProvider Interface

  • Référence
Paquet:
com.microsoft.bot.builder
Artefact Maven:
com.microsoft.bot:bot-builder:4.14.3

public interface UserTokenProvider

Fournisseur OAuth.

Résumé de la méthode

Modificateur et type Méthode et description
abstract java.util.concurrent.CompletableFuture<TokenResponse> exchangeToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

Effectue une opération d’échange de jetons telle que pour l’authentification unique.
abstract java.util.concurrent.CompletableFuture<TokenResponse> exchangeToken(TurnContext turnContext, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

Effectue une opération d’échange de jetons telle que pour l’authentification unique.
abstract java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String[] resourceUrls, String userId)

Récupère des jetons Azure Active Directory pour des ressources particulières sur une connexion configurée, à l’aide des informations d’identification d’application personnalisées.
default java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls)

Récupère des jetons Azure Active Directory pour des ressources particulières sur une connexion configurée.
abstract java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls, String userId)

Récupère des jetons Azure Active Directory pour des ressources particulières sur une connexion configurée.
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName)

Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion, à l’aide de l’application personnaliséeInformations d’identification.
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion, à l’aide de l’application personnaliséeInformations d’identification.
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, String connectionName)

Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion.
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion.
abstract java.util.concurrent.CompletableFuture<SignInResource> getSignInResource(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion.
abstract java.util.concurrent.CompletableFuture<SignInResource> getSignInResource(TurnContext turnContext, String connectionName)

Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion.
abstract java.util.concurrent.CompletableFuture<SignInResource> getSignInResource(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion.
abstract java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(TurnContext context, AppCredentials oAuthAppCredentials, String userId, String includeFilter)

Récupère l’état du jeton pour chaque connexion configurée pour l’utilisateur donné, à l’aide des informations d’identification d’application personnalisées.
default java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(TurnContext turnContext, String userId)

Récupère l’état du jeton pour chaque connexion configurée pour l’utilisateur donné.
abstract java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(TurnContext turnContext, String userId, String includeFilter)

Récupère l’état du jeton pour chaque connexion configurée pour l’utilisateur donné.
abstract java.util.concurrent.CompletableFuture<TokenResponse> getUserToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String magicCode)

Tente de récupérer le jeton d’un utilisateur qui se trouve dans un flux de connexion, à l’aide des informations d’identification d’application personnalisées.
abstract java.util.concurrent.CompletableFuture<TokenResponse> getUserToken(TurnContext turnContext, String connectionName, String magicCode)

Tente de récupérer le jeton d’un utilisateur qui se trouve dans un flux de connexion.
default java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext turnContext)

Déconnecte l’utilisateur avec le serveur de jetons.
abstract java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId)

Déconnecte l’utilisateur avec le serveur de jetons à l’aide des informations d’identification d’application personnalisées.
abstract java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext turnContext, String connectionName, String userId)

Déconnecte l’utilisateur avec le serveur de jetons.

Détails de la méthode

exchangeToken

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

Effectue une opération d’échange de jetons telle que pour l’authentification unique.

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.
oAuthAppCredentials - AppCredentials pour OAuth.
connectionName - Nom de la connexion d’authentification à utiliser.
userId - ID d’utilisateur associé au jeton..
exchangeRequest - Détails de la demande d’échange, un jeton à échanger ou un URI à échanger.

Retours:

Si completableFuture est terminé, le jeton échangé est retourné.

exchangeToken

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

Effectue une opération d’échange de jetons telle que pour l’authentification unique.

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.
connectionName - Nom de la connexion d’authentification à utiliser.
userId - ID d’utilisateur associé au jeton..
exchangeRequest - Détails de la demande d’échange, un jeton à échanger ou un URI à échanger.

Retours:

Si completableFuture est terminé, le jeton échangé est retourné.

getAadTokens

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

Récupère des jetons Azure Active Directory pour des ressources particulières sur une connexion configurée, à l’aide d’AppCredentials personnalisés.

Paramètres:

context - Contexte pour le tour de conversation actuel avec l’utilisateur.
oAuthAppCredentials - AppCredentials pour OAuth.
connectionName - Nom de la connexion Azure Active Directory configurée avec ce bot.
resourceUrls - Liste des URL de ressource pour laquelle récupérer des jetons.
userId - ID utilisateur pour lequel les jetons sont récupérés. Si vous transmettez null, l’id utilisateur est extrait de l’activité dans TurnContext.

Retours:

Dictionnaire de resourceUrl dans tokenResponse correspondant.

getAadTokens

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

Récupère des jetons Azure Active Directory pour des ressources particulières sur une connexion configurée.

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.
connectionName - Nom de la connexion Azure Active Directory configurée avec ce bot.
resourceUrls - Liste des URL de ressource pour laquelle récupérer des jetons.

Retours:

Dictionnaire de resourceUrl dans tokenResponse correspondant.

getAadTokens

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

Récupère des jetons Azure Active Directory pour des ressources particulières sur une connexion configurée.

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.
connectionName - Nom de la connexion Azure Active Directory configurée avec ce bot.
resourceUrls - Liste des URL de ressource pour laquelle récupérer des jetons.
userId - ID utilisateur pour lequel les jetons sont récupérés. Si vous transmettez null, l’id utilisateur est extrait de l’activité dans ITurnContext.

Retours:

Dictionnaire de resourceUrl dans tokenResponse correspondant.

getOAuthSignInLink

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

Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion, à l’aide d’AppCredentials personnalisés.

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.
oAuthAppCredentials - AppCredentials pour OAuth.
connectionName - Nom de la connexion d’authentification à utiliser.

Retours:

CompletableFuture qui représente le travail mis en file d’attente à exécuter. Si completableFuture se termine correctement, le résultat contient le lien de connexion brut.

getOAuthSignInLink

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

Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion, à l’aide d’AppCredentials personnalisés.

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.
oAuthAppCredentials - AppCredentials pour OAuth.
connectionName - Nom de la connexion d’authentification à utiliser.
userId - ID d’utilisateur qui sera associé au jeton.
finalRedirect - URL finale vers laquelle le flux OAuth redirige.

Retours:

CompletableFuture qui représente le travail mis en file d’attente à exécuter. Si completableFuture se termine correctement, le résultat contient le lien de connexion brut.

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, String connectionName)

Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion.

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.
connectionName - Nom de la connexion d’authentification à utiliser.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter. Si la tâche se termine correctement, le résultat contient le lien de connexion brut.

getOAuthSignInLink

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

Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion.

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.
connectionName - Nom de la connexion d’authentification à utiliser.
userId - ID d’utilisateur qui sera associé au jeton.
finalRedirect - URL finale vers laquelle le flux OAuth redirige.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter. Si la tâche se termine correctement, le résultat contient le lien de connexion brut.

getSignInResource

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

Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion.

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.
oAuthAppCredentials - Informations d’identification pour OAuth.
connectionName - Nom de la connexion d’authentification à utiliser.
userId - ID d’utilisateur qui sera associé au jeton.
finalRedirect - URL finale vers laquelle le flux OAuth redirige.

Retours:

CompletableFuture qui représente le travail mis en file d’attente à exécuter. Si completableFuture se termine correctement, le résultat contient le lien de connexion brut.

getSignInResource

public abstract CompletableFuture getSignInResource(TurnContext turnContext, String connectionName)

Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion.

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.
connectionName - Nom de la connexion d’authentification à utiliser.

Retours:

CompletableFuture qui représente le travail mis en file d’attente à exécuter. Si completableFuture se termine correctement, le résultat contient le lien de connexion brut.

getSignInResource

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

Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion.

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.
connectionName - Nom de la connexion d’authentification à utiliser.
userId - ID d’utilisateur qui sera associé au jeton.
finalRedirect - URL finale vers laquelle le flux OAuth redirige.

Retours:

CompletableFuture qui représente le travail mis en file d’attente à exécuter. Si completableFuture se termine correctement, le résultat contient le lien de connexion brut.

getTokenStatus

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

Récupère l’état du jeton pour chaque connexion configurée pour l’utilisateur donné, à l’aide d’AppCredentials personnalisés.

Paramètres:

context - Contexte pour le tour de conversation actuel avec l’utilisateur.
oAuthAppCredentials - AppCredentials pour OAuth.
userId - ID d’utilisateur pour lequel l’état du jeton est récupéré.
includeFilter - Liste séparée par des virgules facultatives des connexions à inclure. Vide retourne l’état du jeton pour toutes les connexions configurées.

Retours:

Tableau de TokenStatus.

getTokenStatus

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

Récupère l’état du jeton pour chaque connexion configurée pour l’utilisateur donné.

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.
userId - ID d’utilisateur pour lequel l’état du jeton est récupéré.

Retours:

Tableau de TokenStatus.

getTokenStatus

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

Récupère l’état du jeton pour chaque connexion configurée pour l’utilisateur donné.

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.
userId - ID d’utilisateur pour lequel l’état du jeton est récupéré.
includeFilter - Liste séparée par des virgules des connexions à inclure. Vide retourne l’état du jeton pour toutes les connexions configurées.

Retours:

Tableau de TokenStatus.

getUserToken

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

Tente de récupérer le jeton d’un utilisateur qui se trouve dans un flux de connexion à l’aide d’AppCredentials personnalisés.

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.
oAuthAppCredentials - AppCredentials pour OAuth.
connectionName - Nom de la connexion d’authentification à utiliser.
magicCode - (Facultatif) Un utilisateur facultatif a entré du code pour valider.

Retours:

Réponse du jeton.

getUserToken

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

Tente de récupérer le jeton d’un utilisateur qui se trouve dans un flux de connexion.

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.
connectionName - Nom de la connexion d’authentification à utiliser.
magicCode - (Facultatif) Un utilisateur facultatif a entré du code pour valider.

Retours:

Réponse du jeton.

signOutUser

public default CompletableFuture signOutUser(TurnContext turnContext)

Déconnecte l’utilisateur avec le serveur de jetons.

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

signOutUser

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

Déconnecte l’utilisateur avec le serveur de jetons à l’aide d’AppCredentials personnalisés.

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.
oAuthAppCredentials - AppCredentials pour OAuth.
connectionName - Nom de la connexion d’authentification à utiliser.
userId - ID utilisateur de l’utilisateur à déconnecter.

Retours:

CompletableFuture qui représente le travail mis en file d’attente à exécuter.

signOutUser

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

Déconnecte l’utilisateur avec le serveur de jetons.

Paramètres:

turnContext - Contexte pour le tour de conversation actuel avec l’utilisateur.
connectionName - Nom de la connexion d’authentification à utiliser.
userId - ID utilisateur de l’utilisateur à déconnecter.

Retours:

Tâche qui représente le travail mis en file d’attente à exécuter.

S’applique à