Communication Identity - Issue Access Token

  • Başvuru
Hizmet:
Communication
API Sürümü:
2023-10-01

Kimlik için yeni bir belirteç verin.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
endpoint
 path True

string

İletişim kaynağı, örneğin https://my-resource.communication.azure.com
id
 path True

string

Belirteci vermek istediğiniz kimliğin tanımlayıcısı.
api-version
 query True

string

Çağrılacak API sürümü.

İstek Gövdesi

Name Gerekli Tür Description
scopes True

CommunicationIdentityTokenScope[]

Belirteci ekli kapsamların listesi.
expiresInMinutes

integer

Belirtecin [60.1440] dakika aralığındaki isteğe bağlı özel geçerlilik süresi. Sağlanmadıysa, varsayılan değer olan 1440 dakika (24 saat) kullanılır.

Yanıtlar

Name Tür Description
200 OK

CommunicationIdentityAccessToken

Başarılı
Other Status Codes

CommunicationErrorResponse

Hata

Örnekler

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.

Örnek isteği

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
}

Örnek yanıt

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

Tanımlar

Name Description
CommunicationError

İletişim Hizmetleri hatası.
CommunicationErrorResponse

İletişim Hizmetleri hatası.
CommunicationIdentityAccessToken

Erişim belirteci.
CommunicationIdentityAccessTokenRequest
CommunicationIdentityTokenScope

Erişim belirtecinin kapsam listesi.

CommunicationError

İletişim Hizmetleri hatası.

Name Tür Description
code

string

Hata kodu.
details

CommunicationError[]

Bu hataya yol açan belirli hatalar hakkında daha fazla ayrıntı.
innererror

CommunicationError

Varsa iç hata.
message

string

Hata iletisi.
target

string

Hata hedefi.

CommunicationErrorResponse

İletişim Hizmetleri hatası.

Name Tür Description
error

CommunicationError

İletişim Hizmetleri hatası.

CommunicationIdentityAccessToken

Erişim belirteci.

Name Tür Description
expiresOn

string

Belirtecin süre sonu süresi.
token

string

Kimlik için verilen erişim belirteci.

CommunicationIdentityAccessTokenRequest

Name Tür Default value Description
expiresInMinutes

integer

1440

Belirtecin [60.1440] dakika aralığındaki isteğe bağlı özel geçerlilik süresi. Sağlanmadıysa, varsayılan değer olan 1440 dakika (24 saat) kullanılır.
scopes

CommunicationIdentityTokenScope[]

Belirteci ekli kapsamların listesi.

CommunicationIdentityTokenScope

Erişim belirtecinin kapsam listesi.

Name Tür Description
chat

string

Sohbet API'lerine tam erişim için bunu kullanın.
chat.join

string

Sohbet API'lerine erişim, ancak sohbet yazışmaları oluşturma, silme veya güncelleştirme yetkisi olmadan.
chat.join.limited

string

Katılımcı eklemeye veya kaldırmaya izin vermeyen daha sınırlı bir chat.join sürümü. Belirteç taşıyıcıya tam olarak güvenilmediğinde , örneğin konuk senaryolarında bu kapsamı kullanın.
voip

string

Arama API'lerine tam erişim için bunu kullanın.
voip.join

string

Arama API'lerine erişim, ancak yeni çağrıları başlatma yetkisi olmadan.