Communication Identity - Issue Access Token

Service:

Communication

API Version:

2023-10-01

Emita um novo token para uma identidade.

POST {endpoint}/identities/{id}/:issueAccessToken?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
id	path	True	string	Identificador da identidade para a qual emitir token.
api-version	query	True	string	Versão da API a invocar.

Corpo do Pedido

Name	Necessário	Tipo	Description
scopes	True	CommunicationIdentityTokenScope[]	Lista de âmbitos anexados ao token.
expiresInMinutes		integer	Período de validade personalizado opcional do token dentro do intervalo de [60.1440] minutos. Se não for fornecido, será utilizado o valor predefinido de 1440 minutos (24 horas).

Respostas

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

Exemplos

Issue an access token. Optionally specify a custom expiration time within the [60-1440] minutes range. In case an expiration time is not specified, the default value of 1440 minutes (24 hours) will be used.

Sample Request

HTTP

POST https://my-resource.communication.azure.com/identities/8:acs:2dee53b4-368b-45b4-ab52-8493fb117652_00000005-14a2-493b-8a72-5a3a0d000081/:issueAccessToken?api-version=2023-10-01

{
  "scopes": [
    "chat",
    "voip",
    "chat.join",
    "chat.join.limited",
    "voip.join"
  ],
  "expiresInMinutes": 60
}

Sample Response

Status code:

200

{
  "token": "token",
  "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.
CommunicationIdentityAccessTokenRequest
CommunicationIdentityTokenScope	Lista de âmbitos de um token de acesso.

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

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

Name	Tipo	Description
error	CommunicationError	O erro dos Serviços de Comunicação.

CommunicationIdentityAccessToken

Um token de acesso.

Name	Tipo	Description
expiresOn	string	A hora de expiração do token.
token	string	O token de acesso emitido para a identidade.

CommunicationIdentityAccessTokenRequest

Name	Tipo	Valor Predefinido	Description
expiresInMinutes	integer	1440	Período de validade personalizado opcional do token dentro do intervalo de [60.1440] minutos. Se não for fornecido, será utilizado o valor predefinido de 1440 minutos (24 horas).
scopes	CommunicationIdentityTokenScope[]		Lista de âmbitos anexados ao token.

CommunicationIdentityTokenScope

Lista de âmbitos de um token de acesso.

Name	Tipo	Description
chat	string	Utilize esta opção para acesso total às APIs de Chat.
chat.join	string	Acesso às APIs de Chat, mas sem autorização para criar, eliminar ou atualizar threads de chat.
chat.join.limited	string	Uma versão mais limitada do chat.join que não permite adicionar ou remover participantes. Utilize este âmbito quando o portador de tokens não for totalmente fidedigno, por exemplo, em cenários de convidado.
voip	string	Utilize esta opção para acesso total às APIs de Chamada.
voip.join	string	Acesso às APIs de Chamada, mas sem autorização para iniciar novas chamadas.