Communication Identity - Create

Riferimento

Servizio:: Communication

Versione API:: 2023-10-01

Creare una nuova identità e, facoltativamente, un token di accesso.

POST {endpoint}/identities?api-version=2023-10-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	Risorsa di comunicazione, ad esempio https://my-resource.communication.azure.com
api-version	query	True	string	Versione dell'API da richiamare.

Corpo della richiesta

Nome	Tipo	Descrizione
createTokenWithScopes	CommunicationIdentityTokenScope[]	Creare anche il token di accesso per l'identità creata.
expiresInMinutes	integer	Periodo di validità personalizzato facoltativo del token entro l'intervallo di minuti [60.1440]. Se non specificato, verrà usato il valore predefinito di 1440 minuti (24 ore).

Risposte

Nome	Tipo	Descrizione
201 Created	CommunicationIdentityAccessTokenResult	Creato: restituisce l'identità creata.
Other Status Codes	CommunicationErrorResponse	Errore

Esempio

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.

Esempio di richiesta

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
}

Risposta di esempio

Codice di stato:: 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"
  }
}

Definizioni

Nome	Descrizione
CommunicationError	Errore di Servizi di comunicazione.
CommunicationErrorResponse	Errore di Servizi di comunicazione.
CommunicationIdentity	Identità di comunicazione.
CommunicationIdentityAccessToken	Token di accesso.
CommunicationIdentityAccessTokenResult	Identità di comunicazione con token di accesso.
CommunicationIdentityCreateRequest
CommunicationIdentityTokenScope	Elenco di ambiti per un token di accesso.

CommunicationError

Errore di Servizi di comunicazione.

Nome	Tipo	Descrizione
code	string	Codice di errore.
details	CommunicationError[]	Ulteriori dettagli sugli errori specifici che hanno portato a questo errore.
innererror	CommunicationError	Errore interno se presente.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

CommunicationErrorResponse

Errore di Servizi di comunicazione.

Nome	Tipo	Descrizione
error	CommunicationError	Errore di Servizi di comunicazione.

CommunicationIdentity

Identità di comunicazione.

Nome	Tipo	Descrizione
id	string	Identificatore dell'identità.

CommunicationIdentityAccessToken

Token di accesso.

Nome	Tipo	Descrizione
expiresOn	string	Ora di scadenza del token.
token	string	Token di accesso rilasciato per l'identità.

CommunicationIdentityAccessTokenResult

Identità di comunicazione con token di accesso.

Nome	Tipo	Descrizione
accessToken	CommunicationIdentityAccessToken	Token di accesso.
identity	CommunicationIdentity	Identità di comunicazione.

CommunicationIdentityCreateRequest

Nome	Tipo	Valore predefinito	Descrizione
createTokenWithScopes	CommunicationIdentityTokenScope[]		Creare anche il token di accesso per l'identità creata.
expiresInMinutes	integer	1440	Periodo di validità personalizzato facoltativo del token entro l'intervallo di minuti [60.1440]. Se non specificato, verrà usato il valore predefinito di 1440 minuti (24 ore).

CommunicationIdentityTokenScope

Elenco di ambiti per un token di accesso.

Nome	Tipo	Descrizione
chat	string	Usare questa opzione per l'accesso completo alle API chat.
chat.join	string	Accesso alle API chat ma senza l'autorizzazione per creare, eliminare o aggiornare i thread chat.
chat.join.limited	string	Una versione più limitata di chat.join che non consente di aggiungere o rimuovere i partecipanti. Usare questo ambito quando il bearer del token non è completamente attendibile, ad esempio negli scenari guest.
voip	string	Usare questa opzione per l'accesso completo alle API chiamanti.
voip.join	string	Accesso alle API chiamanti ma senza autorizzazione per avviare nuove chiamate.

Condividi tramite