Communication Identity - Exchange Teams User Access Token

Dienst:

Communication

API-Version:

2023-10-01

Exchange an Azure Active Directory (Azure AD) access token of a Teams user for a new Communication Identity access token with a matching expiration time.

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 API, die aufgerufen werden soll.

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ätszugriffstokens.
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

200

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

Definitionen

Name	Beschreibung
CommunicationError	Der Kommunikationsdienstfehler.
CommunicationErrorResponse	Der Kommunikationsdienstfehler.
CommunicationIdentityAccessToken	Ein Zugriffstoken.
TeamsUserExchangeTokenRequest

CommunicationError

Der Kommunikationsdienstfehler.

Name	Typ	Beschreibung
code	string	Der Fehlercode.
details	CommunicationError[]	Weitere Details 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

Der Kommunikationsdienstfehler.

Name	Typ	Beschreibung
error	CommunicationError	Der Kommunikationsdienstfehler.

CommunicationIdentityAccessToken

Ein Zugriffstoken.

Name	Typ	Beschreibung
expiresOn	string	Die Ablaufzeit des Tokens.
token	string	Das zugriffstoken, das für die Identität ausgestellt wurde.

TeamsUserExchangeTokenRequest

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