Communication Identity - Exchange Teams User Access Token

Referenz

Service:: Communication

API Version:: 2023-10-01

Tausch des Azure AD-Zugriffstokens (Azure Active Directory) eines Teams-Benutzers gegen ein neues Kommunikationsidentitäts-Zugriffstoken mit übereinstimmender Ablaufzeit.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Die Kommunikationsressource, z. B. https://my-resource.communication.azure.com
api-version	query	True	string	Version der aufzurufenden API.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
appId	True	string	Client-ID einer Azure AD-Anwendung, die anhand des Appid-Anspruchs im Azure AD-Zugriffstoken überprüft werden soll.
token	True	string	Azure AD-Zugriffstoken eines Teams-Benutzers zum Abrufen eines neuen Kommunikationsidentitäts-Zugriffstokens.
userId	True	string	Objekt-ID eines Azure AD-Benutzers (Teams-Benutzer), der anhand des oid-Anspruchs im Azure AD-Zugriffstoken überprüft werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	CommunicationIdentityAccessToken	Erfolg
Other Status Codes	CommunicationErrorResponse	Fehler

Beispiele

Exchange a Teams user access token

Sample Request

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

Sample Response

Status code:: 200

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

Definitionen

Name	Beschreibung
CommunicationError	Der Communication Services-Fehler.
CommunicationErrorResponse	Der Communication Services-Fehler.
CommunicationIdentityAccessToken	Ein Zugriffstoken.
TeamsUserExchangeTokenRequest

CommunicationError

Der Communication Services-Fehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	CommunicationError[]	Weitere Informationen zu bestimmten Fehlern, die zu diesem Fehler geführt haben.
innererror	CommunicationError	Der innere Fehler, falls vorhanden.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

CommunicationErrorResponse