Communication Identity - Issue Access Token

Service:

Communication

API Version:

2023-10-01

Wystawianie nowego tokenu dla tożsamości.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Zasób komunikacji, na przykład https://my-resource.communication.azure.com
id	path	True	string	Identyfikator tożsamości do wystawiania tokenu.
api-version	query	True	string	Wersja interfejsu API do wywołania.

Treść żądania

Nazwa	Wymagane	Typ	Opis
scopes	True	CommunicationIdentityTokenScope[]	Lista zakresów dołączonych do tokenu.
expiresInMinutes		integer	Opcjonalny niestandardowy okres ważności tokenu w zakresie [60 1440] minut. Jeśli nie zostanie podana, zostanie użyta wartość domyślna 1440 minut (24 godziny).

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CommunicationIdentityAccessToken	Powodzenie
Other Status Codes	CommunicationErrorResponse	Błąd

Przykłady

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

Definicje

Nazwa	Opis
CommunicationError	Błąd usług komunikacyjnych.
CommunicationErrorResponse	Błąd usług komunikacyjnych.
CommunicationIdentityAccessToken	Token dostępu.
CommunicationIdentityAccessTokenRequest
CommunicationIdentityTokenScope	Lista zakresów tokenu dostępu.

CommunicationError

Błąd usług komunikacyjnych.

Nazwa	Typ	Opis
code	string	Kod błędu.
details	CommunicationError[]	Dalsze szczegółowe informacje o konkretnych błędach, które doprowadziły do tego błędu.
innererror	CommunicationError	Wewnętrzny błąd, jeśli istnieje.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

CommunicationErrorResponse

Błąd usług komunikacyjnych.

Nazwa	Typ	Opis
error	CommunicationError	Błąd usług komunikacyjnych.

CommunicationIdentityAccessToken

Token dostępu.

Nazwa	Typ	Opis
expiresOn	string	Czas wygaśnięcia tokenu.
token	string	Token dostępu wystawiony dla tożsamości.

CommunicationIdentityAccessTokenRequest

Nazwa	Typ	Wartość domyślna	Opis
expiresInMinutes	integer	1440	Opcjonalny niestandardowy okres ważności tokenu w zakresie [60 1440] minut. Jeśli nie zostanie podana, zostanie użyta wartość domyślna 1440 minut (24 godziny).
scopes	CommunicationIdentityTokenScope[]		Lista zakresów dołączonych do tokenu.

CommunicationIdentityTokenScope

Lista zakresów tokenu dostępu.

Nazwa	Typ	Opis
chat	string	Użyj tej opcji, aby uzyskać pełny dostęp do interfejsów API czatu.
chat.join	string	Dostęp do interfejsów API czatu, ale bez autoryzacji do tworzenia, usuwania lub aktualizowania wątków czatu.
chat.join.limited	string	Bardziej ograniczona wersja pliku chat.join, która nie zezwala na dodawanie lub usuwanie uczestników. Użyj tego zakresu, gdy element nośny tokenu nie jest w pełni zaufany, na przykład w scenariuszach gościa.
voip	string	Użyj tej funkcji, aby uzyskać pełny dostęp do wywoływania interfejsów API.
voip.join	string	Dostęp do wywoływania interfejsów API, ale bez autoryzacji, aby uruchomić nowe wywołania.