Поделиться через

UserTokenClient class

  • Ссылка
Пакет:
botframework-connector

Клиент для доступа к службе маркеров пользователя.

Методы

exchangeToken(string, string, string, TokenExchangeRequest)

Выполняет операцию обмена маркерами, например для единого входа.
getAadTokens(string, string, string[], string)

Извлекает маркеры Azure Active Directory для определенных ресурсов в настроенном подключении.
getSignInResource(string, Activity, string)

Получите ссылку необработанного входа, отправляемую пользователю для входа в имя подключения.
getTokenStatus(string, string, string)

Извлекает состояние токена для каждого настроенного подключения для данного пользователя.
getUserToken(string, string, string, string)

Пытается получить маркер для пользователя, который находится в потоке входа.
signOutUser(string, string, string)

Подписывает пользователя с помощью сервера токенов.

Сведения о методе

exchangeToken(string, string, string, TokenExchangeRequest)

Выполняет операцию обмена маркерами, например для единого входа.

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

Параметры

userId

string

Идентификатор пользователя, связанный с маркером.

connectionName

string

Имя используемого подключения проверки подлинности.

channelId

string

Идентификатор канала, связанный с маркером.

exchangeRequest

TokenExchangeRequest

Сведения о запросе на обмен, маркер для обмена или URI для обмена.

Возвращаемое значение

Promise<TokenResponse>

Объект TokenResponse.

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

Извлекает маркеры Azure Active Directory для определенных ресурсов в настроенном подключении.

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

Параметры

userId

string

Идентификатор пользователя, связанный с маркером.

connectionName

string

Имя используемого подключения проверки подлинности.

resourceUrls

string[]

Список URL-адресов ресурсов для получения маркеров.

channelId

string

Идентификатор канала, связанный с маркером.

Возвращаемое значение

Promise<Record<string, TokenResponse>>

Словарь resourceUrls для соответствующего TokenResponse.

getSignInResource(string, Activity, string)

Получите ссылку необработанного входа, отправляемую пользователю для входа в имя подключения.

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

Параметры

connectionName

string

Имя используемого подключения проверки подлинности.

activity

Activity

Действие , от которого требуется получить состояние обмена маркерами.

finalRediect

string

Окончательный URL-адрес, на который будет перенаправлен поток OAuth.

Возвращаемое значение

Promise<SignInUrlResponse>

SignInUrlResponse.

getTokenStatus(string, string, string)

Извлекает состояние токена для каждого настроенного подключения для данного пользователя.

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

Параметры

userId

string

Идентификатор пользователя, связанный с маркером.

channelId

string

Идентификатор канала, связанный с маркером.

includeFilter

string

IncludeFilter.

Возвращаемое значение

Promise<TokenStatus[]>

Список объектов TokenStatus.

getUserToken(string, string, string, string)

Пытается получить маркер для пользователя, который находится в потоке входа.

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

Параметры

userId

string

Идентификатор пользователя, связанный с маркером.

connectionName

string

Имя используемого подключения проверки подлинности.

channelId

string

Идентификатор канала, связанный с маркером.

magicCode

string

(Необязательно) Необязательный введенный пользователем код для проверки.

Возвращаемое значение

Promise<TokenResponse>

Объект TokenResponse.

signOutUser(string, string, string)

Подписывает пользователя с помощью сервера токенов.

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

Параметры

userId

string

Идентификатор пользователя, связанный с маркером.

connectionName

string

Имя используемого подключения проверки подлинности.

channelId

string

Идентификатор канала, связанный с маркером.

Возвращаемое значение

Promise<void>