Пакет yandex_360

Описание пакета

Библиотека Yandex 360 API

Модуль yandex_360.users

Модуль функций для работы с сотрудниками. Просмотр, создание, изменение и удаление.

Примечание

Права доступа для работы с данными сотрудников:

directory:read_users — просмотр;

directory:write_users — просмотр и изменение.

yandex_360.users.add_alias_user(token, orgID, userID, body)

Функция добавляет сотруднику алиас почтового ящика

Параметры:
Результат:

результат запроса 2

Тип результата:

dict

Список 1 Тело запроса add_alias_user
{
    "alias": str,
}
Список 2 Результат запроса add_alias_user
{
    "about": str,
    "aliases": [
        str
    ],
    "avatarId": str,
    "birthday": str,
    "contacts": [
        {
            "alias": bool,
            "label": str,
            "main": bool,
            "synthetic": bool,
            "type": str,
            "value": str
        }
    ],
    "createdAt": str,
    "departmentId": int,
    "displayName": str,
    "email": str,
    "externalId": str,
    "gender": str,
    "groups": [
        int
    ],
    "id": str,
    "isAdmin": bool,
    "isDismissed": bool,
    "isEnabled": bool,
    "isRobot": bool,
    "language": str,
    "name": {
        "first": str,
        "last": str,
        "middle": str
    },
    "nickname": str,
    "position": str,
    "timezone": str,
    "updatedAt": str
}
yandex_360.users.add_user(token, orgID, body)

Функция добавляет нового сотрудника

Параметры:
Результат:

результат запроса 4

Тип результата:

dict

Список 3 Тело запроса add_user
{
    "about": str,
    "birthday": str,
    "contacts": [
        {
            "label": str,
            "type": str,
            "value": str
        }
    ],
    "departmentId": int,
    "displayName": str,
    "externalId": str,
    "gender": str,
    "isAdmin": bool,
    "isEnabled": bool,
    "language": str,
    "name": {
        "first": str,
        "last": str,
        "middle": str
    },
    "nickname": str,
    "password": str,
    "passwordChangeRequired": bool,
    "position": str,
    "timezone": str
}
Список 4 Результат запроса add_user
{
    "about": str,
    "aliases": [
        str
    ],
    "avatarId": str,
    "birthday": str,
    "contacts": [
        {
            "alias": bool,
            "label": str,
            "main": bool,
            "synthetic": bool,
            "type": str,
            "value": str
        }
    ],
    "createdAt": str,
    "departmentId": int,
    "displayName": str,
    "email": str,
    "externalId": str,
    "gender": str,
    "groups": [
        int
    ],
    "id": str,
    "isAdmin": bool,
    "isDismissed": bool,
    "isEnabled": bool,
    "isRobot": bool,
    "language": str,
    "name": {
        "first": str,
        "last": str,
        "middle": str
    },
    "nickname": str,
    "position": str,
    "timezone": str,
    "updatedAt": str
}
yandex_360.users.delete_alias_user(token, orgID, userID, alias)

Функция удаляет у сотрудника алиас почтового ящика

Параметры:
Результат:

результат запроса 5

Тип результата:

dict

Список 5 Результат запроса delete_alias_user
{
    "alias": str,
    "removed": bool
}
yandex_360.users.delete_user(token, orgID, userID)

Функция удаления пользователя

Опасно

Данная операция необратима, восстановить данные будет невозможно!

Будут удалены все почтовые сообщения, а также папки и файлы на Яндекс Диске

Параметры:
Результат:

результат запроса

Тип результата:

dict

yandex_360.users.delete_user_2fa(token, orgID, userID)

Функция сбрасывает телефон для 2FA у пользователя организации

Параметры:
Результат:

результат запроса: {}

Тип результата:

dict

yandex_360.users.delete_user_contacts(token, orgID, userID)

Функция удаляет контактную информацию сотрудника внесенную вручную

Параметры:
Результат:

результат запроса 6

Тип результата:

dict

Список 6 Результат запроса delete_user_contacts
{
    "about": str,
    "aliases": [
        str
    ],
    "avatarId": str,
    "birthday": str,
    "contacts": [
        {
            "alias": bool,
            "label": str,
            "main": bool,
            "synthetic": bool,
            "type": str,
            "value": str
        }
    ],
    "createdAt": str,
    "departmentId": int,
    "displayName": str,
    "email": str,
    "externalId": str,
    "gender": str,
    "groups": [
        int
    ],
    "id": str,
    "isAdmin": bool,
    "isDismissed": bool,
    "isEnabled": bool,
    "isRobot": bool,
    "language": str,
    "name": {
        "first": str,
        "last": str,
        "middle": str
    },
    "nickname": str,
    "position": str,
    "timezone": str,
    "updatedAt": str
}
yandex_360.users.show_user(token, orgID, userID)

Функция возвращает информацию об одном сотруднике

Параметры:
Результат:

результат запроса 7

Тип результата:

dict

Список 7 Результат запроса show_user
{
    "about": str,
    "aliases": [
        str
    ],
    "avatarId": str,
    "birthday": str,
    "contacts": [
        {
            "alias": bool,
            "label": str,
            "main": bool,
            "synthetic": bool,
            "type": str,
            "value": str
        }
    ],
    "createdAt": str,
    "departmentId": int,
    "displayName": str,
    "email": str,
    "externalId": str,
    "gender": str,
    "groups": [
        int
    ],
    "id": str,
    "isAdmin": bool,
    "isDismissed": bool,
    "isEnabled": bool,
    "isRobot": bool,
    "language": str,
    "name": {
        "first": str,
        "last": str,
        "middle": str
    },
    "nickname": str,
    "position": str,
    "timezone": str,
    "updatedAt": str
}
yandex_360.users.show_user_2fa(token, orgID, userID)

Функция возвращает информацию о статусе 2FA сотрудника

Параметры:
Результат:

результат запроса 8

Тип результата:

dict

Список 8 Результат запроса show_user_2fa
{
    "has2fa": bool,
    "userId": str
}
yandex_360.users.show_users(token, orgID, page=1, perPage=100)

Функция Возвращает список сотрудников с постраничной навигацией

Параметры:
Результат:

результат запроса 9

Тип результата:

dict

