Communication Identity - Exchange Teams User Access Token

服務:

Communication

API 版本:

2023-10-01

交換 Teams 使用者的 Azure Active Directory （Azure AD） 存取令牌，以取得具有相符到期時間的新通訊身分識別存取令牌。

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	通訊資源，例如 https://my-resource.communication.azure.com
api-version	query	True	string	要叫用的 API 版本。

要求本文

名稱	必要	類型	Description
appId	True	string	要針對 Azure AD 存取令牌中的 appid 宣告驗證的 Azure AD 應用程式的用戶端識別碼。
token	True	string	Teams 使用者的 Azure AD 存取令牌，以取得新的通訊身分識別存取令牌。
userId	True	string	要針對 Azure AD 存取令牌中的 oid 宣告進行驗證的 Azure AD 使用者物件識別碼。

回應

名稱	類型	Description
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"
}

定義

名稱	Description
CommunicationError	通訊服務錯誤。
CommunicationErrorResponse	通訊服務錯誤。
CommunicationIdentityAccessToken	存取令牌。
TeamsUserExchangeTokenRequest

CommunicationError

通訊服務錯誤。

名稱	類型	Description
code	string	錯誤碼。
details	CommunicationError[]	導致此錯誤之特定錯誤的詳細數據。
innererror	CommunicationError	如果有，則為內部錯誤。
message	string	錯誤訊息。
target	string	錯誤目標。

CommunicationErrorResponse

通訊服務錯誤。

名稱	類型	Description
error	CommunicationError	通訊服務錯誤。

CommunicationIdentityAccessToken

存取令牌。

名稱	類型	Description
expiresOn	string	令牌的到期時間。
token	string	針對身分識別發出的存取令牌。

TeamsUserExchangeTokenRequest

名稱	類型	Description
appId	string	要針對 Azure AD 存取令牌中的 appid 宣告驗證的 Azure AD 應用程式的用戶端識別碼。
token	string	Teams 使用者的 Azure AD 存取令牌，以取得新的通訊身分識別存取令牌。
userId	string	要針對 Azure AD 存取令牌中的 oid 宣告進行驗證的 Azure AD 使用者物件識別碼。