Communication Identity - Issue Access Token

Layanan:

Communication

Versi API:

2023-10-01

Terbitkan token baru untuk identitas.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	Sumber daya komunikasi, misalnya https://my-resource.communication.azure.com
id	path	True	string	Pengidentifikasi identitas untuk menerbitkan token.
api-version	query	True	string	Versi API yang akan dipanggil.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
scopes	True	CommunicationIdentityTokenScope[]	Daftar cakupan yang dilampirkan ke token.
expiresInMinutes		integer	Periode validitas kustom opsional token dalam rentang [60.1440] menit. Jika tidak disediakan, nilai default 1440 menit (24 jam) akan digunakan.

Respons

Nama	Jenis	Deskripsi
200 OK	CommunicationIdentityAccessToken	Berhasil
Other Status Codes	CommunicationErrorResponse	Kesalahan

Contoh

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.

Permintaan sampel

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
}

Respon sampel

Kode status:

200

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

Definisi

Nama	Deskripsi
CommunicationError	Kesalahan Communication Services.
CommunicationErrorResponse	Kesalahan Communication Services.
CommunicationIdentityAccessToken	Token akses.
CommunicationIdentityAccessTokenRequest
CommunicationIdentityTokenScope	Daftar cakupan untuk token akses.

CommunicationError

Kesalahan Communication Services.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan.
details	CommunicationError[]	Detail lebih lanjut tentang kesalahan tertentu yang menyebabkan kesalahan ini.
innererror	CommunicationError	Kesalahan dalam jika ada.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

CommunicationErrorResponse

Kesalahan Communication Services.

Nama	Jenis	Deskripsi
error	CommunicationError	Kesalahan Communication Services.

CommunicationIdentityAccessToken

Token akses.

Nama	Jenis	Deskripsi
expiresOn	string	Waktu kedaluwarsa token.
token	string	Token akses yang dikeluarkan untuk identitas.

CommunicationIdentityAccessTokenRequest

Nama	Jenis	Nilai default	Deskripsi
expiresInMinutes	integer	1440	Periode validitas kustom opsional token dalam rentang [60.1440] menit. Jika tidak disediakan, nilai default 1440 menit (24 jam) akan digunakan.
scopes	CommunicationIdentityTokenScope[]		Daftar cakupan yang dilampirkan ke token.

CommunicationIdentityTokenScope

Daftar cakupan untuk token akses.

Nama	Jenis	Deskripsi
chat	string	Gunakan ini untuk akses penuh ke API Obrolan.
chat.join	string	Akses ke API Obrolan tetapi tanpa otorisasi untuk membuat, menghapus, atau memperbarui utas obrolan.
chat.join.limited	string	Versi chat.join yang lebih terbatas yang tidak memungkinkan untuk menambahkan atau menghapus peserta. Gunakan cakupan ini ketika pembawa token tidak sepenuhnya tepercaya, misalnya dalam skenario tamu.
voip	string	Gunakan ini untuk akses penuh ke API Panggilan.
voip.join	string	Akses ke API Panggilan tetapi tanpa otorisasi untuk memulai panggilan baru.