Получить список разрешенных отправителей рассылок на группы и подразделения

Возвращает список пользователей, групп и подразделений, имеющих право отправлять письма на адреса почтовых рассылок.

Примечание

Чтобы выполнить запрос, приложению требуется разрешение:
ya360_admin:mail_read_mail_list_permissions — просмотр разрешений на рассылку.

Запрос

GET https://cloud-api.yandex.net/v1/admin/org/{org_id}/mail-lists/{mail_list_id}/permissions

Path-параметры

Имя параметра	Тип	Описание
org_id *	integer	Идентификатор организации.
mail_list_id *	integer	Идентификатор рассылки.

Заголовки

Authorization: OAuth <токен>

Пример

Пример запроса

curl -X GET -H "Authorization: OAuth <токен>" https://cloud-api.yandex.net/v1/admin/org/1234567/mail-lists/1150000045826541/permissions

Ответ

Успешный ответ

Результатом корректного запроса является ответ с кодом 200 и телом в формате JSON, где содержится объект со списком разрешений.

200 OK — запрос выполнен успешно.

Имя параметра	Тип	Описание
grants *	object	Объект Grants с информацией о разрешениях.

Grants

Имя параметра	Тип	Описание
items *	array	Массив объектов Grant Item со списками разрешений.

Grant Item

Имя параметра	Тип	Описание
roles *	object	Объект Roles с информацией о разрешениях субъекта.
subject *	object	Информация о субъекте, имеющем разрешения.

Roles

Имя параметра	Тип	Описание
items *	array	Массив объектов Role Item со списком разрешений субъекта.

Role Item

Имя параметра	Тип	Описание
description	string	Описание разрешения — параметр не используется.
name	string	Наименование разрешения — параметр не используется.
slug *	string	Тип разрешения — всегда `mail_list_sender`.

Subject

Имя параметра	Тип	Описание
org_id	integer	Идентификатор организации (`0` — если пользователь не относится ни к одной организации). Необязателен для `anonymous`.
type *	string	Тип субъекта: `user` — пользователь; `shared_mailbox` — общий почтовый ящик; `group` — группа; `department` — подразделение; `organization` — вся организация; `anonymous` — любой пользователь.
id *	integer	Идентификатор субъекта. Для типа `anonymous` — всегда `null`.

Пример

Пример ответа

{
  "grants": {
    "items": [
      {
        "roles": {
          "items": [
            {
              "description": "",
              "name": "",
              "slug": "mail_list_sender"
            }
          ]
        },
        "subject": {
          "type": "anonymous",
          "id": null
        }
      },
      {
        "roles": {
          "items": [
            {
              "description": "",
              "name": "",
              "slug": "mail_list_sender"
            }
          ]
        },
        "subject": {
          "org_id": 7848855,
          "type": "user",
          "id": 1130000066824692
        }
      },
      {
        "roles": {
          "items": [
            {
              "description": "",
              "name": "",
              "slug": "mail_list_sender"
            }
          ]
        },
        "subject": {
          "org_id": 7848855,
          "type": "organization",
          "id": 7848855
        }
      }
    ]
  }
}

Неуспешный ответ

Ошибки могут быть со следующими HTTP-статусами:

400 Bad Request — параметры запроса не заданы или заданы неверно;
401 Unauthorized — пользователь не авторизован;
403 Forbidden — у пользователя или приложения нет прав на доступ к списку разрешений;
404 Not Found — запрашиваемая рассылка организации не найдена;
500 Internal Server Error — ошибка произошла на стороне сервера (в этом случае попробуйте повторно отправить запрос через некоторое время).

Была ли статья полезна?

Обзор

Изменить список отправителей