Communication Identity - Exchange Teams User Access Token

Служба:

Communication

Версия API:

2023-10-01

Обмен маркером доступа Azure Active Directory (Azure AD) пользователя Teams для нового маркера доступа к удостоверениям связи с соответствующим сроком действия.

POST {endpoint}/teamsUser/:exchangeAccessToken?api-version=2023-10-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Ресурс связи, например https://my-resource.communication.azure.com
api-version	query	True	string	Версия API для вызова.

Текст запроса

Имя	Обязательно	Тип	Описание
appId	True	string	Идентификатор клиента приложения Azure AD для проверки на соответствие утверждению appid в маркере доступа Azure AD.
token	True	string	Маркер доступа Azure AD пользователя Teams для получения нового маркера доступа к удостоверениям связи.
userId	True	string	Идентификатор объекта пользователя Azure AD (пользователя Teams), который должен быть проверен на основе утверждения oid в маркере доступа Azure AD.

Ответы

Имя	Тип	Описание
200 OK	CommunicationIdentityAccessToken	Успех
Other Status Codes	CommunicationErrorResponse	Ошибка

Примеры

Exchange a Teams user access token

Образец запроса

HTTP

POST https://my-resource.communication.azure.com/teamsUser/:exchangeAccessToken?api-version=2023-10-01

{
  "token": "AzureActiveDirectoryAccessTokenOfATeamsUser",
  "appId": "2c3e1e83-8fd7-4615-ad2b-b8c1229845ac",
  "userId": "32c0a5db-05ec-78ea-51ab-3f06b329397e"
}

Пример ответа

Код состояния:

200

{
  "token": "CommunicationIdentityAccessToken",
  "expiresOn": "2023-10-10T21:39:39.3244584+00:00"
}

Определения

Имя	Описание
CommunicationError	Ошибка служб коммуникации.
CommunicationErrorResponse	Ошибка служб коммуникации.
CommunicationIdentityAccessToken	Маркер доступа.
TeamsUserExchangeTokenRequest

CommunicationError

Ошибка служб коммуникации.

Имя	Тип	Описание
code	string	Код ошибки.
details	CommunicationError[]	Дополнительные сведения об определенных ошибках, которые привели к этой ошибке.
innererror	CommunicationError	Внутренняя ошибка, если она есть.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

CommunicationErrorResponse

Ошибка служб коммуникации.

Имя	Тип	Описание
error	CommunicationError	Ошибка служб коммуникации.

CommunicationIdentityAccessToken

Маркер доступа.

Имя	Тип	Описание
expiresOn	string	Время истечения срока действия маркера.
token	string	Маркер доступа, выданный для удостоверения.

TeamsUserExchangeTokenRequest

Имя	Тип	Описание
appId	string	Идентификатор клиента приложения Azure AD для проверки на соответствие утверждению appid в маркере доступа Azure AD.
token	string	Маркер доступа Azure AD пользователя Teams для получения нового маркера доступа к удостоверениям связи.
userId	string	Идентификатор объекта пользователя Azure AD (пользователя Teams), который должен быть проверен на основе утверждения oid в маркере доступа Azure AD.