UserTokenProvider Schnittstelle

  • Referenz
Paket:
com.microsoft.bot.builder
Maven-Artefakt:
com.microsoft.bot:bot-builder:4.14.3

public interface UserTokenProvider

OAuth-Anbieter.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
abstract java.util.concurrent.CompletableFuture<TokenResponse> exchangeToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

Führt einen Tokenaustauschvorgang aus, z. B. für einmaliges Anmelden.
abstract java.util.concurrent.CompletableFuture<TokenResponse> exchangeToken(TurnContext turnContext, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

Führt einen Tokenaustauschvorgang aus, z. B. für einmaliges Anmelden.
abstract java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String[] resourceUrls, String userId)

Ruft Azure Active Directory-Token für bestimmte Ressourcen für eine konfigurierte Verbindung mithilfe von angepassten App--Anmeldeinformationen ab.
default java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls)

Ruft Azure Active Directory-Token für bestimmte Ressourcen in einer konfigurierten Verbindung ab.
abstract java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls, String userId)

Ruft Azure Active Directory-Token für bestimmte Ressourcen in einer konfigurierten Verbindung ab.
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName)

Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden, indem Sie benutzerdefinierte App--Anmeldeinformationen verwenden.
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden, indem Sie benutzerdefinierte App--Anmeldeinformationen verwenden.
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, String connectionName)

Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.
abstract java.util.concurrent.CompletableFuture<SignInResource> getSignInResource(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.
abstract java.util.concurrent.CompletableFuture<SignInResource> getSignInResource(TurnContext turnContext, String connectionName)

Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.
abstract java.util.concurrent.CompletableFuture<SignInResource> getSignInResource(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.
abstract java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(TurnContext context, AppCredentials oAuthAppCredentials, String userId, String includeFilter)

Ruft den Tokenstatus für jede konfigurierte Verbindung für den angegebenen Benutzer mithilfe von angepassten App--Anmeldeinformationen ab.
default java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(TurnContext turnContext, String userId)

Ruft den Tokenstatus für jede konfigurierte Verbindung für den angegebenen Benutzer ab.
abstract java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(TurnContext turnContext, String userId, String includeFilter)

Ruft den Tokenstatus für jede konfigurierte Verbindung für den angegebenen Benutzer ab.
abstract java.util.concurrent.CompletableFuture<TokenResponse> getUserToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String magicCode)

Versucht, das Token für einen Benutzer abzurufen, der sich in einem Anmeldeablauf befindet, mithilfe von angepassten App--Anmeldeinformationen.
abstract java.util.concurrent.CompletableFuture<TokenResponse> getUserToken(TurnContext turnContext, String connectionName, String magicCode)

Versucht, das Token für einen Benutzer abzurufen, der sich in einem Anmeldeablauf befindet.
default java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext turnContext)

Meldet den Benutzer mit dem Tokenserver ab.
abstract java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId)

Signiert den Benutzer mit dem Tokenserver mit angepassten App--Anmeldeinformationen.
abstract java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext turnContext, String connectionName, String userId)

Meldet den Benutzer mit dem Tokenserver ab.

Details zur Methode

exchangeToken

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

Führt einen Tokenaustauschvorgang aus, z. B. für einmaliges Anmelden.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
oAuthAppCredentials - AppCredentials für OAuth.
connectionName - Name der zu verwendenden Authentifizierungsverbindung.
userId - Die Benutzer-ID, die dem Token zugeordnet ist.
exchangeRequest - Die Exchange-Anforderungsdetails, entweder ein Token, das ausgetauscht werden soll, oder ein URI zum Austausch.

Gibt zurück:

Wenn die CompletableFuture abgeschlossen ist, wird das ausgetauschte Token zurückgegeben.

exchangeToken

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

Führt einen Tokenaustauschvorgang aus, z. B. für einmaliges Anmelden.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
connectionName - Name der zu verwendenden Authentifizierungsverbindung.
userId - Die Benutzer-ID, die dem Token zugeordnet ist.
exchangeRequest - Die Exchange-Anforderungsdetails, entweder ein Token, das ausgetauscht werden soll, oder ein URI zum Austausch.

