Communication Identity - Create

Ссылка

Service:: Communication

API Version:: 2023-10-01

Создайте новое удостоверение и при необходимости маркер доступа.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Ресурс связи, например https://my-resource.communication.azure.com
api-version	query	True	string	Версия ВЫЗЫВАемого API.

Текст запроса

Имя	Тип	Описание
createTokenWithScopes	CommunicationIdentityTokenScope[]	Также создайте маркер доступа для созданного удостоверения.
expiresInMinutes	integer	Необязательный настраиваемый период действия маркера в диапазоне [60 1440] минут. Если не указано, будет использоваться значение по умолчанию 1440 минут (24 часа).

Ответы

Имя	Тип	Описание
201 Created	CommunicationIdentityAccessTokenResult	Created — возвращает созданное удостоверение.
Other Status Codes	CommunicationErrorResponse	Ошибка

Примеры

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.

Sample Request

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
}

Sample Response

Status code:: 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"
  }
}

Определения

Имя	Описание
CommunicationError	Ошибка Служб коммуникации.
CommunicationErrorResponse	Ошибка Служб коммуникации.
CommunicationIdentity	Удостоверение связи.
CommunicationIdentityAccessToken	Маркер доступа.
CommunicationIdentityAccessTokenResult	Удостоверение связи с маркером доступа.
CommunicationIdentityCreateRequest
CommunicationIdentityTokenScope	Список областей для маркера доступа.

CommunicationError

Ошибка Служб коммуникации.

Имя	Тип	Описание
code	string	Код ошибки.
details	CommunicationError[]	Дополнительные сведения о конкретных ошибках, которые привели к этой ошибке.
innererror	CommunicationError	Внутренняя ошибка, если она есть.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

CommunicationErrorResponse

Ошибка Служб коммуникации.

Имя	Тип	Описание
error	CommunicationError	Ошибка Служб коммуникации.

CommunicationIdentity

Удостоверение связи.

Имя	Тип	Описание
id	string	Идентификатор удостоверения.

CommunicationIdentityAccessToken

Маркер доступа.

Имя	Тип	Описание
expiresOn	string	Время окончания срока действия маркера.
token	string	Маркер доступа, выданный для удостоверения.

CommunicationIdentityAccessTokenResult

Удостоверение связи с маркером доступа.

Имя	Тип	Описание
accessToken	CommunicationIdentityAccessToken	Маркер доступа.
identity	CommunicationIdentity	Удостоверение связи.

CommunicationIdentityCreateRequest

Имя	Тип	Значение по умолчанию	Описание
createTokenWithScopes	CommunicationIdentityTokenScope[]		Также создайте маркер доступа для созданного удостоверения.
expiresInMinutes	integer	1440	Необязательный настраиваемый период действия маркера в диапазоне [60 1440] минут. Если не указано, будет использоваться значение по умолчанию 1440 минут (24 часа).

CommunicationIdentityTokenScope

Список областей для маркера доступа.

Имя	Тип	Описание
chat	string	Используйте его для полного доступа к API чата.
chat.join	string	Доступ к API чата, но без авторизации для создания, удаления или обновления потоков чата.
chat.join.limited	string	Более ограниченная версия chat.join, которая не позволяет добавлять или удалять участников. Используйте этот область, если носитель маркера не является полностью доверенным, например в гостевых сценариях.
voip	string	Используйте его для полного доступа к API-интерфейсам вызова.
voip.join	string	Доступ к API для вызовов, но без авторизации для запуска новых вызовов.

Поделиться через