Communication Identity - Issue Access Token

Service:

Communication

API Version:

2023-10-01

Vydejte 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, pro která se má vystavit token.
api-version	query	True	string	Verze rozhraní API, která se má vyvolat.

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 ji nezadáte, použije se výchozí hodnota 1440 minut (24 hodin).

Odpovědi

Name	Typ	Description
200 OK	CommunicationIdentityAccessToken	Success
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.

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

Definice

Name	Description
CommunicationError	Chyba komunikačních služeb.
CommunicationErrorResponse	Chyba komunikačních služeb.
CommunicationIdentityAccessToken	Přístupový token.
CommunicationIdentityAccessTokenRequest
CommunicationIdentityTokenScope	Seznam oborů přístupového tokenu

CommunicationError

Chyba komunikačních služeb.

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

CommunicationErrorResponse

Chyba komunikačních služeb.

Name	Typ	Description
error	CommunicationError	Chyba komunikačních služeb.

CommunicationIdentityAccessToken

Přístupový token.

Name	Typ	Description
expiresOn	string	Čas vypršení platnosti tokenu.
token	string	Přístupový token vystavený pro identitu.

CommunicationIdentityAccessTokenRequest

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

CommunicationIdentityTokenScope

Seznam oborů přístupového tokenu

Name	Typ	Description
chat	string	Použijte ho pro úplný přístup k rozhraním CHAT API.
chat.join	string	Přístup k rozhraním API chatu, ale bez oprávnění k vytváření, odstraňování nebo aktualizaci vláken 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 oprávnění ke spouštění nových volání