Список 9 Результат запроса show_users
{
    "page": int,
    "pages": int,
    "perPage": int,
    "total": int,
    "users": [
        {
            "about": str,
            "aliases": [
                str
            ],
            "avatarId": str,
            "birthday": str,
            "contacts": [
                {
                    "alias": bool,
                    "label": str,
                    "main": bool,
                    "synthetic": bool,
                    "type": str,
                    "value": str
                }
            ],
            "createdAt": str,
            "departmentId": int,
            "displayName": str,
            "email": str,
            "externalId": str,
            "gender": str,
            "groups": [
                int
            ],
            "id": str,
            "isAdmin": bool,
            "isDismissed": bool,
            "isEnabled": bool,
            "isRobot": bool,
            "language": str,
            "name": {
                "first": str,
                "last": str,
                "middle": str
            },
            "nickname": str,
            "position": str,
            "timezone": str,
            "updatedAt": str
        }
    ]
}
yandex_360.users.update_user(token, orgID, userID, body)

Функция изменяет информацию о сотруднике.

Примечание

Изменяются значения только тех параметров, которые были переданы в запросе.

Параметры:
Результат:

результат запроса 11

Тип результата:

dict

Список 10 Тело запроса update_user
{
    "about": str,
    "birthday": str,
    "contacts": [
        {
            "label": str,
            "type": str,
            "value": str
        }
    ],
    "departmentId": int,
    "displayName": str,
    "externalId": str,
    "gender": str,
    "isAdmin": bool,
    "isEnabled": bool,
    "language": str,
    "name": {
        "first": str,
        "last": str,
        "middle": str
    },
    "password": str,
    "passwordChangeRequired": bool,
    "position": str,
    "timezone": str
}
Список 11 Результат запроса update_user
{
    "about": str,
    "aliases": [
        str
    ],
    "avatarId": str,
    "birthday": str,
    "contacts": [
        {
            "alias": bool,
            "label": str,
            "main": bool,
            "synthetic": bool,
            "type": str,
            "value": str
        }
    ],
    "createdAt": str,
    "departmentId": int,
    "displayName": str,
    "email": str,
    "externalId": str,
    "gender": str,
    "groups": [
        int
    ],
    "id": str,
    "isAdmin": bool,
    "isDismissed": bool,
    "isEnabled": bool,
    "isRobot": bool,
    "language": str,
    "name": {
        "first": str,
        "last": str,
        "middle": str
    },
    "nickname": str,
    "position": str,
    "timezone": str,
    "updatedAt": str
}
yandex_360.users.update_user_contacts(token, orgID, userID, body)

Функция изменяет контактную информацию сотрудника.

Примечание

Автоматически созданную контактную информацию (с флагом synthetic) нельзя изменить или удалить

Параметры:
Результат:

результат запроса 13

Тип результата:

dict

Список 12 Тело запроса update_user_contacts
{
    "contacts": [
        {
            "label": str,
            "type": str,
            "value": str
        }
    ]
}
Список 13 Результат запроса update_user_contacts
{
    "about": str,
    "aliases": [
        str
    ],
    "avatarId": str,
    "birthday": str,
    "contacts": [
        {
            "alias": bool,
            "label": str,
            "main": bool,
            "synthetic": bool,
            "type": str,
            "value": str
        }
    ],
    "createdAt": str,
    "departmentId": int,
    "displayName": str,
    "email": str,
    "externalId": str,
    "gender": str,
    "groups": [
        int
    ],
    "id": str,
    "isAdmin": bool,
    "isDismissed": bool,
    "isEnabled": bool,
    "isRobot": bool,
    "language": str,
    "name": {
        "first": str,
        "last": str,
        "middle": str
    },
    "nickname": str,
    "position": str,
    "timezone": str,
    "updatedAt": str
}
yandex_360.users.upload_user_avatar(token, orgID, userID, avatar)

Функция управляет потретами пользователей организации.

Примечание

Работает только для пользователей, созданных на домене организации

Параметры:
Результат:

результат запроса 14

Тип результата:

dict

Список 14 Результат запроса upload_user_avatar
{
    "url": str
}

Модуль yandex_360.departments

Модуль функций для работы с подразделениями. Просмотр, создание, изменение и удаление.

Примечание

Права доступа для работы с подразделениями:

directory:read_departments — просмотр; directory:write_departments — просмотр и изменение.

yandex_360.departments.add_alias_department(token, orgID, depID, body)

Функция добавляет подразделению алиас почтовой рассылки.

Примечание

Запрос может быть выполнен только для подразделений, у которых уже указано основное имя почтовой рассылки в поле label

Параметры:
Результат:

результат запроса 16

Тип результата:

dict

Список 15 Тело запроса add_alias_department
{
    "alias": str
}
Список 16 Результат запроса add_alias_department
{
    "aliases": [
        str
    ],
    "createdAt": str,
    "description": str,
    "email": str,
    "externalId": str,
    "headId": str,
    "id": integer,
    "label": str,
    "membersCount": int,
    "name": str,
    "parentId": int
}
yandex_360.departments.add_department(token, orgID, body)

Функция создания подразделения

Параметры:
Результат:

результат запроса 18

Тип результата:

dict

Список 17 Тело запроса add_department
{
    "description": str,
    "externalId": str,
    "headId": str,
    "label": str,
    "name": str,
    "parentId": int
}
Список 18 Результат запроса add_department
{
    "aliases": [
        str
    ],
    "createdAt": str,
    "description": str,
    "email": str,
    "externalId": str,
    "headId": str,
    "id": integer,
    "label": str,
    "membersCount": int,
    "name": str,
    "parentId": int
}
yandex_360.departments.delete_alias_department(token, orgID, depID, alias)

Функция удаляет алиас почтовой рассылки подразделения

Опасно

Данная операция необратима, восстановить данные будет невозможно!

Параметры:
Результат:

результат запроса 19

Тип результата:

dict

Список 19 Результат запроса delete_alias_department
{
    "alias": str,
    "removed": bool
}
yandex_360.departments.delete_department(token, orgID, depID)

Функция удаляет подразделение.

Примечание

Запрос может быть выполнен только для подразделения без сотрудников и вложенных подразделений

Опасно

Данная операция необратима, восстановить данные будет невозможно!

Параметры:
Результат:

результат запроса 20

Тип результата:

dict

Список 20 Результат запроса delete_department
{
    "id": int,
    "removed": bool
}
yandex_360.departments.show_department(token, orgID, depID)

Функция возвращает информацию об одном подразделении

Параметры:
Результат:

результат запроса 21

Тип результата:

dict

Список 21 Результат запроса show_department
{
    "aliases": [
        str
    ],
    "createdAt": str,
    "description": str,
    "email": str,
    "externalId": str,
    "headId": str,
    "id": integer,
    "label": str,
    "membersCount": int,
    "name": str,
    "parentId": int
}
yandex_360.departments.show_departments(token, orgID, page=1, perPage=100, parentId=None, orderBy='id')

