Communication Identity - Issue Access Token

Szolgáltatás:

Communication

API-verzió:

2023-10-01

Adjon ki egy új jogkivonatot egy identitáshoz.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	A kommunikációs erőforrás, például https://my-resource.communication.azure.com
id	path	True	string	Annak az identitásnak az azonosítója, amely számára jogkivonatot kíván kiadni.
api-version	query	True	string	Az API meghívandó verziója.

Kérelem törzse

Name	Kötelező	Típus	Description
scopes	True	CommunicationIdentityTokenScope[]	A jogkivonathoz csatolt hatókörök listája.
expiresInMinutes		integer	A token opcionális egyéni érvényességi időtartama a (60 1440) perctartományon belül. Ha nincs megadva, a rendszer az alapértelmezett 1440 perc (24 óra) értéket használja.

Válaszok

Name	Típus	Description
200 OK	CommunicationIdentityAccessToken	Siker
Other Status Codes	CommunicationErrorResponse	Hiba

Példák

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.

Mintakérelem

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
}

Mintaválasz

Állapotkód:

200

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

Definíciók

Name	Description
CommunicationError	A Communication Services hibája.
CommunicationErrorResponse	A Communication Services hibája.
CommunicationIdentityAccessToken	Hozzáférési jogkivonat.
CommunicationIdentityAccessTokenRequest
CommunicationIdentityTokenScope	Hozzáférési jogkivonat hatóköreinek listája.

CommunicationError

A Communication Services hibája.

Name	Típus	Description
code	string	A hibakód.
details	CommunicationError[]	További részletek a hibához vezető konkrét hibákról.
innererror	CommunicationError	A belső hiba, ha van.
message	string	A hibaüzenet.
target	string	A hibacél.

CommunicationErrorResponse

A Communication Services hibája.

Name	Típus	Description
error	CommunicationError	A Communication Services hibája.

CommunicationIdentityAccessToken

Hozzáférési jogkivonat.

Name	Típus	Description
expiresOn	string	A jogkivonat lejárati ideje.
token	string	Az identitáshoz kibocsátott hozzáférési jogkivonat.

CommunicationIdentityAccessTokenRequest

Name	Típus	Alapértelmezett érték	Description
expiresInMinutes	integer	1440	A token opcionális egyéni érvényességi időtartama a (60 1440) perctartományon belül. Ha nincs megadva, a rendszer az alapértelmezett 1440 perc (24 óra) értéket használja.
scopes	CommunicationIdentityTokenScope[]		A jogkivonathoz csatolt hatókörök listája.

CommunicationIdentityTokenScope

Hozzáférési jogkivonat hatóköreinek listája.

Name	Típus	Description
chat	string	Használja ezt a lehetőséget a csevegési API-k teljes körű eléréséhez.
chat.join	string	Hozzáférés csevegési API-khoz, de a csevegési szálak létrehozásához, törléséhez vagy frissítéséhez szükséges engedély nélkül.
chat.join.limited	string	A chat.join korlátozottabb verziója, amely nem teszi lehetővé a résztvevők hozzáadását és eltávolítását. Akkor használja ezt a hatókört, ha a jogkivonat-tulajdonos nem megbízható teljes mértékben, például vendégforgatókönyvekben.
voip	string	Használja ezt a hívó API-khoz való teljes hozzáféréshez.
voip.join	string	Hozzáférés a hívó API-khoz, de nem rendelkezik új hívások indítására vonatkozó engedéllyel.