Gibt zurück:

Wenn die CompletableFuture abgeschlossen ist, wird das ausgetauschte Token zurückgegeben.

getAadTokens

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

Ruft Azure Active Directory-Token für bestimmte Ressourcen für eine konfigurierte Verbindung mithilfe von angepassten AppCredentials ab.

Parameter:

context - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
oAuthAppCredentials - AppCredentials für OAuth.
connectionName - Der Name der Mit diesem Bot konfigurierten Azure Active Directory-Verbindung.
resourceUrls - Die Liste der Ressourcen-URLs, für die Token abgerufen werden sollen.
userId - Die Benutzer-ID, für die Token abgerufen werden. Wenn die UserId in NULL übergeben wird, wird die UserId aus der Aktivität im TurnContext übernommen.

Gibt zurück:

Wörterbuch von resourceUrl zum entsprechenden TokenResponse.

getAadTokens

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

Ruft Azure Active Directory-Token für bestimmte Ressourcen in einer konfigurierten Verbindung ab.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
connectionName - Der Name der Mit diesem Bot konfigurierten Azure Active Directory-Verbindung.
resourceUrls - Die Liste der Ressourcen-URLs, für die Token abgerufen werden sollen.

Gibt zurück:

Wörterbuch von resourceUrl zum entsprechenden TokenResponse.

getAadTokens

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

Ruft Azure Active Directory-Token für bestimmte Ressourcen in einer konfigurierten Verbindung ab.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
connectionName - Der Name der Mit diesem Bot konfigurierten Azure Active Directory-Verbindung.
resourceUrls - Die Liste der Ressourcen-URLs, für die Token abgerufen werden sollen.
userId - Die Benutzer-ID, für die Token abgerufen werden. Wenn die UserId von der Aktivität im ITurnContext übergeben wird, wird die userId übergeben.

Gibt zurück:

Wörterbuch von resourceUrl zum entsprechenden TokenResponse.

getOAuthSignInLink

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

Rufen Sie den unformatierten Anmeldelink ab, der mit angepassten AppCredentials an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
oAuthAppCredentials - AppCredentials für OAuth.
connectionName - Name der zu verwendenden Authentifizierungsverbindung.

Gibt zurück:

Eine CompletableFuture, die die auszuführende Arbeitswarteschlange darstellt. Wenn die CompletableFuture erfolgreich abgeschlossen ist, enthält das Ergebnis den unformatierten Signin-Link.

getOAuthSignInLink

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

Rufen Sie den unformatierten Anmeldelink ab, der mit angepassten AppCredentials an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
oAuthAppCredentials - AppCredentials für OAuth.
connectionName - Name der zu verwendenden Authentifizierungsverbindung.
userId - Die Benutzer-ID, die dem Token zugeordnet wird.
finalRedirect - Die endgültige URL, zu der der OAuth-Fluss umgeleitet wird.

Gibt zurück:

Eine CompletableFuture, die die auszuführende Arbeitswarteschlange darstellt. Wenn die CompletableFuture erfolgreich abgeschlossen ist, enthält das Ergebnis den unformatierten Signin-Link.

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, String connectionName)

Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
connectionName - Name der zu verwendenden Authentifizierungsverbindung.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt. Wenn die Aufgabe erfolgreich abgeschlossen wird, enthält das Ergebnis den unformatierten Anmeldelink.

getOAuthSignInLink

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

Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
connectionName - Name der zu verwendenden Authentifizierungsverbindung.
userId - Die Benutzer-ID, die dem Token zugeordnet wird.
finalRedirect - Die endgültige URL, zu der der OAuth-Fluss umgeleitet wird.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt. Wenn die Aufgabe erfolgreich abgeschlossen wird, enthält das Ergebnis den unformatierten Anmeldelink.

getSignInResource

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

Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
oAuthAppCredentials - Anmeldeinformationen für OAuth.
connectionName - Name der zu verwendenden Authentifizierungsverbindung.
userId - Die Benutzer-ID, die dem Token zugeordnet wird.
finalRedirect - Die endgültige URL, zu der der OAuth-Fluss umgeleitet wird.