Функция возвращает список подразделений с постраничной навигацией

Параметры:

  • token (str) – Яндекс токен приложения

  • orgID (str) – ID организации в Яндекс 360

  • page (int) – Номер страницы ответа. Значение по умолчанию — 1

  • perPage (int) – Количество подраздлений на одной странице ответа. Значение по умолчанию — 100

  • parentId (str) – Идентификатор родительского подразделения. Если не указан, то выводятся все подразделения организации

  • orderBy (str) – Вид сортировки. Возможные значения: „id“ или „name“

Результат:

результат запроса 22

Тип результата:

dict

Список 22 Результат запроса show_departments
{
    "departments": [
        {
            "aliases": [
                str
            ],
            "createdAt": str,
            "description": str,
            "email": str,
            "externalId": str,
            "headId": str,
            "id": int,
            "label": str,
            "membersCount": int,
            "name": str,
            "parentId": int
        }
    ],
    "page": int,
    "pages": int,
    "perPage": int,
    "total": int
}
yandex_360.departments.update_department(token, orgID, depID, body)

Функция изменяет информацию о подразделении.

Примечание

Изменяются значения только тех параметров, которые были переданы в запросе.

Параметры:
Результат:

результат запроса 24

Тип результата:

dict

Список 23 Тело запроса update_department
{
    "description": str,
    "externalId": str,
    "headId": str,
    "label": str,
    "name": str,
    "parentId": int
}
Список 24 Результат запроса update_department
{
    "aliases": [
        str
    ],
    "createdAt": str,
    "description": str,
    "email": str,
    "externalId": str,
    "headId": str,
    "id": integer,
    "label": str,
    "membersCount": int,
    "name": str,
    "parentId": int
}

Модуль yandex_360.groups

Модуль функций для работы с группами. Просмотр, создание, изменение и удаление.

Примечание

Права доступа для работы с группами:

directory:read_groups — просмотр; directory:write_groups — просмотр и изменение.

yandex_360.groups.add_group(token, orgID, body)

Функция создает новую группу.

Примечание

Пользователь, от имени которого выполняется запрос, не включается в состав группы

Параметры:
Результат:

результат запроса 26

Тип результата:

dict

Список 25 Тело запроса add_group
{
    "adminIds": [
        str
    ],
    "description": str,
    "externalId": str,
    "label": str,
    "members": [
        {
            "id": str,
            "type": str
        }
    ],
    "name": str
}
Список 26 Результат запроса add_group
{
    "adminIds": [
        str
    ],
    "aliases": [
        str
    ],
    "authorId": str,
    "createdAt": str,
    "description": str,
    "email": str,
    "externalId": str,
    "id": int,
    "label": str,
    "memberOf": [
        int
    ],
    "members": [
        {
            "id": str,
            "type": str
        }
    ],
    "membersCount": int,
    "name": str,
    "removed": bool,
    "type": str
}
yandex_360.groups.add_member_group(token, orgID, groupID, body)

Функция добавляет участника в группу.

Примечание

Участником группы может быть сотрудник организации, отдельное подразделение или другая группа

Параметры:
Результат:

результат запроса 28

Тип результата:

dict

Список 27 Тело запроса add_member_group
{
    "id": str,
    "type": str
}
Список 28 Результат запроса add_member_group
{
    "added": bool,
    "id": str,
    "type": str
}
yandex_360.groups.delete_admins_group(token, orgID, groupID)

Функция удаляет всех руководителей группы

Параметры:
Результат:

результат запроса 29

Тип результата:

dict

Список 29 Результат запроса delete_admins_group
{
    "adminIds": [
        str
    ],
    "aliases": [
        str
    ],
    "authorId": str,
    "createdAt": str,
    "description": str,
    "email": str,
    "externalId": str,
    "id": int,
    "label": str,
    "memberOf": [
        int
    ],
    "members": [
        {
            "id": str,
            "type": str
        }
    ],
    "membersCount": int,
    "name": str,
    "removed": bool,
    "type": str
}
yandex_360.groups.delete_all_members_group(token, orgID, groupID)

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

Параметры:
Результат:

результат запроса 30

Тип результата:

dict

Список 30 Результат запроса delete_all_members_group
{
    "departments": [
        {
            "id": int,
            "membersCount": int,
            "name": str
        }
    ],
    "groups": [
        {
            "id": int,
            "membersCount": int,
            "name": str
        }
    ],
    "users": [
        {
            "avatarId": str,
            "departmentId": int,
            "email": str,
            "gender": str,
            "id": str,
            "name": {
                "first": str,
                "last": str,
                "middle": str
            },
            "nickname": str,
            "position": str
        }
    ]
}
yandex_360.groups.delete_group(token, orgID, groupID)

Функция удаляет группу.

Примечание

Участники, которые входили в группу, не удаляются

Опасно

Данная операция необратима, восстановить данные будет невозможно!

Параметры:
Результат:

результат запроса 31

Тип результата:

dict

Список 31 Результат запроса delete_group
{
    "id": int,
    "removed": bool
}
yandex_360.groups.delete_member_group(token, orgID, groupID, memberType, memberID)

Функция удаляет конкретного участника из группы: сотрудника организации, подразделение или вложенную группу

Параметры:
Результат:

результат запроса 32

Тип результата:

dict

Список 32 Результат запроса delete_member_group
{
    "deleted": bool,
    "id": str,
    "type": str
}
yandex_360.groups.show_group(token, orgID, groupID)

Функция возвращает информацию об одной группе

Параметры:
Результат:

результат запроса 33

Тип результата:

dict

Список 33 Результат запроса show_group
{
    "adminIds": [
        str
    ],
    "aliases": [
        str
    ],
    "authorId": str,
    "createdAt": str,
    "description": str,
    "email": str,
    "externalId": str,
    "id": int,
    "label": str,
    "memberOf": [
        int
    ],
    "members": [
        {
            "id": str,
            "type": str
        }
    ],
    "membersCount": int,
    "name": str,
    "removed": bool,
    "type": str
}
yandex_360.groups.show_groups(token, orgID, page=1, perPage=100)

Функция возвращает список групп с постраничной навигацией

Параметры:
Результат:

результат запроса 34

Тип результата:

dict

