IUserTokenProvider interface
Warnung
Diese API ist nun veraltet.
Use UserTokenClient
instead.
Schnittstelle für OAuth-APIs für Benutzertoken für BotAdapters
Methoden
get |
Meldet den Benutzer mit dem Tokenserver ab. |
get |
Ruft einen Signin-Link vom Tokenserver ab, der als Teil einer SigninCard gesendet werden kann. |
get |
Ruft den Tokenstatus für jede konfigurierte Verbindung für den angegebenen Benutzer mithilfe der AppCredentials des Bots ab. |
get |
Ruft das OAuth-Token für einen Benutzer ab, der sich in einem Anmeldeablauf befindet. |
sign |
Meldet den Benutzer mit dem Tokenserver ab. |
Details zur Methode
getAadTokens(TurnContext, string, string[])
Meldet den Benutzer mit dem Tokenserver ab.
function getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[]): Promise<[key: string]: TokenResponse>
Parameter
- context
- TurnContext
Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
- connectionName
-
string
Name der zu verwendenden Authentifizierungsverbindung.
- resourceUrls
-
string[]
Gibt zurück
Promise<[key: string]: TokenResponse>
getSignInLink(TurnContext, string)
Ruft einen Signin-Link vom Tokenserver ab, der als Teil einer SigninCard gesendet werden kann.
function getSignInLink(context: TurnContext, connectionName: string): Promise<string>
Parameter
- context
- TurnContext
Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
- connectionName
-
string
Name der zu verwendenden Authentifizierungsverbindung.
Gibt zurück
Promise<string>
getTokenStatus(TurnContext, string, string, any)
Ruft den Tokenstatus für jede konfigurierte Verbindung für den angegebenen Benutzer mithilfe der AppCredentials des Bots ab.
function getTokenStatus(context: TurnContext, userId: string, includeFilter?: string, oAuthAppCredentials?: any): Promise<any[]>
Parameter
- context
- TurnContext
Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
- userId
-
string
Die Benutzer-ID, für die der Tokenstatus abgerufen wird.
- includeFilter
-
string
Kommagetrennte Liste der einzuschließden Verbindungen. Leer gibt den Tokenstatus für alle konfigurierten Verbindungen zurück.
- oAuthAppCredentials
-
any
Die App-Anmeldeinformationen für OAuth.
Gibt zurück
Promise<any[]>
getUserToken(TurnContext, string, string)
Ruft das OAuth-Token für einen Benutzer ab, der sich in einem Anmeldeablauf befindet.
function getUserToken(context: TurnContext, connectionName: string, magicCode?: string): Promise<TokenResponse>
Parameter
- context
- TurnContext
Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
- connectionName
-
string
Name der zu verwendenden Authentifizierungsverbindung.
- magicCode
-
string
(Optional) Optionaler Benutzer hat Code eingegeben, der überprüft werden soll.
Gibt zurück
Promise<TokenResponse>
signOutUser(TurnContext, string, string)
Meldet den Benutzer mit dem Tokenserver ab.
function signOutUser(context: TurnContext, connectionName: string, userId?: string): Promise<void>
Parameter
- context
- TurnContext
Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
- connectionName
-
string
Name der zu verwendenden Authentifizierungsverbindung.
- userId
-
string
Benutzer-ID des Benutzers, um sich abzumelden.
Gibt zurück
Promise<void>