Communication Identity - Create

Başvuru

Hizmet:: Communication

API Sürümü:: 2023-10-01

Yeni bir kimlik ve isteğe bağlı olarak erişim belirteci oluşturun.

POST {endpoint}/identities?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
api-version	query	True	string	Çağrılacak API sürümü.

İstek Gövdesi

Name	Tür	Description
createTokenWithScopes	CommunicationIdentityTokenScope[]	Ayrıca, oluşturulan kimlik için erişim belirteci oluşturun.
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
201 Created	CommunicationIdentityAccessTokenResult	Oluşturuldu - Oluşturulan kimliği döndürür.
Other Status Codes	CommunicationErrorResponse	Hata

Örnekler

Create an Identity and optionally an access token with custom expiration time within the [60-1440] minutes range. If expiration time is not specified, the default value of 1440 minutes (24 hours) will be used.

Örnek isteği

HTTP

POST https://my-resource.communication.azure.com/identities?api-version=2023-10-01

{
  "createTokenWithScopes": [
    "chat",
    "voip",
    "chat.join",
    "chat.join.limited",
    "voip.join"
  ],
  "expiresInMinutes": 60
}

Örnek yanıt

Durum kodu:: 201

{
  "identity": {
    "id": "8:acs:2dee53b4-368b-45b4-ab52-8493fb117652_00000005-14a2-493b-8a72-5a3a0d000081"
  },
  "accessToken": {
    "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ı.
CommunicationIdentity	İletişim kimliği.
CommunicationIdentityAccessToken	Erişim belirteci.
CommunicationIdentityAccessTokenResult	Erişim belirteciyle iletişim kimliği.
CommunicationIdentityCreateRequest
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ı.

CommunicationIdentity

İletişim kimliği.

Name	Tür	Description
id	string	Kimliğin tanımlayıcısı.

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.

CommunicationIdentityAccessTokenResult

Erişim belirteciyle iletişim kimliği.

Name	Tür	Description
accessToken	CommunicationIdentityAccessToken	Erişim belirteci.
identity	CommunicationIdentity	İletişim kimliği.

CommunicationIdentityCreateRequest

Name	Tür	Default value	Description
createTokenWithScopes	CommunicationIdentityTokenScope[]		Ayrıca, oluşturulan kimlik için erişim belirteci oluşturun.
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.

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.

Aracılığıyla paylaş