ExtendedUserTokenProvider interface
Avertissement
Cette API est à présent déconseillée.
Use UserTokenClient instead.
Interface pour l’authentification unique OAuth de jeton utilisateur et LES API Exchange de jetons pour BotAdapters
- Extends
Méthodes
| exchange |
Effectue une opération d’échange de jetons telle que pour l’authentification unique. |
| exchange |
Effectue une opération d’échange de jetons telle que pour l’authentification unique. |
| get |
Déconnecte l’utilisateur avec le serveur de jetons. |
| get |
Obtient un lien de connexion à partir du serveur de jetons qui peut être envoyé dans le cadre d’une carte SigninCard. |
| get |
Obtenez la ressource de connexion brute à envoyer à l’utilisateur pour la connexion pour un nom de connexion. |
| get |
Obtenez la ressource de connexion brute à envoyer à l’utilisateur pour la connexion pour un nom de connexion. |
| get |
Obtenez la ressource de connexion brute à envoyer à l’utilisateur pour la connexion pour un nom de connexion. |
| get |
Récupère le jeton OAuth pour un utilisateur qui se trouve dans un flux de connexion. |
| sign |
Déconnecte l’utilisateur avec le serveur de jetons. |
Méthodes héritées
| get |
Récupère l’état du jeton pour chaque connexion configurée pour l’utilisateur donné, à l’aide des AppCredentials du bot. |
Détails de la méthode
exchangeToken(TurnContext, string, string, TokenExchangeRequest)
Effectue une opération d’échange de jetons telle que pour l’authentification unique.
function exchangeToken(context: TurnContext, connectionName: string, userId: string, tokenExchangeRequest: TokenExchangeRequest): Promise<TokenResponse>Paramètres
- context
- TurnContext
Contexte pour le tour de conversation actuel avec l’utilisateur.
- connectionName
-
string
Nom de la connexion d’authentification à utiliser.
- userId
-
string
ID d’utilisateur qui sera associé au jeton.
- tokenExchangeRequest
-
TokenExchangeRequest
Détails de la demande d’échange, un jeton à échanger ou un URI à échanger.
Retours
Promise<TokenResponse>
exchangeToken(TurnContext, string, string, TokenExchangeRequest, CoreAppCredentials)
Effectue une opération d’échange de jetons telle que pour l’authentification unique.
function exchangeToken(context: TurnContext, connectionName: string, userId: string, tokenExchangeRequest: TokenExchangeRequest, appCredentials: CoreAppCredentials): Promise<TokenResponse>Paramètres
- context
- TurnContext
Contexte pour le tour de conversation actuel avec l’utilisateur.
- connectionName
-
string
Nom de la connexion d’authentification à utiliser.
- userId
-
string
ID d’utilisateur qui sera associé au jeton.
- tokenExchangeRequest
-
TokenExchangeRequest
Détails de la demande d’échange, un jeton à échanger ou un URI à échanger.
- appCredentials
- CoreAppCredentials
Retours
Promise<TokenResponse>
getAadTokens(TurnContext, string, string[], CoreAppCredentials)
Déconnecte l’utilisateur avec le serveur de jetons.
function getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[], appCredentials?: CoreAppCredentials): Promise<[key: string]: TokenResponse>Paramètres
- context
- TurnContext
Contexte pour le tour de conversation actuel avec l’utilisateur.
- connectionName
-
string
Nom de la connexion d’authentification à utiliser.
- resourceUrls
-
string[]
- appCredentials
- CoreAppCredentials
Retours
Promise<[key: string]: TokenResponse>
getSignInLink(TurnContext, string, CoreAppCredentials)
Obtient un lien de connexion à partir du serveur de jetons qui peut être envoyé dans le cadre d’une carte SigninCard.
function getSignInLink(context: TurnContext, connectionName: string, appCredentials?: CoreAppCredentials): Promise<string>Paramètres
- context
- TurnContext
Contexte pour le tour de conversation actuel avec l’utilisateur.
- connectionName
-
string
Nom de la connexion d’authentification à utiliser.
- appCredentials
- CoreAppCredentials
Retours
Promise<string>
getSignInResource(TurnContext, string)
Obtenez la ressource de connexion brute à envoyer à l’utilisateur pour la connexion pour un nom de connexion.
function getSignInResource(context: TurnContext, connectionName: string): Promise<SignInUrlResponse>Paramètres
- context
- TurnContext
Contexte pour le tour de conversation actuel avec l’utilisateur.
- connectionName
-
string
Nom de la connexion d’authentification à utiliser.
Retours
Promise<SignInUrlResponse>
getSignInResource(TurnContext, string, string, string)
Obtenez la ressource de connexion brute à envoyer à l’utilisateur pour la connexion pour un nom de connexion.
function getSignInResource(context: TurnContext, connectionName: string, userId: string, finalRedirect?: string): Promise<SignInUrlResponse>Paramètres
- context
- TurnContext
Contexte pour le tour de conversation actuel avec l’utilisateur.
- connectionName
-
string
Nom de la connexion d’authentification à utiliser.
- userId
-
string
ID d’utilisateur qui sera associé au jeton.
- finalRedirect
-
string
URL finale vers laquelle le flux OAuth redirige.
Retours
Promise<SignInUrlResponse>
getSignInResource(TurnContext, string, string, string, CoreAppCredentials)
Obtenez la ressource de connexion brute à envoyer à l’utilisateur pour la connexion pour un nom de connexion.
function getSignInResource(context: TurnContext, connectionName: string, userId: string, finalRedirect?: string, appCredentials?: CoreAppCredentials): Promise<SignInUrlResponse>Paramètres
- context
- TurnContext
Contexte pour le tour de conversation actuel avec l’utilisateur.
- connectionName
-
string
Nom de la connexion d’authentification à utiliser.
- userId
-
string
ID d’utilisateur qui sera associé au jeton.
- finalRedirect
-
string
URL finale vers laquelle le flux OAuth redirige.
- appCredentials
- CoreAppCredentials
Retours
Promise<SignInUrlResponse>
getUserToken(TurnContext, string, string, CoreAppCredentials)
Récupère le jeton OAuth pour un utilisateur qui se trouve dans un flux de connexion.
function getUserToken(context: TurnContext, connectionName: string, magicCode?: string, appCredentials?: CoreAppCredentials): Promise<TokenResponse>Paramètres
- context
- TurnContext
Contexte pour le tour de conversation actuel avec l’utilisateur.
- connectionName
-
string
Nom de la connexion d’authentification à utiliser.
- magicCode
-
string
(Facultatif) Un utilisateur facultatif a entré du code pour valider.
- appCredentials
- CoreAppCredentials
Retours
Promise<TokenResponse>
signOutUser(TurnContext, string, string, CoreAppCredentials)
Déconnecte l’utilisateur avec le serveur de jetons.
function signOutUser(context: TurnContext, connectionName: string, userId?: string, appCredentials?: CoreAppCredentials): Promise<void>Paramètres
- context
- TurnContext
Contexte pour le tour de conversation actuel avec l’utilisateur.
- connectionName
-
string
Nom de la connexion d’authentification à utiliser.
- userId
-
string
ID utilisateur de l’utilisateur à déconnecter.
- appCredentials
- CoreAppCredentials
Retours
Promise<void>
Détails de la méthode héritée
getTokenStatus(TurnContext, string, string, any)
Récupère l’état du jeton pour chaque connexion configurée pour l’utilisateur donné, à l’aide des AppCredentials du bot.
function getTokenStatus(context: TurnContext, userId: string, includeFilter?: string, oAuthAppCredentials?: any): Promise<any[]>Paramètres
- context
- TurnContext
Contexte pour le tour de conversation actuel avec l’utilisateur.
- userId
-
string
ID d’utilisateur pour lequel l’état du jeton est récupéré.
- includeFilter
-
string
Liste séparée par des virgules des connexions à inclure. Vide retourne l’état du jeton pour toutes les connexions configurées.
- oAuthAppCredentials
-
any
Informations d’identification de l’application pour OAuth.
Retours
Promise<any[]>
héritée deIUserTokenProvider.getTokenStatus