ExtendedUserTokenProvider interface
Предупреждение
Теперь этот API является нерекомендуемым.
Use UserTokenClient instead.
Интерфейс для API Единого входа oAuth маркера пользователя и токена Exchange для BotAdapters
- Extends
Методы
| exchange |
Выполняет операцию обмена маркерами, например для единого входа. |
| exchange |
Выполняет операцию обмена маркерами, например для единого входа. |
| get |
Подписывает пользователя с помощью сервера токенов. |
| get |
Возвращает ссылку для входа с сервера токенов, который можно отправить в рамках SigninCard. |
| get |
Получите необработанный ресурс входа, который будет отправлен пользователю для входа в имя подключения. |
| get |
Получите необработанный ресурс входа, который будет отправлен пользователю для входа в имя подключения. |
| get |
Получите необработанный ресурс входа, который будет отправлен пользователю для входа в имя подключения. |
| get |
Извлекает маркер OAuth для пользователя, который находится в потоке входа. |
| sign |
Подписывает пользователя с помощью сервера токенов. |
Наследуемые методы
| get |
Извлекает состояние токена для каждого настроенного подключения для данного пользователя с помощью appCredentials бота. |
Сведения о методе
exchangeToken(TurnContext, string, string, TokenExchangeRequest)
Выполняет операцию обмена маркерами, например для единого входа.
function exchangeToken(context: TurnContext, connectionName: string, userId: string, tokenExchangeRequest: TokenExchangeRequest): Promise<TokenResponse>Параметры
- context
- TurnContext
Контекст для текущего шага беседы с пользователем.
- connectionName
-
string
Имя используемого подключения проверки подлинности.
- userId
-
string
Идентификатор пользователя, связанный с маркером.
- tokenExchangeRequest
-
TokenExchangeRequest
Сведения о запросе на обмен, маркер для обмена или URI для обмена.
Возвращаемое значение
Promise<TokenResponse>
exchangeToken(TurnContext, string, string, TokenExchangeRequest, CoreAppCredentials)
Выполняет операцию обмена маркерами, например для единого входа.
function exchangeToken(context: TurnContext, connectionName: string, userId: string, tokenExchangeRequest: TokenExchangeRequest, appCredentials: CoreAppCredentials): Promise<TokenResponse>Параметры
- context
- TurnContext
Контекст для текущего шага беседы с пользователем.
- connectionName
-
string
Имя используемого подключения проверки подлинности.
- userId
-
string
Идентификатор пользователя, связанный с маркером.
- tokenExchangeRequest
-
TokenExchangeRequest
Сведения о запросе на обмен, маркер для обмена или URI для обмена.
- appCredentials
- CoreAppCredentials
Возвращаемое значение
Promise<TokenResponse>
getAadTokens(TurnContext, string, string[], CoreAppCredentials)
Подписывает пользователя с помощью сервера токенов.
function getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[], appCredentials?: CoreAppCredentials): Promise<[key: string]: TokenResponse>Параметры
- context
- TurnContext
Контекст для текущего шага беседы с пользователем.
- connectionName
-
string
Имя используемого подключения проверки подлинности.
- resourceUrls
-
string[]
- appCredentials
- CoreAppCredentials
Возвращаемое значение
Promise<[key: string]: TokenResponse>
getSignInLink(TurnContext, string, CoreAppCredentials)
Возвращает ссылку для входа с сервера токенов, который можно отправить в рамках SigninCard.
function getSignInLink(context: TurnContext, connectionName: string, appCredentials?: CoreAppCredentials): Promise<string>Параметры
- context
- TurnContext
Контекст для текущего шага беседы с пользователем.
- connectionName
-
string
Имя используемого подключения проверки подлинности.
- appCredentials
- CoreAppCredentials
Возвращаемое значение
Promise<string>
getSignInResource(TurnContext, string)
Получите необработанный ресурс входа, который будет отправлен пользователю для входа в имя подключения.
function getSignInResource(context: TurnContext, connectionName: string): Promise<SignInUrlResponse>Параметры
- context
- TurnContext
Контекст для текущего шага беседы с пользователем.
- connectionName
-
string
Имя используемого подключения проверки подлинности.
Возвращаемое значение
Promise<SignInUrlResponse>
getSignInResource(TurnContext, string, string, string)
Получите необработанный ресурс входа, который будет отправлен пользователю для входа в имя подключения.
function getSignInResource(context: TurnContext, connectionName: string, userId: string, finalRedirect?: string): Promise<SignInUrlResponse>Параметры
- context
- TurnContext
Контекст для текущего шага беседы с пользователем.
- connectionName
-
string
Имя используемого подключения проверки подлинности.
- userId
-
string
Идентификатор пользователя, связанный с маркером.
- finalRedirect
-
string
Окончательный URL-адрес, на который будет перенаправлен поток OAuth.
Возвращаемое значение
Promise<SignInUrlResponse>
getSignInResource(TurnContext, string, string, string, CoreAppCredentials)
Получите необработанный ресурс входа, который будет отправлен пользователю для входа в имя подключения.
function getSignInResource(context: TurnContext, connectionName: string, userId: string, finalRedirect?: string, appCredentials?: CoreAppCredentials): Promise<SignInUrlResponse>Параметры
- context
- TurnContext
Контекст для текущего шага беседы с пользователем.
- connectionName
-
string
Имя используемого подключения проверки подлинности.
- userId
-
string
Идентификатор пользователя, связанный с маркером.
- finalRedirect
-
string
Окончательный URL-адрес, на который будет перенаправлен поток OAuth.
- appCredentials
- CoreAppCredentials
Возвращаемое значение
Promise<SignInUrlResponse>
getUserToken(TurnContext, string, string, CoreAppCredentials)
Извлекает маркер OAuth для пользователя, который находится в потоке входа.
function getUserToken(context: TurnContext, connectionName: string, magicCode?: string, appCredentials?: CoreAppCredentials): Promise<TokenResponse>Параметры
- context
- TurnContext
Контекст для текущего шага беседы с пользователем.
- connectionName
-
string
Имя используемого подключения проверки подлинности.
- magicCode
-
string
(Необязательно) Необязательный введенный пользователем код для проверки.
- appCredentials
- CoreAppCredentials
Возвращаемое значение
Promise<TokenResponse>
signOutUser(TurnContext, string, string, CoreAppCredentials)
Подписывает пользователя с помощью сервера токенов.
function signOutUser(context: TurnContext, connectionName: string, userId?: string, appCredentials?: CoreAppCredentials): Promise<void>Параметры
- context
- TurnContext
Контекст для текущего шага беседы с пользователем.
- connectionName
-
string
Имя используемого подключения проверки подлинности.
- userId
-
string
Идентификатор пользователя для выхода.
- appCredentials
- CoreAppCredentials
Возвращаемое значение
Promise<void>
Сведения о наследуемом методе
getTokenStatus(TurnContext, string, string, any)
Извлекает состояние токена для каждого настроенного подключения для данного пользователя с помощью appCredentials бота.
function getTokenStatus(context: TurnContext, userId: string, includeFilter?: string, oAuthAppCredentials?: any): Promise<any[]>Параметры
- context
- TurnContext
Контекст для текущего шага беседы с пользователем.
- userId
-
string
Идентификатор пользователя, для которого извлекается состояние маркера.
- includeFilter
-
string
Разделенный запятыми список включаемых подключений. Пустой возвращает состояние маркера для всех настроенных подключений.
- oAuthAppCredentials
-
any
Учетные данные приложения для OAuth.
Возвращаемое значение
Promise<any[]>
унаследован отIUserTokenProvider.getTokenStatus