Список 34 Результат запроса show_groups
{
    "groups": [
        {
            "adminIds": [
                str
            ],
            "aliases": [
                str
            ],
            "authorId": str,
            "createdAt": str,
            "description": str,
            "email": str,
            "externalId": str,
            "id": int,
            "label": str,
            "memberOf": [
                int
            ],
            "members": [
                {
                    "id": str,
                    "type": str
                }
            ],
            "membersCount": int,
            "name": str,
            "removed": bool,
            "type": str
        }
    ],
    "page": int,
    "pages": int,
    "perPage": int,
    "total": int
}
yandex_360.groups.show_members_group(token, orgID, groupID)

Функция возвращает список участников группы, таких как сотрудники, подразделения или другие группы

Параметры:
Результат:

результат запроса 35

Тип результата:

dict

Список 35 Результат запроса show_members_group
{
    "departments": [
        {
            "id": int,
            "membersCount": int,
            "name": str
        }
    ],
    "groups": [
        {
            "id": int,
            "membersCount": int,
            "name": str
        }
    ],
    "users": [
        {
            "avatarId": str,
            "departmentId": int,
            "email": str,
            "gender": str,
            "id": str,
            "name": {
                "first": str,
                "last": str,
                "middle": str
            },
            "nickname": str,
            "position": str
        }
    ]
}
yandex_360.groups.update_admin_group(token, orgID, groupID, body)

Функция назначает руководителей группы.

Предупреждение

Руководителем группы может стать любой сотрудник организации. Изменяет сразу весь список руководителей

Параметры:
Результат:

результат запроса 37

Тип результата:

dict

Список 36 Тело запроса update_admin_group
{
    "adminIds": [
        "str"
    ]
}
Список 37 Результат запроса update_admin_group
{
    "adminIds": [
        str
    ],
    "aliases": [
        str
    ],
    "authorId": str,
    "createdAt": str,
    "description": str,
    "email": str,
    "externalId": str,
    "id": int,
    "label": str,
    "memberOf": [
        int
    ],
    "members": [
        {
            "id": str,
            "type": str
        }
    ],
    "membersCount": int,
    "name": str,
    "removed": bool,
    "type": str
}
yandex_360.groups.update_group(token, orgID, groupID, body)

Функция изменяет информацию о группе.

Примечание

Изменяются значения только тех параметров, которые были переданы в запросе.

Параметры:
Результат:

результат запроса 39

Тип результата:

dict

Список 38 Тело запроса update_group
{
    "adminIds": [
        str
    ],
    "description": str,
    "externalId": str,
    "label": str,
    "members": [
        {
            "id": str,
            "type": str
        }
    ],
    "name": str
}
Список 39 Результат запроса update_group
{
    "adminIds": [
        str
    ],
    "aliases": [
        str
    ],
    "authorId": str,
    "createdAt": str,
    "description": str,
    "email": str,
    "externalId": str,
    "id": int,
    "label": str,
    "memberOf": [
        int
    ],
    "members": [
        {
            "id": str,
            "type": str
        }
    ],
    "membersCount": int,
    "name": str,
    "removed": bool,
    "type": str
}

Модуль yandex_360.mail

Модуль функций для работы с настройками почтовых ящиков сотрудников. Работает для пользователей, аккаунты которых созданы на домене организации.

Примечание

Разрешения на использование сервиса, которые доступны при настройке приложения:

ya360_admin:mail_read_user_settings — чтение настроек почты пользователя; ya360_admin:mail_write_user_settings — управление настройками почты пользователя; ya360_admin:mail_write_shared_mailbox_inventory — управление правами доступа к почтовым ящикам; ya360_admin:mail_read_shared_mailbox_inventory — чтение информации о правах доступа к почтовым ящикам.

yandex_360.mail.delete_access_mailbox(token, orgID, userID, touserID)

Функция удаляет все права доступа сотрудника к почтовому ящику

Параметры:
Результат:

результат запроса 40

Тип результата:

dict

Список 40 Результат запроса delete_access_mailbox
{
    "taskId": str 
}
yandex_360.mail.delete_user_rules(token, orgID, userID, ruleID)

Функция удаляет конкретное правило автоответа или пересылки писем, настроенное для сотрудника

Опасно

Данная операция необратима, восстановить данные будет невозможно!

Параметры:
Результат:

результат запроса: {}

Тип результата:

dict

yandex_360.mail.edit_access_mailbox(token, orgID, userID, touserID, body)

Функция предоставляет или изменяет права доступа сотрудника к чужому почтовому ящику.

Параметры:
Результат:

результат запроса 42

Тип результата:

dict

Список 41 Тело запроса edit_access_mailbox
{
    "rights": [
        "str"
    ]
}
Список 42 Результат запроса edit_access_mailbox
{
    "taskId": str 
}
yandex_360.mail.edit_address_book(token, orgID, userID, body)

Функция позволяет управлять опцией автоматического формирования адресной книги сотрудника из адресов исходящей почты

Параметры:
Результат:

результат запроса 44

Тип результата:

dict

Список 43 Тело запроса edit_address_book
{
    "collectAddresses": bool 
}
Список 44 Результат запроса edit_address_book
{
    "collectAddresses": bool 
}
yandex_360.mail.edit_sender_info(token, orgID, userID, body)

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

Параметры:
Результат:

результат запроса 46

Тип результата:

dict

Список 45 Тело запроса edit_sender_info
{
    "defaultFrom": str,
    "fromName": str,
    "signPosition": str,
    "signs": [
        {
            "emails": [
                str
            ],
            "isDefault": bool,
            "lang": str,
            "text": str
        }
    ]
}
Список 46 Результат запроса edit_sender_info
{
    "defaultFrom": str,
    "fromName": str,
    "signPosition": str,
    "signs": [
        {
            "emails": [
                str
            ],
            "isDefault": bool,
            "lang": str,
            "text": str
        }
    ]
}
yandex_360.mail.edit_user_rules(token, orgID, userID, body)

Функция позволяет создать правило автоответа или пересылки писем для сотрудника.

Примечание

Возможность пересылки есть только на домены, которые принадлежат выбранной организации. Подтверждение получения пересылки при создании такого правила не требуется

Параметры:
Результат:

результат запроса 48

Тип результата:

dict

Список 47 Тело запроса edit_user_rules
{
    "autoreplies": [
        {
            "ruleName": string,
            "text": string
        }
    ],
    "forwards": [
        {
            "address": string,
            "ruleName": string,
            "withStore": boolean
        }
    ]
}
Список 48 Результат запроса edit_user_rules
{
    "ruleId": int 
}
yandex_360.mail.show_access_mailbox_user(token, orgID, userID)

Функция возвращает список почтовых ящиков, к которым у сотрудника есть права доступа

Параметры:
Результат:

