UserTokenClientImpl class
- Extends
Constructeurs
User |
Méthodes
exchange |
Effectue une opération d’échange de jetons telle que pour l’authentification unique. |
get |
Récupère des jetons Azure Active Directory pour des ressources particulières sur une connexion configurée. |
get |
Obtenez de manière asynchrone la ressource de connexion brute à envoyer à l’utilisateur pour la connexion. |
get |
Récupère l’état du jeton pour chaque connexion configurée pour l’utilisateur donné. |
get |
Tente de récupérer le jeton d’un utilisateur qui se trouve dans un flux de connexion. |
sign |
Déconnecte l’utilisateur avec le serveur de jetons. |
Détails du constructeur
UserTokenClientImpl(string, ServiceClientCredentials, string, ConnectorClientOptions)
new UserTokenClientImpl(appId: string, credentials: ServiceClientCredentials, oauthEndpoint: string, connectorClientOptions?: ConnectorClientOptions)
Paramètres
- appId
-
string
AppId.
- credentials
-
ServiceClientCredentials
AppCredentials pour OAuth.
- oauthEndpoint
-
string
Point de terminaison de l’API OAuth.
- connectorClientOptions
- ConnectorClientOptions
Objet ConnectorClientOptions.
Détails de la méthode
exchangeToken(string, string, string, TokenExchangeRequest)
Effectue une opération d’échange de jetons telle que pour l’authentification unique.
function exchangeToken(userId: string, connectionName: string, channelId: string, exchangeRequest: TokenExchangeRequest): Promise<TokenResponse>
Paramètres
- userId
-
string
ID d’utilisateur qui sera associé au jeton.
- connectionName
-
string
Nom de la connexion d’authentification à utiliser.
- channelId
-
string
ID de canal qui sera associé au jeton.
- exchangeRequest
-
TokenExchangeRequest
Détails de la demande d’échange, un jeton à échanger ou un URI à échanger.
Retours
Promise<TokenResponse>
Promesse représentant le résultat de l’opération.
getAadTokens(string, string, string[], string)
Récupère des jetons Azure Active Directory pour des ressources particulières sur une connexion configurée.
function getAadTokens(userId: string, connectionName: string, resourceUrls: string[], channelId: string): Promise<Record<string, TokenResponse>>
Paramètres
- userId
-
string
ID d’utilisateur qui sera associé au jeton.
- connectionName
-
string
Nom de la connexion d’authentification à utiliser.
- resourceUrls
-
string[]
Liste des URL de ressource pour laquelle récupérer des jetons.
- channelId
-
string
ID de canal qui sera associé au jeton.
Retours
Promise<Record<string, TokenResponse>>
Promesse du dictionnaire de resourceUrl au tokenResponse correspondant.
getSignInResource(string, Activity, string)
Obtenez de manière asynchrone la ressource de connexion brute à envoyer à l’utilisateur pour la connexion.
function getSignInResource(connectionName: string, activity: Activity, finalRedirect: string): Promise<SignInUrlResponse>
Paramètres
- connectionName
-
string
Nom de la connexion d’authentification à utiliser.
- activity
-
Activity
Activité à partir de laquelle dériver l’état d’échange de jeton.
- finalRedirect
-
string
URL finale vers laquelle le flux OAuth redirige.
Retours
Promise<SignInUrlResponse>
Ressource SignInUrlResponse.
getTokenStatus(string, string, string)
Récupère l’état du jeton pour chaque connexion configurée pour l’utilisateur donné.
function getTokenStatus(userId: string, channelId: string, includeFilter: string): Promise<TokenStatus[]>
Paramètres
- userId
-
string
ID d’utilisateur qui sera associé au jeton.
- channelId
-
string
ID de canal qui sera associé au jeton.
- includeFilter
-
string
IncludeFilter.
Retours
Promise<TokenStatus[]>
Promesse avec un tableau de l’état du jeton.
getUserToken(string, string, string, string)
Tente de récupérer le jeton d’un utilisateur qui se trouve dans un flux de connexion.
function getUserToken(userId: string, connectionName: string, channelId: string, magicCode: string): Promise<TokenResponse>
Paramètres
- userId
-
string
ID d’utilisateur qui sera associé au jeton.
- connectionName
-
string
Nom de la connexion d’authentification à utiliser.
- channelId
-
string
ID de canal qui sera associé au jeton.
- magicCode
-
string
(Facultatif) Un utilisateur facultatif a entré du code pour valider.
Retours
Promise<TokenResponse>
Réponse du jeton.
signOutUser(string, string, string)
Déconnecte l’utilisateur avec le serveur de jetons.
function signOutUser(userId: string, connectionName: string, channelId: string): Promise<void>
Paramètres
- userId
-
string
ID d’utilisateur qui sera associé au jeton.
- connectionName
-
string
Nom de la connexion d’authentification à utiliser.
- channelId
-
string
ID de canal qui sera associé au jeton.
Retours
Promise<void>