Communication Identity - Issue Access Token

Servizio:

Communication

Versione API:

2023-10-01

Rilasciare un nuovo token per un'identità.

POST {endpoint}/identities/{id}/:issueAccessToken?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
id	path	True	string	Identificatore dell'identità per cui emettere il token.
api-version	query	True	string	Versione dell'API da richiamare.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
scopes	True	CommunicationIdentityTokenScope[]	Elenco di ambiti collegati al token.
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
200 OK	CommunicationIdentityAccessToken	Operazione riuscita
Other Status Codes	CommunicationErrorResponse	Errore

Esempio

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.

Esempio di richiesta

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
}

Risposta di esempio

Codice di stato:

200

{
  "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.
CommunicationIdentityAccessToken	Token di accesso.
CommunicationIdentityAccessTokenRequest
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.

CommunicationIdentityAccessToken

Token di accesso.

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

CommunicationIdentityAccessTokenRequest

Nome	Tipo	Valore predefinito	Descrizione
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).
scopes	CommunicationIdentityTokenScope[]		Elenco di ambiti collegati al token.

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.