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

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

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

Примечание

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

Request

GET

https://api360.yandex.net/admin/v1/org/{orgId}/mailboxes/resources/{actorId}

Path parameters

Name

Description

actorId

Type: string<uint64>

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

Example: ``

orgId

Type: integer

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

Responses

200 OK

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

Body

application/json
{
  "resources": [
    {
      "resourceId": "example",
      "type": "example",
      "roles": [
        "example"
      ]
    }
  ]
}

Name

Description

resources

Type: v1ResourcesResponseResource[]

Список почтовых ящиков, к которым сотруднику открыт доступ.

Example
[
  {
    "resourceId": "example",
    "type": "example",
    "roles": [
      "example"
    ]
  }
]

v1ResourcesResponseResource

Name

Description

resourceId

Type: string<uint64>

Идентификатор почтового ящика.

Example: example

roles

Type: string[]

Список ролей сотрудника.

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

  • роль, которая регулирует доступ сотрудника к другому ящику в почтовых программах (по 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 включает в себя права всех остальных ролей.

Example
[
  "example"
]

type

Type: string

Тип ящика. Возможные значения:

  • shared — общий;
  • delegated — делегированный.

Example: example
Example
{
  "resourceId": "example",
  "type": "example",
  "roles": [
    "example"
  ]
}

400 Bad Request

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

Body

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

Name

Description

code

Type: integer

Код ошибки.

details

Type: protobufAny[]

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

Example
[
  {
    "@type": "example"
  }
]

message

Type: string

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

Example: example

protobufAny

Name

Description

@type

Type: string

Example: example

[additional]

Type: unknown

Example: null
Example
{
  "@type": "example"
}

401 Unauthorized

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

Body

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

Name

Description

code

Type: integer

Код ошибки.

details

Type: protobufAny[]

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

Example
[
  {
    "@type": "example"
  }
]

message

Type: string

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

Example: example

403 Forbidden

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

Body

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

Name

Description

code

Type: integer

Код ошибки.

details

Type: protobufAny[]

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

Example
[
  {
    "@type": "example"
  }
]

message

Type: string

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

Example: example

404 Not Found

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

Body

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

Name

Description

code

Type: integer

Код ошибки.

details

Type: protobufAny[]

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

Example
[
  {
    "@type": "example"
  }
]

message

Type: string

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

Example: example

500 Internal Server Error

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

Body

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

Name

Description

code

Type: integer

Код ошибки.

details

Type: protobufAny[]

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

Example
[
  {
    "@type": "example"
  }
]

message

Type: string

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

Example: example

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

Предыдущая
Выключить для ящика возможность делегирования
Следующая
Изменить права доступа к ящику