Communication Identity - Exchange Teams User Access Token

Referência

Service:: Communication

API Version:: 2023-10-01

Troque um token de acesso do Azure Active Directory (Azure AD) de um utilizador do Teams para um novo token de acesso à Identidade de Comunicação com um tempo de expiração correspondente.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	O recurso de comunicação, por exemplo https://my-resource.communication.azure.com
api-version	query	True	string	Versão da API a invocar.

Corpo do Pedido

Name	Necessário	Tipo	Description
appId	True	string	ID de cliente de uma aplicação Azure AD a verificar relativamente à afirmação appid no token de acesso Azure AD.
token	True	string	Azure AD token de acesso de um Utilizador do Teams para adquirir um novo token de acesso de Identidade de Comunicação.
userId	True	string	ID de objeto de um utilizador Azure AD (Utilizador do Teams) a verificar relativamente à afirmação de oid no token de acesso Azure AD.

Respostas

Name	Tipo	Description
200 OK	CommunicationIdentityAccessToken	Com êxito
Other Status Codes	CommunicationErrorResponse	Erro

Exemplos

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

Definições

Name	Description
CommunicationError	O erro dos Serviços de Comunicação.
CommunicationErrorResponse	O erro dos Serviços de Comunicação.
CommunicationIdentityAccessToken	Um token de acesso.
TeamsUserExchangeTokenRequest

CommunicationError

O erro dos Serviços de Comunicação.

Name	Tipo	Description
code	string	O código de erro.
details	CommunicationError[]	Mais detalhes sobre erros específicos que levaram a este erro.
innererror	CommunicationError	O erro interno, se existir.
message	string	A mensagem de erro.
target	string	O destino do erro.

CommunicationErrorResponse