ExtendedUserTokenProvider interface
Aviso
Essa API foi preterida.
Use UserTokenClient instead.
Interface para OAuth Single Sign On do Token de Usuário e APIs do Exchange de Token para BotAdapters
- Extends
Métodos
| exchange |
Executa uma operação de troca de token, como para logon único. |
| exchange |
Executa uma operação de troca de token, como para logon único. |
| get |
Desconscreve o usuário com o servidor de token. |
| get |
Obtém um link de entrada do servidor de token que pode ser enviado como parte de um SigninCard. |
| get |
Obtenha o recurso de entrada bruto a ser enviado ao usuário para entrar para um nome de conexão. |
| get |
Obtenha o recurso de entrada bruto a ser enviado ao usuário para entrar para um nome de conexão. |
| get |
Obtenha o recurso de entrada bruto a ser enviado ao usuário para entrar para um nome de conexão. |
| get |
Recupera o token OAuth para um usuário que está em um fluxo de entrada. |
| sign |
Desconscreve o usuário com o servidor de token. |
Métodos herdados
| get |
Recupera o status do token para cada conexão configurada para o usuário fornecido, usando o AppCredentials do bot. |
Detalhes do método
exchangeToken(TurnContext, string, string, TokenExchangeRequest)
Executa uma operação de troca de token, como para logon único.
function exchangeToken(context: TurnContext, connectionName: string, userId: string, tokenExchangeRequest: TokenExchangeRequest): Promise<TokenResponse>Parâmetros
- context
- TurnContext
Contexto para a virada atual da conversa com o usuário.
- connectionName
-
string
Nome da conexão de autenticação a ser usada.
- userId
-
string
A ID do usuário que será associada ao token.
- tokenExchangeRequest
-
TokenExchangeRequest
Os detalhes da solicitação de troca, um token a ser trocado ou um uri a ser trocado.
Retornos
Promise<TokenResponse>
exchangeToken(TurnContext, string, string, TokenExchangeRequest, CoreAppCredentials)
Executa uma operação de troca de token, como para logon único.
function exchangeToken(context: TurnContext, connectionName: string, userId: string, tokenExchangeRequest: TokenExchangeRequest, appCredentials: CoreAppCredentials): Promise<TokenResponse>Parâmetros
- context
- TurnContext
Contexto para a virada atual da conversa com o usuário.
- connectionName
-
string
Nome da conexão de autenticação a ser usada.
- userId
-
string
A ID do usuário que será associada ao token.
- tokenExchangeRequest
-
TokenExchangeRequest
Os detalhes da solicitação de troca, um token a ser trocado ou um uri a ser trocado.
- appCredentials
- CoreAppCredentials
Retornos
Promise<TokenResponse>
getAadTokens(TurnContext, string, string[], CoreAppCredentials)
Desconscreve o usuário com o servidor de token.
function getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[], appCredentials?: CoreAppCredentials): Promise<[key: string]: TokenResponse>Parâmetros
- context
- TurnContext
Contexto para a virada atual da conversa com o usuário.
- connectionName
-
string
Nome da conexão de autenticação a ser usada.
- resourceUrls
-
string[]
- appCredentials
- CoreAppCredentials
Retornos
Promise<[key: string]: TokenResponse>
getSignInLink(TurnContext, string, CoreAppCredentials)
Obtém um link de entrada do servidor de token que pode ser enviado como parte de um SigninCard.
function getSignInLink(context: TurnContext, connectionName: string, appCredentials?: CoreAppCredentials): Promise<string>Parâmetros
- context
- TurnContext
Contexto para a virada atual da conversa com o usuário.
- connectionName
-
string
Nome da conexão de autenticação a ser usada.
- appCredentials
- CoreAppCredentials
Retornos
Promise<string>
getSignInResource(TurnContext, string)
Obtenha o recurso de entrada bruto a ser enviado ao usuário para entrar para um nome de conexão.
function getSignInResource(context: TurnContext, connectionName: string): Promise<SignInUrlResponse>Parâmetros
- context
- TurnContext
Contexto para a virada atual da conversa com o usuário.
- connectionName
-
string
Nome da conexão de autenticação a ser usada.
Retornos
Promise<SignInUrlResponse>
getSignInResource(TurnContext, string, string, string)
Obtenha o recurso de entrada bruto a ser enviado ao usuário para entrar para um nome de conexão.
function getSignInResource(context: TurnContext, connectionName: string, userId: string, finalRedirect?: string): Promise<SignInUrlResponse>Parâmetros
- context
- TurnContext
Contexto para a virada atual da conversa com o usuário.
- connectionName
-
string
Nome da conexão de autenticação a ser usada.
- userId
-
string
A ID do usuário que será associada ao token.
- finalRedirect
-
string
A URL final para a qual o fluxo OAuth será redirecionada.
Retornos
Promise<SignInUrlResponse>
getSignInResource(TurnContext, string, string, string, CoreAppCredentials)
Obtenha o recurso de entrada bruto a ser enviado ao usuário para entrar para um nome de conexão.
function getSignInResource(context: TurnContext, connectionName: string, userId: string, finalRedirect?: string, appCredentials?: CoreAppCredentials): Promise<SignInUrlResponse>Parâmetros
- context
- TurnContext
Contexto para a virada atual da conversa com o usuário.
- connectionName
-
string
Nome da conexão de autenticação a ser usada.
- userId
-
string
A ID do usuário que será associada ao token.
- finalRedirect
-
string
A URL final para a qual o fluxo OAuth será redirecionada.
- appCredentials
- CoreAppCredentials
Retornos
Promise<SignInUrlResponse>
getUserToken(TurnContext, string, string, CoreAppCredentials)
Recupera o token OAuth para um usuário que está em um fluxo de entrada.
function getUserToken(context: TurnContext, connectionName: string, magicCode?: string, appCredentials?: CoreAppCredentials): Promise<TokenResponse>Parâmetros
- context
- TurnContext
Contexto para a virada atual da conversa com o usuário.
- connectionName
-
string
Nome da conexão de autenticação a ser usada.
- magicCode
-
string
(Opcional) Código inserido pelo usuário opcional para validar.
- appCredentials
- CoreAppCredentials
Retornos
Promise<TokenResponse>
signOutUser(TurnContext, string, string, CoreAppCredentials)
Desconscreve o usuário com o servidor de token.
function signOutUser(context: TurnContext, connectionName: string, userId?: string, appCredentials?: CoreAppCredentials): Promise<void>Parâmetros
- context
- TurnContext
Contexto para a virada atual da conversa com o usuário.
- connectionName
-
string
Nome da conexão de autenticação a ser usada.
- userId
-
string
ID do usuário para sair.
- appCredentials
- CoreAppCredentials
Retornos
Promise<void>
Detalhes do método herdado
getTokenStatus(TurnContext, string, string, any)
Recupera o status do token para cada conexão configurada para o usuário fornecido, usando o AppCredentials do bot.
function getTokenStatus(context: TurnContext, userId: string, includeFilter?: string, oAuthAppCredentials?: any): Promise<any[]>Parâmetros
- context
- TurnContext
Contexto para a virada atual da conversa com o usuário.
- userId
-
string
A ID do usuário para a qual o status do token é recuperado.
- includeFilter
-
string
Lista separada por vírgulas das conexões a serem incluídas. Em branco retornará o status do token para todas as conexões configuradas.
- oAuthAppCredentials
-
any
As credenciais do aplicativo para OAuth.
Retornos
Promise<any[]>