UserTokenClient class
Client für den Benutzertokendienst.
Methoden
exchange |
Führt einen Tokenaustauschvorgang aus, z. B. für einmaliges Anmelden. |
get |
Ruft Azure Active Directory-Token für bestimmte Ressourcen in einer konfigurierten Verbindung ab. |
get |
Rufen Sie den unformatierten Anmeldelink ab, der für die Anmeldung für einen Verbindungsnamen an den Benutzer gesendet werden soll. |
get |
Ruft den Tokenstatus für jede konfigurierte Verbindung für den angegebenen Benutzer ab. |
get |
Versucht, das Token für einen Benutzer abzurufen, der sich in einem Anmeldeflow befindet. |
sign |
Meldet den Benutzer mit dem Tokenserver ab. |
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>
Ein TokenResponse-Objekt .
getAadTokens(string, string, string[], string)
Ruft Azure Active Directory-Token für bestimmte Ressourcen in einer konfigurierten 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>>
Ein Dictionary of resourceUrls to the entsprechenden TokenResponse.
getSignInResource(string, Activity, string)
Rufen Sie den unformatierten Anmeldelink ab, der für die Anmeldung für einen Verbindungsnamen an den Benutzer gesendet werden soll.
function getSignInResource(connectionName: string, activity: Activity, finalRediect: string): Promise<SignInUrlResponse>
Parameter
- connectionName
-
string
Name der zu verwendenden Authentifizierungsverbindung.
- activity
-
Activity
Die Aktivität , von der der Tokenaustauschzustand abgeleitet werden soll.
- finalRediect
-
string
Die endgültige URL, an die der OAuth-Flow weitergeleitet wird.
Gibt zurück
Promise<SignInUrlResponse>
Ein SignInUrlResponse.
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 Liste von TokenStatus-Objekten .
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 benutzerseitig eingegebener Code zur Überprüfung.
Gibt zurück
Promise<TokenResponse>
Ein TokenResponse-Objekt .
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>