你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Communication Identity - Exchange Teams User Access Token

将 Teams 用户的 Azure Active Directory (Azure AD) 访问令牌交换为具有匹配过期时间的新通信标识访问令牌。

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 应用程序的客户端 ID。

token True

string

用于获取新的通信标识访问令牌的 Teams 用户的 Azure AD 访问令牌。

userId True

string

要根据 Azure AD 访问令牌中的 oid 声明验证的 Azure AD 用户(Teams 用户)的对象 ID。

响应

名称 类型 说明
200 OK

CommunicationIdentityAccessToken

成功

Other Status Codes

CommunicationErrorResponse

错误

示例

Exchange a Teams user access token

示例请求

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"
}

示例响应

{
  "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 应用程序的客户端 ID。

token

string

用于获取新的通信标识访问令牌的 Teams 用户的 Azure AD 访问令牌。

userId

string

要根据 Azure AD 访问令牌中的 oid 声明验证的 Azure AD 用户(Teams 用户)的对象 ID。