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

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>