результат запроса 49

Тип результата:

dict

Список 49 Результат запроса show_access_mailbox_user
{
    "resources": [
        {
            "resourceId": str,
            "rights": [
                str
            ]
        }
    ]
}
yandex_360.mail.show_address_book(token, orgID, userID)

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

Параметры:
Результат:

результат запроса 50

Тип результата:

dict

Список 50 Результат запроса show_address_book
{
    "collectAddresses": bool 
}
yandex_360.mail.show_sender_info(token, orgID, userID)

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

Параметры:
Результат:

результат запроса 51

Тип результата:

dict

Список 51 Результат запроса show_sender_info
{
    "defaultFrom": str,
    "fromName": str,
    "signPosition": str,
    "signs": [
        {
            "emails": [
                str
            ],
            "isDefault": bool,
            "lang": str,
            "text": str
        }
    ]
}
yandex_360.mail.show_status_access_mailbox(token, orgID, taskID)

Функция возвращает статус задачи на управление правами доступа

Параметры:
Результат:

результат запроса 49

Тип результата:

dict

Список 52 Результат запроса show_status_access_mailbox
{
    "status": str
}
yandex_360.mail.show_user_rules(token, orgID, userID)

Функция позволяет просмотреть правила автоответа и пересылки писем

Параметры:
Результат:

результат запроса 53

Тип результата:

dict

Список 53 Результат запроса show_user_rules
{
    "autoreplies": [
        {
            "ruleId": integer,
            "ruleName": string,
            "text": string
        }
    ],
    "forwards": [
        {
            "address": string,
            "ruleId": integer,
            "ruleName": string,
            "withStore": boolean
        }
    ]
}
yandex_360.mail.show_users_access_mailbox(token, orgID, userID)

Функция возвращает список сотрудников, у которых есть права доступа к почтовому ящику

Параметры:
Результат:

результат запроса 54

Тип результата:

dict

Список 54 Результат запроса show_users_access_mailbox
{
    "actors": [
        {
            "actorId": str,
            "rights": [
                str
            ]
        }
    ]
}

Модуль yandex_360.domains

Модуль функций для работы с доменами. Просмотр, создание, изменение и удаление. Получение статуса подключения и настроек доменов.

Примечание

Права доступа для работы с доменами:

directory:read_domains — просмотр; directory:write_domains — просмотр и изменение.

yandex_360.domains.add_domain(token, orgID, domain)

Функция используется, чтобы подключить новый домен.

Параметры:
Результат:

результат запроса 55

Тип результата:

dict

Список 55 Результат запроса add_domain
{
    "country": str,
    "delegated": bool,
    "master": bool,
    "mx": bool,
    "name": str,
    "status": {
        "dkim": {
            "match": bool,
            "value": str
        },
        "lastAdded": str,
        "lastCheck": str,
        "mx": {
            "match": bool,
            "value": str
        },
        "name": str,
        "ns": {
            "match": bool,
            "value": str
        },
        "spf": {
            "match": bool,
            "value": str
        }
    },
    "verified": bool
}
yandex_360.domains.delete_domain(token, orgID, domain)

Функция позволяет удалить домен.

Примечание

Вы можете удалить любой домен, кроме технического.

Опасно

Данная операция необратима, восстановить данные будет невозможно!

Параметры:
Результат:

http код

Тип результата:

dict

yandex_360.domains.disable_domain_dkim(token, orgID, domain)

Выключить DKIM подпись для домена

Примечание

Для кириллических доменов (например домен.рф) используйте кодировку Punycode.

Параметры:
Результат:

http код

Тип результата:

dict

yandex_360.domains.enable_domain_dkim(token, orgID, domain)

Включить DKIM подпись для домена

Примечание

Для кириллических доменов (например домен.рф) используйте кодировку Punycode.

Параметры:
Результат:

http код

Тип результата:

dict

yandex_360.domains.show_domains(token, orgID, page=1, perPage=100)

Функция возвращает список доменов организации с постраничной навигацией

Параметры:
Результат:

результат запроса 56

Тип результата:

dict

Список 56 Результат запроса show_domain
{
    "domains": [
        {
            "country": str,
            "delegated": bool,
            "master": bool,
            "mx": bool,
            "name": str,
            "status": {
                "dkim": {
                    "match": bool,
                    "value": str
                },
                "lastAdded": str,
                "lastCheck": str,
                "mx": {
                    "match": bool,
                    "value": str
                },
                "name": str,
                "ns": {
                    "match": bool,
                    "value": str
                },
                "spf": {
                    "match": bool,
                    "value": str
                }
            },
            "verified": bool
        }
    ],
    "page": int,
    "pages": int,
    "perPage": int,
    "total": int
}
yandex_360.domains.status_domain(token, orgID, domain)

Проверяет статус подключения домена.

Примечание

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

Для кириллических доменов (например домен.рф) используйте кодировку Punycode.

Параметры:
Результат:

результат запроса 57

Тип результата:

dict

Список 57 Результат запроса status_domain
{
    "methods": [
        {
            "code": str,
            "method": str
        }
    ],
    "status": str
}
yandex_360.domains.status_domain_dkim(token, orgID, domain)

Получить статус DKIM подпись для домена

Примечание

Для кириллических доменов (например домен.рф) используйте кодировку Punycode.

Параметры:
Результат:

результат запроса 58

Тип результата:

dict

Список 58 Результат запроса status_domain_dkim
{
    "enabled": bool,
    "publicKey": str
}

Модуль yandex_360.dns

Модуль функций для управления DNS записями домена

Примечание

Разрешения работы с DNS:

directory:manage_dns — управление DNS (чтение и запись).

yandex_360.dns.add_dns(token, orgID, domain, body)

Функция позволяет добавить DNS-запись

Параметры:
Результат:

результат запроса 60

Тип результата:

dict

Список 59 Тело запроса add_dns
{
    "address": str,
    "exchange": str,
    "flag": int,
    "name": str,
    "port": int,
    "preference": int,
    "priority": int,
    "tag": str,
    "target": str,
    "text": str,
    "ttl": int,
    "type": str,
    "value": str,
    "weight": int
}
Список 60 Результат запроса add_dns
{
    "address": str,
    "exchange": str,
    "flag": int,
    "name": str,
    "port": int,
    "preference": int,
    "priority": int,
    "tag": str,
    "target": str,
    "text": str,
    "ttl": int,
    "type": str,
    "value": str,
    "weight": int
}
yandex_360.dns.delete_dns(token, orgID, domain, recordID)

Функция позволяет удалить DNS-запись

Опасно

