Communication Identity - Issue Access Token

Služba:

Communication

Verze rozhraní API:

2023-10-01

Vydá nový token pro identitu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Komunikační prostředek, například https://my-resource.communication.azure.com
id	path	True	string	Identifikátor identity k vydání tokenu.
api-version	query	True	string	Verze rozhraní API k vyvolání

Text požadavku

Name	Vyžadováno	Typ	Description
scopes	True	CommunicationIdentityTokenScope[]	Seznam oborů připojených k tokenu
expiresInMinutes		integer	Volitelná vlastní doba platnosti tokenu v rozsahu [60 1440] minut. Pokud není zadáno, použije se výchozí hodnota 1440 minut (24 hodin).

Odpovědi

Name	Typ	Description
200 OK	CommunicationIdentityAccessToken	Úspěch
Other Status Codes	CommunicationErrorResponse	Chyba

Příklady

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.

Ukázkový požadavek

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
}

Ukázková odpověď

Stavový kód:

200

{
  "token": "token",
  "expiresOn": "2023-10-10T21:39:39.3244584+00:00"
}

Definice

Name	Description
CommunicationError	Chyba Komunikační služby.
CommunicationErrorResponse	Chyba Komunikační služby.
CommunicationIdentityAccessToken	Přístupový token.
CommunicationIdentityAccessTokenRequest
CommunicationIdentityTokenScope	Seznam oborů pro přístupový token

CommunicationError

Chyba Komunikační služby.

Name	Typ	Description
code	string	Kód chyby.
details	CommunicationError[]	Další podrobnosti o konkrétních chybách, které vedly k této chybě.
innererror	CommunicationError	Vnitřní chyba, pokud existuje.
message	string	Chybová zpráva.
target	string	Cíl chyby.

CommunicationErrorResponse

Chyba Komunikační služby.

Name	Typ	Description
error	CommunicationError	Chyba Komunikační služby.

CommunicationIdentityAccessToken

Přístupový token.

Name	Typ	Description
expiresOn	string	Doba vypršení platnosti tokenu.
token	string	Přístupový token vydaný pro identitu.

CommunicationIdentityAccessTokenRequest

Name	Typ	Default value	Description
expiresInMinutes	integer	1440	Volitelná vlastní doba platnosti tokenu v rozsahu [60 1440] minut. Pokud není zadáno, použije se výchozí hodnota 1440 minut (24 hodin).
scopes	CommunicationIdentityTokenScope[]		Seznam oborů připojených k tokenu

CommunicationIdentityTokenScope

Seznam oborů pro přístupový token

Name	Typ	Description
chat	string	Tuto možnost použijte pro úplný přístup k rozhraním API chatu.
chat.join	string	Přístup k rozhraním API chatu, ale bez autorizace vytvářet, odstraňovat nebo aktualizovat vlákna chatu.
chat.join.limited	string	Omezenější verze chat.join, která neumožňuje přidávat nebo odebírat účastníky. Tento obor použijte, pokud nosný token není plně důvěryhodný, například ve scénářích hosta.
voip	string	Tuto možnost použijte pro úplný přístup k rozhraním API pro volání.
voip.join	string	Přístup k rozhraním API pro volání, ale bez autorizace ke spuštění nových volání.