Communication Identity - Exchange Teams User Access Token

Tjänst:

Communication

API-version:

2023-10-01

Byt ut en Azure Active Directory-åtkomsttoken (Azure AD) för en Teams-användare mot en ny åtkomsttoken för kommunikationsidentitet med matchande förfallotid.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Kommunikationsresursen, till exempel https://my-resource.communication.azure.com
api-version	query	True	string	Version av API som ska anropas.

Begärandetext

Name	Obligatorisk	Typ	Description
appId	True	string	Klient-ID för ett Azure AD program som ska verifieras mot appid-anspråket i Azure AD åtkomsttoken.
token	True	string	Azure AD åtkomsttoken för en Teams-användare för att hämta en ny åtkomsttoken för kommunikationsidentitet.
userId	True	string	Objekt-ID för en Azure AD användare (Teams-användare) som ska verifieras mot oid-anspråket i Azure AD åtkomsttoken.

Svar

Name	Typ	Description
200 OK	CommunicationIdentityAccessToken	Klart
Other Status Codes	CommunicationErrorResponse	Fel

Exempel

Exchange a Teams user access token

Exempelbegäran

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

Exempelsvar

Statuskod:

200

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

Definitioner

Name	Description
CommunicationError	Kommunikationstjänstens fel.
CommunicationErrorResponse	Kommunikationstjänstens fel.
CommunicationIdentityAccessToken	En åtkomsttoken.
TeamsUserExchangeTokenRequest

CommunicationError

Kommunikationstjänstens fel.

Name	Typ	Description
code	string	Felkoden.
details	CommunicationError[]	Mer information om specifika fel som ledde till det här felet.
innererror	CommunicationError	Det inre felet om det finns något.
message	string	Felmeddelandet.
target	string	Felmålet.

CommunicationErrorResponse

Kommunikationstjänstens fel.

Name	Typ	Description
error	CommunicationError	Kommunikationstjänstens fel.

CommunicationIdentityAccessToken

En åtkomsttoken.

Name	Typ	Description
expiresOn	string	Förfallotiden för token.
token	string	Den åtkomsttoken som utfärdats för identiteten.

TeamsUserExchangeTokenRequest

Name	Typ	Description
appId	string	Klient-ID för ett Azure AD program som ska verifieras mot appid-anspråket i Azure AD åtkomsttoken.
token	string	Azure AD åtkomsttoken för en Teams-användare för att hämta en ny åtkomsttoken för kommunikationsidentitet.
userId	string	Objekt-ID för en Azure AD användare (Teams-användare) som ska verifieras mot oid-anspråket i Azure AD åtkomsttoken.