Данная операция необратима, восстановить данные будет невозможно!

Параметры:
Результат:

результат запроса

Тип результата:

dict

yandex_360.dns.edit_dns(token, orgID, domain, recordID, body)

Функция позволяет добавить DNS-запись

Параметры:
Результат:

результат запроса 62

Тип результата:

dict

Список 61 Тело запроса edit_dns
{
    "address": str,
    "exchange": str,
    "name": str,
    "port": int,
    "preference": int,
    "priority": int,
    "target": str,
    "text": str,
    "ttl": int,
    "type": str,
    "weight": int
}
Список 62 Результат запроса edit_dns
{
    "address": str,
    "exchange": str,
    "flag": int,
    "name": str,
    "port": int,
    "preference": int,
    "priority": int,
    "tag": str,
    "target": str,
    "text": str,
    "ttl": int,
    "type": str,
    "value": str,
    "weight": int
}
yandex_360.dns.show_dns(token, orgID, domain, page=1, perPage=100)

Функция позволяет получить все DNS-записи, которые были установлены для домена

Параметры:
Результат:

результат запроса 63

Тип результата:

dict

Список 63 Результат запроса show_dns
{
    "page": int,
    "pages": int,
    "perPage": int,
    "records": [
        {
            "address": str,
            "exchange": str,
            "flag": int,
            "name": str,
            "port": int,
            "preference": int,
            "priority": int,
            "recordId": int,
            "tag": str,
            "target": str,
            "text": str,
            "ttl": int,
            "type": str,
            "value": str,
            "weight": int
        }
    ],
    "total": int
}

Модуль yandex_360.pwd

Модуль позволяет управлять параметрами паролей пользователей организации.

Примечание

Разрешения на использование сервиса, которые доступны при настройке приложения:

ya360_security:domain_passwords_read — чтение информации о параметрах паролей пользователей; ya360_security:domain_passwords_write — управление параметрами паролей пользователей.

yandex_360.pwd.edit_domain_passwords(token, orgID, body)

Функция позволяет управлять парольной политикой пользователей организации:

разрешать или запрещать самостоятельную смену пароля; устанавливать периодичность смены пароля.

Параметры:
Результат:

результат запроса 65

Тип результата:

dict

Список 64 Тело запроса edit_domain_passwords
{
    "changeFrequency": int,
    "enabled": bool
}
Список 65 Результат запроса edit_domain_passwords
{
    "changeFrequency": int,
    "enabled": bool
}
yandex_360.pwd.show_domain_passwords(token, orgID)

Функция позволяет просмотреть параметры парольной политики в организации:

Наличие у пользователей возможности самостоятельно менять пароль; Наличие и длительность (в днях) срока действия пароля.

Параметры:
Результат:

результат запроса 66

Тип результата:

dict

Список 66 Результат запроса show_domain_passwords
{
    "changeFrequency": int,
    "enabled": bool
}

Модуль yandex_360.auth

Модуль для управления временем жизни cookie сессий пользователей. Позволяет выйти из аккаунта пользователя на всех устройствах.

Примечание

Разрешения на использование сервиса, которые доступны при настройке приложения:

ya360_security:domain_sessions_read — чтение информации о времени жизни cookie сессий пользователей; ya360_security:domain_sessions_write — управление временем жизни cookie сессий пользователей и авторизацией.

yandex_360.auth.close_domain_sessions(token, orgID, userID)

Функция позволяет выйти из аккаунта определенного пользователя на всех устройствах, где произведен вход.

Опасно

Данная функция удаляет все пароли приложений!

Параметры:
Результат:

результат запроса: {}

Тип результата:

dict

yandex_360.auth.edit_domain_sessions(token, orgID, body)

Функция позволяет возможность поменять время жизни cookie сессий пользователей организации.

Предупреждение

Ограничение. Чтобы выполнить запрос, приложению требуется разрешение на управление временем жизни cookie сессий пользователей и авторизацией.

Параметры:
Результат:

результат запроса 68

Тип результата:

dict

Список 67 Тело запроса edit_domain_sessions
{
    "authTTL": int
}
Список 68 Результат запроса edit_domain_sessions
{
    "authTTL": int
}
yandex_360.auth.show_domain_sessions(token, orgID)

Функция возвращает время жизни cookie сессий пользователей организации. Значение по умолчанию — 0. Это значит, что время жизни cookie сессий не ограничено.

Параметры:
Результат:

результат запроса 69

Тип результата:

dict

Список 69 Результат запроса show_domain_sessions
{
    "authTTL": int
}

Модуль yandex_360.logs

Модуль для управления аудит-логов.

yandex_360.logs.disk_log(token, orgID, pageSize=100, pageToken=None, beforeDate=None, afterDate=None, includeUids=None, excludeUids=None)

Функция возвращает список событий в аудит-логе Диска организации.

Параметры:

  • token (str) – Яндекс токен приложения

  • orgID (str) – ID организации в Яндекс 360

  • pageSize (int) – Количество событий на странице

  • pageToken (str) – Токен постраничной навигации

  • beforeDate (str) – Верхняя граница периода выборки в формате ISO 8601

  • afterDate (str) – Нижняя граница периода выборки в формате ISO 8601

  • includeUids (list) – Список пользователей, действия которых должны быть включены в список событий

  • excludeUids (list) – Список пользователей, действия которых должны быть исключены из списка событий

Результат:

результат запроса 70

Тип результата:

dict

Список 70 Результат запроса disk_log
{
    "events": [
        {
            "clientIp": str,
            "date": str,
            "eventType": str,
            "lastModificationDate": str,
            "orgId": int,
            "ownerLogin": str,
            "ownerName": str,
            "ownerUid": str,
            "path": str,
            "requestId": str,
            "resourceFileId": str,
            "rights": str,
            "size": str,
            "uniqId": str,
            "userLogin": str,
            "userName": str,
            "userUid": str
        }
    ],
    "nextPageToken": str
}
yandex_360.logs.mail_log(token, orgID, pageSize=100, pageToken=None, beforeDate=None, afterDate=None, includeUids=None, excludeUids=None, types=None)

Функция возвращает список событий в аудит-логе Почте организации.

Параметры:

  • token (str) – Яндекс токен приложения

  • orgID (str) – ID организации в Яндекс 360

  • pageSize (int) – Количество событий на странице

  • pageToken (str) – Токен постраничной навигации

  • beforeDate (str) – Верхняя граница периода выборки в формате ISO 8601

  • afterDate (str) – Нижняя граница периода выборки в формате ISO 8601

  • includeUids (list) – Список пользователей, действия которых должны быть включены в список событий

  • excludeUids (list) – Список пользователей, действия которых должны быть исключены из списка событий

  • types (list) – Типы событий которые должны быть включены в список. По умолчанию включаются все события

