Compartilhar via


UserTokenClientImpl class

Extends

Construtores

UserTokenClientImpl(string, ServiceClientCredentials, string, ConnectorClientOptions)

Métodos

exchangeToken(string, string, string, TokenExchangeRequest)

Executa uma operação de troca de token, como para logon único.

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

Recupera tokens do Azure Active Directory para recursos específicos em uma conexão configurada.

getSignInResource(string, Activity, string)

Obtenha de forma assíncrona o recurso de entrada bruto a ser enviado ao usuário para entrar.

getTokenStatus(string, string, string)

Recupera o status do token para cada conexão configurada para o usuário fornecido.

getUserToken(string, string, string, string)

Tenta recuperar o token de um usuário que está em um fluxo de logon.

signOutUser(string, string, string)

Desconscreve o usuário com o servidor de token.

Detalhes do construtor

UserTokenClientImpl(string, ServiceClientCredentials, string, ConnectorClientOptions)

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

Parâmetros

appId

string

A appId.

credentials

ServiceClientCredentials

AppCredentials para OAuth.

oauthEndpoint

string

O ponto de extremidade da API OAuth.

connectorClientOptions
ConnectorClientOptions

Um objeto ConnectorClientOptions.

Detalhes do método

exchangeToken(string, string, string, TokenExchangeRequest)

Executa uma operação de troca de token, como para logon único.

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

Parâmetros

userId

string

A ID do usuário que será associada ao token.

connectionName

string

Nome da conexão de autenticação a ser usada.

channelId

string

A ID do canal que será associada ao token.

exchangeRequest

TokenExchangeRequest

Os detalhes da solicitação de troca, um token a ser trocado ou um uri a ser trocado.

Retornos

Promise<TokenResponse>

Uma promessa que representa o resultado da operação.

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

Recupera tokens do Azure Active Directory para recursos específicos em uma conexão configurada.

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

Parâmetros

userId

string

A ID do usuário que será associada ao token.

connectionName

string

Nome da conexão de autenticação a ser usada.

resourceUrls

string[]

A lista de URLs de recurso para a qual recuperar tokens.

channelId

string

A ID do canal que será associada ao token.

Retornos

Promise<Record<string, TokenResponse>>

Uma promessa de dicionário de resourceUrl para o TokenResponse correspondente.

getSignInResource(string, Activity, string)

Obtenha de forma assíncrona o recurso de entrada bruto a ser enviado ao usuário para entrar.

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

Parâmetros

connectionName

string

Nome da conexão de autenticação a ser usada.

activity

Activity

A atividade da qual derivar o estado da troca de tokens.

finalRedirect

string

A URL final para a qual o fluxo OAuth será redirecionada.

Retornos

Promise<SignInUrlResponse>

O recurso SignInUrlResponse.

getTokenStatus(string, string, string)

Recupera o status do token para cada conexão configurada para o usuário fornecido.

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

Parâmetros

userId

string

A ID do usuário que será associada ao token.

channelId

string

A ID do canal que será associada ao token.

includeFilter

string

O includeFilter.

Retornos

Promise<TokenStatus[]>

Uma promessa com uma Matriz do Status do Token.

getUserToken(string, string, string, string)

Tenta recuperar o token de um usuário que está em um fluxo de logon.

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

Parâmetros

userId

string

A ID do usuário que será associada ao token.

connectionName

string

Nome da conexão de autenticação a ser usada.

channelId

string

A ID do canal que será associada ao token.

magicCode

string

(Opcional) Código inserido pelo usuário opcional para validar.

Retornos

Promise<TokenResponse>

A resposta do token.

signOutUser(string, string, string)

Desconscreve o usuário com o servidor de token.

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

Parâmetros

userId

string

A ID do usuário que será associada ao token.

connectionName

string

Nome da conexão de autenticação a ser usada.

channelId

string

A ID do canal que será associada ao token.

Retornos

Promise<void>