ExtendedUserTokenProvider interface
Warnung
Diese API ist nun veraltet.
Use UserTokenClient instead.
Schnittstelle für benutzertoken OAuth Single Sign On and Token Exchange APIs for BotAdapters
- Extends
Methoden
| exchange |
Führt einen Tokenaustauschvorgang aus, z. B. für einmaliges Anmelden. |
| exchange |
Führt einen Tokenaustauschvorgang aus, z. B. für einmaliges Anmelden. |
| 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 |
Rufen Sie die unformatierte Anmelderessource ab, die für die Anmeldung für einen Verbindungsnamen an den Benutzer gesendet werden soll. |
| get |
Rufen Sie die unformatierte Anmelderessource ab, die für die Anmeldung für einen Verbindungsnamen an den Benutzer gesendet werden soll. |
| get |
Rufen Sie die unformatierte Anmelderessource ab, die für die Anmeldung für einen Verbindungsnamen an den Benutzer gesendet werden soll. |
| get |
Ruft das OAuth-Token für einen Benutzer ab, der sich in einem Anmeldeablauf befindet. |
| sign |
Meldet den Benutzer mit dem Tokenserver ab. |
Geerbte Methoden
| get |
Ruft den Tokenstatus für jede konfigurierte Verbindung für den angegebenen Benutzer mithilfe der AppCredentials des Bots ab. |
Details zur Methode
exchangeToken(TurnContext, string, string, TokenExchangeRequest)
Führt einen Tokenaustauschvorgang aus, z. B. für einmaliges Anmelden.
function exchangeToken(context: TurnContext, connectionName: string, userId: string, tokenExchangeRequest: TokenExchangeRequest): Promise<TokenResponse>Parameter
- context
- TurnContext
Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
- connectionName
-
string
Name der zu verwendenden Authentifizierungsverbindung.
- userId
-
string
Die Benutzer-ID, die dem Token zugeordnet wird.
- tokenExchangeRequest
-
TokenExchangeRequest
Die Exchange-Anforderungsdetails, entweder ein Token, das ausgetauscht werden soll, oder ein URI zum Austausch.
Gibt zurück
Promise<TokenResponse>
exchangeToken(TurnContext, string, string, TokenExchangeRequest, CoreAppCredentials)
Führt einen Tokenaustauschvorgang aus, z. B. für einmaliges Anmelden.
function exchangeToken(context: TurnContext, connectionName: string, userId: string, tokenExchangeRequest: TokenExchangeRequest, appCredentials: CoreAppCredentials): Promise<TokenResponse>Parameter
- context
- TurnContext
Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
- connectionName
-
string
Name der zu verwendenden Authentifizierungsverbindung.
- userId
-
string
Die Benutzer-ID, die dem Token zugeordnet wird.
- tokenExchangeRequest
-
TokenExchangeRequest
Die Exchange-Anforderungsdetails, entweder ein Token, das ausgetauscht werden soll, oder ein URI zum Austausch.
- appCredentials
- CoreAppCredentials
Gibt zurück
Promise<TokenResponse>
getAadTokens(TurnContext, string, string[], CoreAppCredentials)
Meldet den Benutzer mit dem Tokenserver ab.
function getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[], appCredentials?: CoreAppCredentials): 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[]
- appCredentials
- CoreAppCredentials
Gibt zurück
Promise<[key: string]: TokenResponse>
getSignInLink(TurnContext, string, CoreAppCredentials)
Ruft einen Signin-Link vom Tokenserver ab, der als Teil einer SigninCard gesendet werden kann.
function getSignInLink(context: TurnContext, connectionName: string, appCredentials?: CoreAppCredentials): Promise<string>Parameter
- context
- TurnContext
Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
- connectionName
-
string
Name der zu verwendenden Authentifizierungsverbindung.
- appCredentials
- CoreAppCredentials
Gibt zurück
Promise<string>
getSignInResource(TurnContext, string)
Rufen Sie die unformatierte Anmelderessource ab, die für die Anmeldung für einen Verbindungsnamen an den Benutzer gesendet werden soll.
function getSignInResource(context: TurnContext, connectionName: string): Promise<SignInUrlResponse>Parameter
- context
- TurnContext
Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
- connectionName
-
string
Name der zu verwendenden Authentifizierungsverbindung.
Gibt zurück
Promise<SignInUrlResponse>
getSignInResource(TurnContext, string, string, string)
Rufen Sie die unformatierte Anmelderessource ab, die für die Anmeldung für einen Verbindungsnamen an den Benutzer gesendet werden soll.
function getSignInResource(context: TurnContext, connectionName: string, userId: string, finalRedirect?: string): Promise<SignInUrlResponse>Parameter
- context
- TurnContext
Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
- connectionName
-
string
Name der zu verwendenden Authentifizierungsverbindung.
- userId
-
string
Die Benutzer-ID, die dem Token zugeordnet wird.
- finalRedirect
-
string
Die endgültige URL, zu der der OAuth-Fluss umgeleitet wird.
Gibt zurück
Promise<SignInUrlResponse>
getSignInResource(TurnContext, string, string, string, CoreAppCredentials)
Rufen Sie die unformatierte Anmelderessource ab, die für die Anmeldung für einen Verbindungsnamen an den Benutzer gesendet werden soll.
function getSignInResource(context: TurnContext, connectionName: string, userId: string, finalRedirect?: string, appCredentials?: CoreAppCredentials): Promise<SignInUrlResponse>Parameter
- context
- TurnContext
Kontext für die aktuelle Unterhaltungswende mit dem Benutzer.
- connectionName
-
string
Name der zu verwendenden Authentifizierungsverbindung.
- userId
-
string
Die Benutzer-ID, die dem Token zugeordnet wird.
- finalRedirect
-
string
Die endgültige URL, zu der der OAuth-Fluss umgeleitet wird.
- appCredentials
- CoreAppCredentials
Gibt zurück
Promise<SignInUrlResponse>
getUserToken(TurnContext, string, string, CoreAppCredentials)
Ruft das OAuth-Token für einen Benutzer ab, der sich in einem Anmeldeablauf befindet.
function getUserToken(context: TurnContext, connectionName: string, magicCode?: string, appCredentials?: CoreAppCredentials): 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.
- appCredentials
- CoreAppCredentials
Gibt zurück
Promise<TokenResponse>
signOutUser(TurnContext, string, string, CoreAppCredentials)
Meldet den Benutzer mit dem Tokenserver ab.
function signOutUser(context: TurnContext, connectionName: string, userId?: string, appCredentials?: CoreAppCredentials): 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.
- appCredentials
- CoreAppCredentials
Gibt zurück
Promise<void>
Details zur geerbten Methode
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[]>