Результат:

результат запроса 71

Тип результата:

dict

Список 71 Результат запроса mail_log
{
    "events": [
        {
            "bcc": str,
            "cc": str,
            "clientIp": str,
            "date": str,
            "destMid": str,
            "eventType": str,
            "folderName": str,
            "folderType": str,
            "from": str,
            "labels": [
                str
            ],
            "mid": str,
            "msgId": str,
            "orgId": int,
            "requestId": str,
            "source": str,
            "subject": str,
            "to": str,
            "uniqId": str,
            "userLogin": str,
            "userName": str,
            "userUid": str
        }
    ],
    "nextPageToken": str
}

Модуль yandex_360.a2fa

Модуль для управления обязательной двухфакторной аутентификацией (2FA) пользователей домена.

Примечание

Разрешения на использование сервиса, которые доступны при настройке приложения:

ya360_security:domain_2fa_write — управление обязательной 2FA для пользователей.

yandex_360.a2fa.disable_domain_2fa(token, orgID, body)

Функция включает обязательную двухфакторную аутентификацию (2FA) для пользователей домена.

Параметры:
Результат:

результат запроса 72

Тип результата:

dict

Список 72 Результат запроса disable_domain_2fa
{
    "duration": int,
    "enabled": bool,
    "enabledAt": str
}
yandex_360.a2fa.enable_domain_2fa(token, orgID, body)

Функция включает обязательную двухфакторную аутентификацию (2FA) для пользователей домена.

Параметры:
Результат:

результат запроса 74

Тип результата:

dict

Список 73 Тело запроса enable_domain_2fa
{
    "duration": int,
    "logoutUsers": bool,
    "validationMethod": str
}
Список 74 Результат запроса enable_domain_2fa
{
    "duration": int,
    "enabled": bool,
    "enabledAt": str
}
yandex_360.a2fa.show_domain_2fa(token, orgID)

Функция Возвращает статус обязательной двухфакторной аутентификации (2FA) для пользователей домена.

Параметры:
Результат:

результат запроса 75

Тип результата:

dict

Список 75 Результат запроса show_domain_2fa
{
    "duration": int,
    "enabled": bool,
    "enabledAt": str
}

Модуль yandex_360.org

Модуль функций для просмотра организаций пользователя

yandex_360.org.show_orgs(token, orgID, pageSize=100, pageToken=None)

Функция возвращает список организаций пользователя

Параметры:

  • token (str) – Яндекс токен приложения

  • pageSize (int) – Количество организаций на странице. Максимальное значение — 100. По умолчанию — 100

  • pageToken (str) – Токен постраничной навигации

Результат:

результат запроса 76

Тип результата:

dict

Список 76 Результат запроса show_orgs
{
    "nextPageToken": str,
    "organizations": [
        {
            "email": str,
            "fax": str,
            "id": int,
            "language": str,
            "name": str,
            "phone": str,
            "subscriptionPlan": str
        }
    ]
}

Модуль yandex_360.tools

Модуль вспомогательных функций

yandex_360.tools.check_request(req)

Функция проверки ответа запроса

Параметры:

req (dict) – результат запроса

yandex_360.tools.get_departments(token, orgID)

Функция возвращает список подразделений

Параметры:
Результат:

результат запроса 77

Тип результата:

dict

Список 77 Результат запроса get_departments
{
    "departments": [
        {
            "aliases": [
                str
            ],
            "createdAt": str,
            "description": str,
            "email": str,
            "externalId": str,
            "headId": str,
            "id": int,
            "label": str,
            "membersCount": int,
            "name": str,
            "parentId": int
        }
    ],
    "page": int,
    "pages": int,
    "perPage": int,
    "total": int
}
yandex_360.tools.get_disk_log(token, orgID, beforeDate=None, afterDate=None, includeUids=None, excludeUids=None)

Функция возвращает список событий в аудит-логе Диска организации.

Параметры:

  • token (str) – Яндекс токен приложения

  • orgID (str) – ID организации в Яндекс 360

  • beforeDate (str) – Верхняя граница периода выборки в формате ISO 8601

  • afterDate (str) – Нижняя граница периода выборки в формате ISO 8601

  • includeUids (str) – Список пользователей, действия которых должны быть включены в список событий

  • excludeUids (str) – Список пользователей, действия которых должны быть исключены из списка событий

Результат:

результат запроса 78

Тип результата:

dict

Список 78 Результат запроса get_disk_log
{
    "events": [
        {
            "clientIp": str,
            "date": str,
            "eventType": str,
            "lastModificationDate": str,
            "orgId": int,
            "ownerLogin": str,
            "ownerName": str,
            "ownerUid": str,
            "path": str,
            "requestId": str,
            "resourceFileId": str,
            "rights": str,
            "size": str,
            "uniqId": str,
            "userLogin": str,
            "userName": str,
            "userUid": str
        }
    ],
    "nextPageToken": str
}
yandex_360.tools.get_dns(token, orgID, domain)

Функция позволяет получить все DNS-записи, которые были установлены для домена

Параметры:
Результат:

результат запроса 79

Тип результата:

dict

Список 79 Результат запроса get_dns
{
    "page": int,
    "pages": int,
    "perPage": int,
    "records": [
        {
            "address": str,
            "exchange": str,
            "flag": int,
            "name": str,
            "port": int,
            "preference": int,
            "priority": int,
            "recordId": int,
            "tag": str,
            "target": str,
            "text": str,
            "ttl": int,
            "type": str,
            "value": str,
            "weight": int
        }
    ],
    "total": int
}
yandex_360.tools.get_domains(token, orgID)

Функция возвращает список доменов организации

Параметры:
Результат:

результат запроса 80

Тип результата:

dict

Список 80 Результат запроса get_domain
{
    "domains": [
        {
            "country": str,
            "delegated": bool,
            "master": bool,
            "mx": bool,
            "name": str,
            "status": {
                "dkim": {
                    "match": bool,
                    "value": str
                },
                "lastAdded": str,
                "lastCheck": str,
                "mx": {
                    "match": bool,
                    "value": str
                },
                "name": str,
                "ns": {
                    "match": bool,
                    "value": str
                },
                "spf": {
                    "match": bool,
                    "value": str
                }
            },
            "verified": bool
        }
    ],
    "page": int,
    "pages": int,
    "perPage": int,
    "total": int
}
yandex_360.tools.get_groups(token, orgID)

