ExtendedUserTokenProvider interface
Avviso
Questa API è ora deprecata.
Use UserTokenClient instead.
Interfaccia per le API OAuth per l'accesso Single Sign-On e l'scambio di token per BotAdapter
- Extends
Metodi
| exchange |
Esegue un'operazione di scambio di token, ad esempio per l'accesso Single Sign-On. |
| exchange |
Esegue un'operazione di scambio di token, ad esempio per l'accesso Single Sign-On. |
| get |
Disconnette l'utente con il server token. |
| get |
Ottiene un collegamento di accesso dal server token che può essere inviato come parte di signinCard. |
| get |
Ottenere la risorsa di accesso non elaborata da inviare all'utente per l'accesso per un nome di connessione. |
| get |
Ottenere la risorsa di accesso non elaborata da inviare all'utente per l'accesso per un nome di connessione. |
| get |
Ottenere la risorsa di accesso non elaborata da inviare all'utente per l'accesso per un nome di connessione. |
| get |
Recupera il token OAuth per un utente che si trova in un flusso di accesso. |
| sign |
Disconnette l'utente con il server token. |
Metodi ereditati
| get |
Recupera lo stato del token per ogni connessione configurata per l'utente specificato, usando le credenziali app del bot. |
Dettagli metodo
exchangeToken(TurnContext, string, string, TokenExchangeRequest)
Esegue un'operazione di scambio di token, ad esempio per l'accesso Single Sign-On.
function exchangeToken(context: TurnContext, connectionName: string, userId: string, tokenExchangeRequest: TokenExchangeRequest): Promise<TokenResponse>Parametri
- context
- TurnContext
Contesto per il turno di conversazione corrente con l'utente.
- connectionName
-
string
Nome della connessione di autenticazione da usare.
- userId
-
string
ID utente che verrà associato al token.
- tokenExchangeRequest
-
TokenExchangeRequest
Dettagli della richiesta di scambio, un token da scambiare o un URI da scambiare.
Restituisce
Promise<TokenResponse>
exchangeToken(TurnContext, string, string, TokenExchangeRequest, CoreAppCredentials)
Esegue un'operazione di scambio di token, ad esempio per l'accesso Single Sign-On.
function exchangeToken(context: TurnContext, connectionName: string, userId: string, tokenExchangeRequest: TokenExchangeRequest, appCredentials: CoreAppCredentials): Promise<TokenResponse>Parametri
- context
- TurnContext
Contesto per il turno di conversazione corrente con l'utente.
- connectionName
-
string
Nome della connessione di autenticazione da usare.
- userId
-
string
ID utente che verrà associato al token.
- tokenExchangeRequest
-
TokenExchangeRequest
Dettagli della richiesta di scambio, un token da scambiare o un URI da scambiare.
- appCredentials
- CoreAppCredentials
Restituisce
Promise<TokenResponse>
getAadTokens(TurnContext, string, string[], CoreAppCredentials)
Disconnette l'utente con il server token.
function getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[], appCredentials?: CoreAppCredentials): Promise<[key: string]: TokenResponse>Parametri
- context
- TurnContext
Contesto per il turno di conversazione corrente con l'utente.
- connectionName
-
string
Nome della connessione di autenticazione da usare.
- resourceUrls
-
string[]
- appCredentials
- CoreAppCredentials
Restituisce
Promise<[key: string]: TokenResponse>
getSignInLink(TurnContext, string, CoreAppCredentials)
Ottiene un collegamento di accesso dal server token che può essere inviato come parte di signinCard.
function getSignInLink(context: TurnContext, connectionName: string, appCredentials?: CoreAppCredentials): Promise<string>Parametri
- context
- TurnContext
Contesto per il turno di conversazione corrente con l'utente.
- connectionName
-
string
Nome della connessione di autenticazione da usare.
- appCredentials
- CoreAppCredentials
Restituisce
Promise<string>
getSignInResource(TurnContext, string)
Ottenere la risorsa di accesso non elaborata da inviare all'utente per l'accesso per un nome di connessione.
function getSignInResource(context: TurnContext, connectionName: string): Promise<SignInUrlResponse>Parametri
- context
- TurnContext
Contesto per il turno di conversazione corrente con l'utente.
- connectionName
-
string
Nome della connessione di autenticazione da usare.
Restituisce
Promise<SignInUrlResponse>
getSignInResource(TurnContext, string, string, string)
Ottenere la risorsa di accesso non elaborata da inviare all'utente per l'accesso per un nome di connessione.
function getSignInResource(context: TurnContext, connectionName: string, userId: string, finalRedirect?: string): Promise<SignInUrlResponse>Parametri
- context
- TurnContext
Contesto per il turno di conversazione corrente con l'utente.
- connectionName
-
string
Nome della connessione di autenticazione da usare.
- userId
-
string
ID utente che verrà associato al token.
- finalRedirect
-
string
URL finale a cui verrà reindirizzato il flusso OAuth.
Restituisce
Promise<SignInUrlResponse>
getSignInResource(TurnContext, string, string, string, CoreAppCredentials)
Ottenere la risorsa di accesso non elaborata da inviare all'utente per l'accesso per un nome di connessione.
function getSignInResource(context: TurnContext, connectionName: string, userId: string, finalRedirect?: string, appCredentials?: CoreAppCredentials): Promise<SignInUrlResponse>Parametri
- context
- TurnContext
Contesto per il turno di conversazione corrente con l'utente.
- connectionName
-
string
Nome della connessione di autenticazione da usare.
- userId
-
string
ID utente che verrà associato al token.
- finalRedirect
-
string
URL finale a cui verrà reindirizzato il flusso OAuth.
- appCredentials
- CoreAppCredentials
Restituisce
Promise<SignInUrlResponse>
getUserToken(TurnContext, string, string, CoreAppCredentials)
Recupera il token OAuth per un utente che si trova in un flusso di accesso.
function getUserToken(context: TurnContext, connectionName: string, magicCode?: string, appCredentials?: CoreAppCredentials): Promise<TokenResponse>Parametri
- context
- TurnContext
Contesto per il turno di conversazione corrente con l'utente.
- connectionName
-
string
Nome della connessione di autenticazione da usare.
- magicCode
-
string
(Facoltativo) Codice immesso dall'utente facoltativo da convalidare.
- appCredentials
- CoreAppCredentials
Restituisce
Promise<TokenResponse>
signOutUser(TurnContext, string, string, CoreAppCredentials)
Disconnette l'utente con il server token.
function signOutUser(context: TurnContext, connectionName: string, userId?: string, appCredentials?: CoreAppCredentials): Promise<void>Parametri
- context
- TurnContext
Contesto per il turno di conversazione corrente con l'utente.
- connectionName
-
string
Nome della connessione di autenticazione da usare.
- userId
-
string
ID utente dell'utente da disconnettere.
- appCredentials
- CoreAppCredentials
Restituisce
Promise<void>
Dettagli dei metodi ereditati
getTokenStatus(TurnContext, string, string, any)
Recupera lo stato del token per ogni connessione configurata per l'utente specificato, usando le credenziali app del bot.
function getTokenStatus(context: TurnContext, userId: string, includeFilter?: string, oAuthAppCredentials?: any): Promise<any[]>Parametri
- context
- TurnContext
Contesto per il turno di conversazione corrente con l'utente.
- userId
-
string
ID utente per il quale viene recuperato lo stato del token.
- includeFilter
-
string
Elenco delimitato da virgole della connessione da includere. Blank restituirà lo stato del token per tutte le connessioni configurate.
- oAuthAppCredentials
-
any
Credenziali dell'app per OAuth.
Restituisce
Promise<any[]>
ereditato daIUserTokenProvider.getTokenStatus