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

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

Для выполнения запроса требуется одно из перечисленных прав: ya360_admin:mail_read_mail_list_permissions или ya360_admin:mail_write_mail_list_permissions.

Request

GET

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

Path parameters

Name

Description

mail_list_id

Type: string

Идентификатор рассылки.

Example: 1230000000000001

org_id

Type: string

Идентификатор организации.

Example: 1234567

Responses

200 OK

Получен список субъектов с разрешениями на отправку писем на адрес рассылки.

Body

application/json
{
  "grants": {
    "items": [
      {
        "subject": {
          "type": "user",
          "id": 1230000000000001,
          "org_id": 1234567
        },
        "roles": {
          "items": [
            null
          ]
        }
      }
    ]
  }
}

Name

Description

grants

Type: Grants

Объект Grants с информацией о разрешениях.

Example
{
  "items": [
    {
      "subject": {
        "type": "user",
        "id": 1230000000000001,
        "org_id": 1234567
      },
      "roles": {
        "items": [
          {}
        ]
      }
    }
  ]
}

A360subjectType

Информация о субъекте, имеющем разрешение.

Name

Description

id

Type: integer

Идентификатор субъекта. Для типа anonymous — всегда null.

type

Type: string

Тип субъекта:

  • user — пользователь;
  • shared_mailbox — общий почтовый ящик;
  • group — группа;
  • department — подразделение;
  • organization — вся организация;
  • anonymous — любой пользователь.

Enum: organization, user, group, department, anonymous, shared_mailbox

org_id

Type: integer

Идентификатор организации (0 — если пользователь не относится ни к одной организации). Необязателен для anonymous.
Example
{
  "type": "user",
  "id": 1230000000000001,
  "org_id": 1234567
}

RoleItem

Объект Role Item со списком разрешений субъекта.

Name

Description

description

Type: string

Описание разрешения — параметр не используется.

Example: ``

name

Type: string

Наименование разрешения — параметр не используется.

Example: ``

slug

Type: string

Тип разрешения:

  • mail_list_sender — разрешение на отправку писем на адрес рассылки;
  • mail_list_half_sender — дополнительный тип разрешения на отправку писем.

Enum: mail_list_sender, mail_list_half_sender
Example
{
  "slug": "mail_list_sender",
  "name": "",
  "description": ""
}

RolesItems

Массив объектов Role Item со списком разрешений субъекта.

Type: RoleItem[]

Example
[
  {
    "slug": "mail_list_sender",
    "name": "",
    "description": ""
  }
]

Roles

Объект Roles с информацией о разрешениях субъекта.

Name

Description

items

Type: RolesItems

Массив объектов Role Item со списком разрешений субъекта.

Example
[
  {
    "slug": "mail_list_sender",
    "name": "",
    "description": ""
  }
]
Example
{
  "items": [
    {
      "slug": "mail_list_sender",
      "name": "",
      "description": ""
    }
  ]
}

GrantItem

Name

Description

roles

Type: Roles

Объект Roles с информацией о разрешениях субъекта.

Example
{
  "items": [
    {
      "slug": "mail_list_sender",
      "name": "",
      "description": ""
    }
  ]
}

subject

Type: A360subjectType

Информация о субъекте, имеющем разрешение.

Example
{
  "type": "user",
  "id": 1230000000000001,
  "org_id": 1234567
}
Example
{
  "subject": {
    "type": "user",
    "id": 1230000000000001,
    "org_id": 1234567
  },
  "roles": {
    "items": [
      {
        "slug": "mail_list_sender",
        "name": "",
        "description": ""
      }
    ]
  }
}

GrantsItems

Массив объектов Grant Item со списками разрешений.

Type: GrantItem[]

Example
[
  {
    "subject": {
      "type": "user",
      "id": 1230000000000001,
      "org_id": 1234567
    },
    "roles": {
      "items": [
        {
          "slug": "mail_list_sender",
          "name": "",
          "description": ""
        }
      ]
    }
  }
]

Grants

Объект Grants с информацией о разрешениях.

Name

Description

items

Type: GrantsItems

Массив объектов Grant Item со списками разрешений.

Example
[
  {
    "subject": {
      "type": "user",
      "id": 1230000000000001,
      "org_id": 1234567
    },
    "roles": {
      "items": [
        {
          "slug": "mail_list_sender",
          "name": "",
          "description": ""
        }
      ]
    }
  }
]
Example
{
  "items": [
    {
      "subject": {
        "type": "user",
        "id": 1230000000000001,
        "org_id": 1234567
      },
      "roles": {
        "items": [
          {}
        ]
      }
    }
  ]
}

400 Bad Request

Неверный формат запроса

Body

application/json
{
  "error": "bad_request",
  "description": "Неверный формат запроса",
  "message": "Неверный формат запроса",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Неверный формат запроса

error

Type: string

Код ошибки

Example: bad_request

message

Type: string

Сообщение об ошибке.

Example: Неверный формат запроса

details
Type: object

Дополнительные детали ошибки

Example
{}

403 Forbidden

Доступ запрещен

Body

application/json
{
  "error": "forbidden",
  "description": "Доступ запрещен",
  "message": "Доступ запрещен",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Доступ запрещен

error

Type: string

Код ошибки

Example: forbidden

message

Type: string

Сообщение об ошибке.

Example: Доступ запрещен

details
Type: object

Дополнительные детали ошибки

Example
{}

404 Not Found

Один из переданных параметров не существует

Body

application/json
{
  "error": "not_found",
  "description": "Один из переданных параметров не существует",
  "message": "Один из переданных параметров не существует",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Один из переданных параметров не существует

error

Type: string

Код ошибки

Example: not_found

message

Type: string

Сообщение об ошибке.

Example: Один из переданных параметров не существует

details
Type: object

Дополнительные детали ошибки

Example
{}

409 Conflict

Невозможно назначить права по какой-то причине (например, попытались назначить админом анонима или субъектов, принадлежащих разным организациям)

Body

application/json
{
  "error": "conflict",
  "description": "Невозможно назначить права по какой-то причине (например, попытались назначить админом анонима или субъектов, принадлежащих разным организациям)",
  "message": "Невозможно назначить права по какой-то причине (например, попытались назначить админом анонима или субъектов, принадлежащих разным организациям)",
  "details": {}
}

Name

Description

description

Type: string

Техническое описание ошибки.

Example: Невозможно назначить права по какой-то причине (например, попытались назначить админом анонима или субъектов, принадлежащих разным организациям)

error

Type: string

Код ошибки

Example: conflict

message

Type: string

Сообщение об ошибке.

Example: Невозможно назначить права по какой-то причине (например, попытались назначить админом анонима или субъектов, принадлежащих разным организациям)

details
Type: object

Дополнительные детали ошибки

Example
{}
Предыдущая
Обзор
Следующая
Изменить список отправителей