Communication Identity - Exchange Teams User Access Token

Service:

Communication

API-versie:

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-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	De communicatieresource, bijvoorbeeld https://my-resource.communication.azure.com
api-version	query	True	string	De versie van de API die moet worden aangeroepen.

Aanvraagbody

Name	Vereist	Type	Description
appId	True	string	Client-id van een Azure AD-toepassing die moet worden geverifieerd op basis van de appid-claim in het Azure AD-toegangstoken.
token	True	string	Azure AD-toegangstoken van een Teams-gebruiker om een nieuw communicatie-id-toegangstoken te verkrijgen.
userId	True	string	Object-id van een Azure AD-gebruiker (Teams-gebruiker) die moet worden geverifieerd op basis van de oid-claim in het Azure AD-toegangstoken.

Antwoorden

Name	Type	Description
200 OK	CommunicationIdentityAccessToken	Succes
Other Status Codes	CommunicationErrorResponse	Fout

Voorbeelden

Exchange a Teams user access token

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

200

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

Definities

Name	Description
CommunicationError	De Communication Services-fout.
CommunicationErrorResponse	De Communication Services-fout.
CommunicationIdentityAccessToken	Een toegangstoken.
TeamsUserExchangeTokenRequest

CommunicationError

De Communication Services-fout.

Name	Type	Description
code	string	De foutcode.
details	CommunicationError[]	Meer informatie over specifieke fouten die tot deze fout hebben geleid.
innererror	CommunicationError	De interne fout indien aanwezig.
message	string	Het foutbericht.
target	string	Het foutdoel.

CommunicationErrorResponse

De Communication Services-fout.

Name	Type	Description
error	CommunicationError	De Communication Services-fout.

CommunicationIdentityAccessToken

Een toegangstoken.

Name	Type	Description
expiresOn	string	De verlooptijd van het token.
token	string	Het toegangstoken dat is uitgegeven voor de identiteit.

TeamsUserExchangeTokenRequest

Name	Type	Description
appId	string	Client-id van een Azure AD-toepassing die moet worden geverifieerd op basis van de appid-claim in het Azure AD-toegangstoken.
token	string	Azure AD-toegangstoken van een Teams-gebruiker om een nieuw communicatie-id-toegangstoken te verkrijgen.
userId	string	Object-id van een Azure AD-gebruiker (Teams-gebruiker) die moet worden geverifieerd op basis van de oid-claim in het Azure AD-toegangstoken.