Функция возвращает список групп

Параметры:
Результат:

результат запроса 81

Тип результата:

dict

Список 81 Результат запроса get_groups
{
    "groups": [
        {
            "adminIds": [
                str
            ],
            "aliases": [
                str
            ],
            "authorId": str,
            "createdAt": str,
            "description": str,
            "email": str,
            "externalId": str,
            "id": int,
            "label": str,
            "memberOf": [
                int
            ],
            "members": [
                {
                    "id": str,
                    "type": str
                }
            ],
            "membersCount": int,
            "name": str,
            "removed": bool,
            "type": str
        }
    ],
    "page": int,
    "pages": int,
    "perPage": int,
    "total": int
}
yandex_360.tools.get_id_department_by_label(sstr, token, orgID)

Функция преобразования label подразделения в id

Параметры:
Результат:

ID подразделения: {„id“: int}

Тип результата:

dict

yandex_360.tools.get_id_group_by_label(sstr, token, orgID)

Функция преобразования label группы в id

Параметры:
Результат:

ID группы: {„id“: int}

Тип результата:

dict

yandex_360.tools.get_id_user_by_nickname(sstr, token, orgID)

Функция преобразования nickname пользователя в id

Параметры:
Результат:

ID пользователя {„id“: str}

Тип результата:

dict

yandex_360.tools.get_mail_log(token, orgID, beforeDate=None, afterDate=None, includeUids=None, excludeUids=None, types=None)

Функция возвращает список событий в аудит-логе Почте организации.

Параметры:

  • token (str) – Яндекс токен приложения

  • orgID (str) – ID организации в Яндекс 360

  • beforeDate (str) – Верхняя граница периода выборки в формате ISO 8601

  • afterDate (str) – Нижняя граница периода выборки в формате ISO 8601

  • includeUids (str) – Список пользователей, действия которых должны быть включены в список событий

  • excludeUids (str) – Список пользователей, действия которых должны быть исключены из списка событий

  • types (str) – Типы событий которые должны быть включены в список. По умолчанию включаются все события

Результат:

результат запроса 82

Тип результата:

dict

Список 82 Результат запроса get_mail_log
{
    "events": [
        {
            "bcc": str,
            "cc": str,
            "clientIp": str,
            "date": str,
            "destMid": str,
            "eventType": str,
            "folderName": str,
            "folderType": str,
            "from": str,
            "labels": [
                str
            ],
            "mid": str,
            "msgId": str,
            "orgId": int,
            "requestId": str,
            "source": str,
            "subject": str,
            "to": str,
            "uniqId": str,
            "userLogin": str,
            "userName": str,
            "userUid": str
        }
    ],
    "nextPageToken": str
}
yandex_360.tools.get_orgs(token, orgID)

Функция возвращает список организаций пользователя

Параметры:

token (str) – Яндекс токен приложения

Результат:

результат запроса 83

Тип результата:

dict

Список 83 Результат запроса get_orgs
{
    "nextPageToken": str,
    "organizations": [
        {
            "email": str,
            "fax": str,
            "id": int,
            "language": str,
            "name": str,
            "phone": str,
            "subscriptionPlan": str
        }
    ]
}
yandex_360.tools.get_users(token, orgID)

Функция Возвращает список сотрудников

Параметры:
Результат:

результат запроса 84

Тип результата:

dict

Список 84 Результат запроса get_users
{
    "page": int,
    "pages": int,
    "perPage": int,
    "total": int,
    "users": [
        {
            "about": str,
            "aliases": [
                str
            ],
            "avatarId": str,
            "birthday": str,
            "contacts": [
                {
                    "alias": bool,
                    "label": str,
                    "main": bool,
                    "synthetic": bool,
                    "type": str,
                    "value": str
                }
            ],
            "createdAt": str,
            "departmentId": int,
            "displayName": str,
            "email": str,
            "externalId": str,
            "gender": str,
            "groups": [
                int
            ],
            "id": str,
            "isAdmin": bool,
            "isDismissed": bool,
            "isEnabled": bool,
            "isRobot": bool,
            "language": str,
            "name": {
                "first": str,
                "last": str,
                "middle": str
            },
            "nickname": str,
            "position": str,
            "timezone": str,
            "updatedAt": str
        }
    ]
}

Модуль yandex_360.antispam

Модуль для работы с настройками антиспама.

Примечание

Разрешения на использование сервиса, которые доступны при настройке приложения:

ya360_admin:mail_read_antispam_settings — чтение настроек антиспама; ya360_admin:mail_write_antispam_settings — управление настройками антиспама (чтение и запись).

yandex_360.antispam.create_whitelist(token, orgID, body)

Функция создания или замены содержимого белого списка

Параметры:
Результат:

результат запроса: {}

Тип результата:

dict

Список 85 Тело запроса create_whitelist
{
    "allowList": [
        str
    ]
}
yandex_360.antispam.delete_whitelist(token, orgID)

Функция удаления содержимого белого списка

Параметры:
Результат:

результат запроса: {}

Тип результата:

dict

yandex_360.antispam.show_whitelist(token, orgID)

Функция вывода содержимого белого списка

Параметры:
Результат:

результат запроса 86

Тип результата:

dict

Список 86 Результат запроса show_whitelist
{
    "allowList": [
        str
    ]
}

Модуль yandex_360.routing

Инструмент для управления потоком входящих писем на уровне домена. Управление подразумевает создание специальных правил обработки писем для сотрудников организации, выполняется Администратором и определяет настройки имеющие приоритет над пользовательскими.

Примечание

Разрешения на использование сервиса, которые доступны при настройке приложения:

ya360_admin:mail_write_routing_rules — просмотр и изменения; ya360_admin:mail_read_routing_rules — просмотр.

yandex_360.routing.edit_routing(token, orgID, body)

Функция изменения содержимого таблицы правил обработки почты

Параметры:
Результат:

пустой словарь: {}

Тип результата:

dict

Список 87 Тело запроса edit_routing
{
    "rules": [
        {
            "actions": [
                {
                    "action": str,
                    "data": {
                        "email": str
                    }
                }
            ],
            "terminal": bool
        }
    ]
}
yandex_360.routing.show_routing(token, orgID)

Функция вывода содержимого таблицы правил обработки почты

Параметры:
Результат:

результат запроса 88

Тип результата:

dict

Список 88 Результат запроса show_routing
{
    "rules": [
        {
            "actions": [
                {}
            ],
            "terminal": bool
        }
    ]
}