UserTokenClientImpl class

Paket:

botframework-connector

Extends

UserTokenClient

Konstruktoren

UserTokenClientImpl(string, ServiceClientCredentials, string, ConnectorClientOptions)

Methoden

exchangeToken(string, string, string, TokenExchangeRequest)	Führt einen Tokenaustauschvorgang aus, z. B. für einmaliges Anmelden.
getAadTokens(string, string, string[], string)	Ruft Azure Active Directory-Token für bestimmte Ressourcen für eine konfigurierte Verbindung ab.
getSignInResource(string, Activity, string)	Rufen Sie asynchron die unformatierte Anmelderessource ab, die zur Anmeldung an den Benutzer gesendet werden soll.
getTokenStatus(string, string, string)	Ruft den Tokenstatus für jede konfigurierte Verbindung für den angegebenen Benutzer ab.
getUserToken(string, string, string, string)	Versucht, das Token für einen Benutzer abzurufen, der sich in einem Anmeldeflow befindet.
signOutUser(string, string, string)	Meldet den Benutzer mit dem Tokenserver ab.

Details zum Konstruktor

UserTokenClientImpl(string, ServiceClientCredentials, string, ConnectorClientOptions)

new UserTokenClientImpl(appId: string, credentials: ServiceClientCredentials, oauthEndpoint: string, connectorClientOptions?: ConnectorClientOptions)

Parameter

appId

string

Die appId.

credentials

ServiceClientCredentials

AppCredentials für OAuth.

oauthEndpoint

string

Der OAuth-API-Endpunkt.

connectorClientOptions

ConnectorClientOptions

Ein ConnectorClientOptions-Objekt.

Details zur Methode

exchangeToken(string, string, string, TokenExchangeRequest)

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

function exchangeToken(userId: string, connectionName: string, channelId: string, exchangeRequest: TokenExchangeRequest): Promise<TokenResponse>

Parameter

userId

string

Die Benutzer-ID, die dem Token zugeordnet wird.

connectionName

string

Name der zu verwendenden Authentifizierungsverbindung.

channelId

string

Die Kanal-ID, die dem Token zugeordnet wird.

exchangeRequest

TokenExchangeRequest

Die Exchange-Anforderungsdetails, entweder ein zu tauschende Token oder ein URI für den Austausch.

Gibt zurück

Promise<TokenResponse>

Eine Zusage, die das Ergebnis des Vorgangs darstellt.

getAadTokens(string, string, string[], string)

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

function getAadTokens(userId: string, connectionName: string, resourceUrls: string[], channelId: string): Promise<Record<string, TokenResponse>>

Parameter

userId

string

Die Benutzer-ID, die dem Token zugeordnet wird.

connectionName

string

Name der zu verwendenden Authentifizierungsverbindung.

resourceUrls

string[]

Die Liste der Ressourcen-URLs, für die Token abgerufen werden sollen.

channelId

string

Die Kanal-ID, die dem Token zugeordnet wird.

Gibt zurück

Promise<Record<string, TokenResponse>>

Eine Zusage des Wörterbuchs von resourceUrl an den entsprechenden TokenResponse.

getSignInResource(string, Activity, string)

Rufen Sie asynchron die unformatierte Anmelderessource ab, die zur Anmeldung an den Benutzer gesendet werden soll.

function getSignInResource(connectionName: string, activity: Activity, finalRedirect: string): Promise<SignInUrlResponse>

Parameter

connectionName

string

Name der zu verwendenden Authentifizierungsverbindung.

activity

Activity

Die Aktivität, von der der Tokenaustauschstatus abgeleitet werden soll.

finalRedirect

string

Die endgültige URL, an die der OAuth-Flow umgeleitet wird.

Gibt zurück

Promise<SignInUrlResponse>

Die SignInUrlResponse-Ressource .

getTokenStatus(string, string, string)

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

function getTokenStatus(userId: string, channelId: string, includeFilter: string): Promise<TokenStatus[]>

Parameter

userId

string

Die Benutzer-ID, die dem Token zugeordnet wird.

channelId

string

Die Kanal-ID, die dem Token zugeordnet wird.

includeFilter

string

Der includeFilter.

Gibt zurück

Promise<TokenStatus[]>

Eine Zusage mit einem Array des Tokenstatus.

getUserToken(string, string, string, string)

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

function getUserToken(userId: string, connectionName: string, channelId: string, magicCode: string): Promise<TokenResponse>

Parameter

userId

string

Die Benutzer-ID, die dem Token zugeordnet wird.

connectionName

string

Name der zu verwendenden Authentifizierungsverbindung.

channelId

string

Die Kanal-ID, die dem Token zugeordnet wird.

magicCode

string

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

Gibt zurück

Promise<TokenResponse>

Die Tokenantwort.

signOutUser(string, string, string)

Meldet den Benutzer mit dem Tokenserver ab.

function signOutUser(userId: string, connectionName: string, channelId: string): Promise<void>

Parameter

userId

string

Die Benutzer-ID, die dem Token zugeordnet wird.

connectionName

string

Name der zu verwendenden Authentifizierungsverbindung.

channelId

string

Die Kanal-ID, die dem Token zugeordnet wird.

Gibt zurück

Promise<void>