Freigeben über


IUserTokenProvider interface

Warnung

Diese API ist nun veraltet.

Use UserTokenClient instead.

Schnittstelle für Benutzertoken-OAuth-APIs für BotAdapters

Methoden

getAadTokens(TurnContext, string, string[])

Meldet den Benutzer mit dem Tokenserver ab.

getSignInLink(TurnContext, string)

Ruft einen Anmeldelink vom Tokenserver ab, der als Teil einer SigninCard gesendet werden kann.

getTokenStatus(TurnContext, string, string, any)

Ruft den Tokenstatus für jede konfigurierte Verbindung für den angegebenen Benutzer mithilfe der AppCredentials des Bots ab.

getUserToken(TurnContext, string, string)

Ruft das OAuth-Token für einen Benutzer ab, der sich in einem Anmeldeflow befindet.

signOutUser(TurnContext, string, string)

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 den aktuellen Gesprächsverlauf mit dem Benutzer.

connectionName

string

Name der zu verwendenden Authentifizierungsverbindung.

resourceUrls

string[]

Gibt zurück

Promise<[key: string]: TokenResponse>

Ruft einen Anmeldelink 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 den aktuellen Gesprächsverlauf 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 den aktuellen Gesprächsverlauf mit dem Benutzer.

userId

string

Die Benutzer-ID, für die der Tokenstatus abgerufen wird.

includeFilter

string

Durch Trennzeichen getrennte Liste der einzuschließenden 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 Anmeldeflow befindet.

function getUserToken(context: TurnContext, connectionName: string, magicCode?: string): Promise<TokenResponse>

Parameter

context
TurnContext

Kontext für den aktuellen Gesprächsverlauf mit dem Benutzer.

connectionName

string

Name der zu verwendenden Authentifizierungsverbindung.

magicCode

string

(Optional) Optionaler benutzerseitig eingegebener Code zur Überprüfung.

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 den aktuellen Gesprächsverlauf mit dem Benutzer.

connectionName

string

Name der zu verwendenden Authentifizierungsverbindung.

userId

string

Benutzer-ID des abzumeldenden Benutzers.

Gibt zurück

Promise<void>