Gibt zurück:

Eine CompletableFuture, die die auszuführende Arbeitswarteschlange darstellt. Wenn die CompletableFuture erfolgreich abgeschlossen ist, enthält das Ergebnis den unformatierten Signin-Link.

getSignInResource

public abstract CompletableFuture getSignInResource(TurnContext turnContext, String connectionName)

Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
connectionName - Name der zu verwendenden Authentifizierungsverbindung.

Gibt zurück:

Eine CompletableFuture, die die auszuführende Arbeitswarteschlange darstellt. Wenn die CompletableFuture erfolgreich abgeschlossen ist, enthält das Ergebnis den unformatierten Signin-Link.

getSignInResource

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

Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
connectionName - Name der zu verwendenden Authentifizierungsverbindung.
userId - Die Benutzer-ID, die dem Token zugeordnet wird.
finalRedirect - Die endgültige URL, zu der der OAuth-Fluss umgeleitet wird.

Gibt zurück:

Eine CompletableFuture, die die auszuführende Arbeitswarteschlange darstellt. Wenn die CompletableFuture erfolgreich abgeschlossen ist, enthält das Ergebnis den unformatierten Signin-Link.

getTokenStatus

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

Ruft den Tokenstatus für jede konfigurierte Verbindung für den angegebenen Benutzer mithilfe von angepassten AppCredentials ab.

Parameter:

context - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
oAuthAppCredentials - AppCredentials für OAuth.
userId - Die Benutzer-ID, für die der Tokenstatus abgerufen wird.
includeFilter - Optionale durch Trennzeichen getrennte Liste der einzuschließden Verbindungen. Leer gibt den Tokenstatus für alle konfigurierten Verbindungen zurück.

Gibt zurück:

Array von TokenStatus.

getTokenStatus

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

Ruft den Tokenstatus für jede konfigurierte Verbindung für den angegebenen Benutzer ab.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
userId - Die Benutzer-ID, für die der Tokenstatus abgerufen wird.

Gibt zurück:

Array von TokenStatus.

getTokenStatus

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

Ruft den Tokenstatus für jede konfigurierte Verbindung für den angegebenen Benutzer ab.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
userId - Die Benutzer-ID, für die der Tokenstatus abgerufen wird.
includeFilter - Kommagetrennte Liste der einzuschließden Verbindungen. Leer gibt den Tokenstatus für alle konfigurierten Verbindungen zurück.

Gibt zurück:

Array von TokenStatus.

getUserToken

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

Versucht, das Token für einen Benutzer abzurufen, der sich in einem Anmeldefluss befindet, mithilfe von angepassten AppCredentials.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
oAuthAppCredentials - AppCredentials für OAuth.
connectionName - Name der zu verwendenden Authentifizierungsverbindung.
magicCode - (Optional) Optionaler Benutzer hat Code eingegeben, der überprüft werden soll.

Gibt zurück:

Tokenantwort.

getUserToken

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

Versucht, das Token für einen Benutzer abzurufen, der sich in einem Anmeldeablauf befindet.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
connectionName - Name der zu verwendenden Authentifizierungsverbindung.
magicCode - (Optional) Optionaler Benutzer hat Code eingegeben, der überprüft werden soll.

Gibt zurück:

Tokenantwort.

signOutUser

public default CompletableFuture signOutUser(TurnContext turnContext)

Meldet den Benutzer mit dem Tokenserver ab.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

signOutUser

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

Signiert den Benutzer mit dem Tokenserver mit angepassten AppCredentials.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
oAuthAppCredentials - AppCredentials für OAuth.
connectionName - Name der zu verwendenden Authentifizierungsverbindung.
userId - Benutzer-ID des Benutzers, um sich abzumelden.

Gibt zurück:

Eine CompletableFuture, die die auszuführende Arbeitswarteschlange darstellt.

signOutUser

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

Meldet den Benutzer mit dem Tokenserver ab.

Parameter:

turnContext - Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
connectionName - Name der zu verwendenden Authentifizierungsverbindung.
userId - Benutzer-ID des Benutzers, um sich abzumelden.

Gibt zurück:

Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

Gilt für: