Communication Identity - Issue Access Token

Service:

Communication

API Version:

2023-10-01

Выдача нового маркера для удостоверения.

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

Параметры URI

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

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

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

Ответы

Имя	Тип	Описание
200 OK	CommunicationIdentityAccessToken	Успешное завершение
Other Status Codes	CommunicationErrorResponse	Ошибка

Примеры

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.

Sample Request

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
}

Sample Response

Status code:

200

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

Определения

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

CommunicationError

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

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

CommunicationErrorResponse

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

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

CommunicationIdentityAccessToken

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

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

CommunicationIdentityAccessTokenRequest

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

CommunicationIdentityTokenScope

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

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