Изменить права доступа к ящику

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

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

Примечание

Чтобы выполнить запрос, приложению требуется разрешение на управление правами доступа к почтовым ящикам. Убедитесь, что вы включили его при настройке приложения на OAuth-сервере Яндекса.

Request

POST

https://api360.yandex.net/admin/v1/org/{orgId}/mailboxes/set/{resourceId}

Path parameters

Name

Description

orgId*

Type: integer<int64>

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

resourceId*

Type: string<uint64>

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

Query parameters

Name

Description

actorId*

Type: string<uint64>

Идентификатор сотрудника, для которого настраивается доступ.

notify

Type: string

Кому необходимо отправить письмо-уведомление об изменении прав доступа к ящику.

Возможные значения:

  • all — владельцу почтового ящика и сотруднику, для которого настраивается доступ к нему;
  • delegates — только сотруднику, для которого настраивается доступ к почтовому ящику;
  • none — никому.

Default: all

Enum: all, delegates, none

Body

application/json
{
    "roles": [
        "string"
    ]
}

Name

Description

roles*

Type: string[]

Список ролей, на которые назначается сотрудник.

Возможные значения:

  • роли, которые регулируют доступ сотрудника к другому ящику в веб-интерфейсе Яндекс Почты (в разработке):
    • shared_mailbox_reader
      просмотр ящика в веб-интерфейсе Яндекс Почты;
    • shared_mailbox_editor
      редактирование ящика в веб-интерфейсе Яндекс Почты;
    • shared_mailbox_admin
      управление ящиком в веб-интерфейсе Яндекс Почты;
  • роль, которая регулирует доступ сотрудника к другому ящику в почтовых программах (по IMAP):
    • shared_mailbox_imap_admin
      управление ящиком в IMAP-клиенте;
  • роли, которые предоставляют возможность отправки писем:
    • shared_mailbox_sender
      отправка писем;
    • shared_mailbox_half_sender
      ограниченная отправка писем в почтовых программах (по SMTP);
  • роль, которая задает максимальный набор прав на другой ящик:
    • shared_mailbox_owner
      полные права на ящик, к которому предоставляется доступ.

Полные права на ящик:

  • в веб-интерфейсе Яндекс Почты (в разработке) — управление ящиком (чтение, разметка, перемещение и удаление писем; создание и удаление папок, меток. подписей и правил обработки писем) и отправка писем в режиме в режиме «Отправить как»;
  • в почтовых клиентах — управление ящиком по IMAP (чтение, разметка, перемещение и удаление писем; создание и удаление папок, меток. подписей и правил обработки писем) и отправка писем по SMTP (как в режиме «Отправить от имени», так и в режиме «Отправить как»).

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

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

Права на чтение и разметку писем. Возможности отправлять письма роль не дает.

Полный доступ на управление содержимым почтового ящика по протоколу IMAP: чтение, разметка и удаление писем, управление папками. Отправка писем не предусмотрена.

Возможность отправлять письма:

  • в веб-интерфейсе Яндекс Почты — в режиме «Отправить как» (Send as — без указания фактического отправителя).
  • в почтовых клиентах — как в режиме «Отправить от имени» (Send on behalf — с указанием сотрудника, который отправляет письмо от имени владельца ящика), так и в режиме «Отправить как» (Send as — без указания фактического отправителя).

Права на отправку писем только в почтовых клиентах и только в режиме «Отправить от имени» (Send on behalf — с указанием сотрудника, который отправляет письмо от имени владельца ящика). Роль не дает возможность отправлять письма в веб-интерфейсе Яндекс Почты  и почтовых клиентах Яндекс Почты на iOS и Android.

Роль shared_mailbox_owner включает в себя права всех остальных ролей. При выборе этой роли указывать остальные не требуется.

Responses

200 OK

Запрос успешно выполнен.

Body

application/json
{
    "taskId": "string"
}

Name

Description

taskId*

Type: string

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

400 Bad Request

Некорректный запрос.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "@type": "string"
        }
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: protobufAny[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

protobufAny

Name

Description

@type

Type: string

...rest

Type: any

401 Unauthorized

Пользователь не авторизован.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "@type": "string"
        }
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: protobufAny[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

403 Forbidden

У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "@type": "string"
        }
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: protobufAny[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "@type": "string"
        }
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: protobufAny[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

500 Internal Server Error

Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.

Body

application/json
{
    "code": 0,
    "message": "string",
    "details": [
        {
            "@type": "string"
        }
    ]
}

Name

Description

code

Type: integer<int32>

Код ошибки.

details

Type: protobufAny[]

Дополнительные сведения об ошибке.

message

Type: string

Описание ошибки.

No longer supported, please use an alternative and newer version.

Предыдущая
Посмотреть список ящиков, доступных сотруднику
Следующая
Посмотреть список общих ящиков