Communication Identity - Create

Referência

Serviço:: Communication

Versão da API:: 2023-10-01

Crie uma nova identidade e, opcionalmente, um token de acesso.

POST {endpoint}/identities?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	Tipo	Description
createTokenWithScopes	CommunicationIdentityTokenScope[]	Crie também um token de acesso para a identidade criada.
expiresInMinutes	integer	Período de validade personalizado opcional do token dentro do intervalo de [60,1440] minutos. Se não for fornecido, o valor padrão de 1440 minutos (24 horas) será usado.

Respostas

Name	Tipo	Description
201 Created	CommunicationIdentityAccessTokenResult	Criado - Retorna a identidade criada.
Other Status Codes	CommunicationErrorResponse	Erro

Exemplos

Create an Identity and optionally an access token with custom expiration time within the [60-1440] minutes range. If expiration time is not specified, the default value of 1440 minutes (24 hours) will be used.

Pedido de amostra

HTTP

POST https://my-resource.communication.azure.com/identities?api-version=2023-10-01

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

Resposta da amostra

Código de estado:: 201

{
  "identity": {
    "id": "8:acs:2dee53b4-368b-45b4-ab52-8493fb117652_00000005-14a2-493b-8a72-5a3a0d000081"
  },
  "accessToken": {
    "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.
CommunicationIdentity	Uma identidade de comunicação.
CommunicationIdentityAccessToken	Um token de acesso.
CommunicationIdentityAccessTokenResult	Uma identidade de comunicação com token de acesso.
CommunicationIdentityCreateRequest
CommunicationIdentityTokenScope	Lista de escopos para 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 esse erro.
innererror	CommunicationError	O erro interno, se houver.
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.

CommunicationIdentity

Uma identidade de comunicação.

Name	Tipo	Description
id	string	Identificador da identidade.

CommunicationIdentityAccessToken

Um token de acesso.

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

CommunicationIdentityAccessTokenResult

Uma identidade de comunicação com token de acesso.

Name	Tipo	Description
accessToken	CommunicationIdentityAccessToken	Um token de acesso.
identity	CommunicationIdentity	Uma identidade de comunicação.

CommunicationIdentityCreateRequest

Name	Tipo	Default value	Description
createTokenWithScopes	CommunicationIdentityTokenScope[]		Crie também um token de acesso para a identidade criada.
expiresInMinutes	integer	1440	Período de validade personalizado opcional do token dentro do intervalo de [60,1440] minutos. Se não for fornecido, o valor padrão de 1440 minutos (24 horas) será usado.

CommunicationIdentityTokenScope

Lista de escopos para um token de acesso.

Name	Tipo	Description
chat	string	Use isso para acesso total às APIs de bate-papo.
chat.join	string	Acesso a APIs de bate-papo, mas sem a autorização para criar, excluir ou atualizar threads de bate-papo.
chat.join.limited	string	Uma versão mais limitada do chat.join que não permite adicionar ou remover participantes. Use esse escopo quando o portador do token não for totalmente confiável, por exemplo, em cenários de convidado.
voip	string	Use isso para acesso total às APIs de chamada.
voip.join	string	Acesso a APIs de chamada, mas sem autorização para iniciar novas chamadas.

Partilhar via