Посмотреть информацию об общем ящике
Предоставляет информацию об общем ящике.
В запросе к API направляется поле resourceId — идентификатор общего почтового ящика, информацию о котором надо просмотреть.
Примечание
Чтобы выполнить запрос, приложению требуется разрешение на чтение информации о правах доступа к почтовым ящикам. Убедитесь, что вы включили его при настройке приложения на OAuth-сервере Яндекса.
Request
GET
https://api360.yandex.net/admin/v1/org/{orgId}/mailboxes/shared/{resourceId}
Path parameters
|
Name |
Description |
|
orgId* |
Type: integer<int64> Идентификатор организации. |
|
resourceId* |
Type: string<uint64> Идентификатор почтового ящика. |
Responses
200 OK
Запрос успешно выполнен.
Body
application/json
{
"id": "string",
"email": "string",
"name": "string",
"description": "string",
"createdAt": "2022-12-29T18:02:01Z",
"updatedAt": "2022-12-29T18:02:01Z"
}
|
Name |
Description |
|
description* |
Type: string Описание. |
|
email* |
Type: string Адрес электронной почты общего ящика. |
|
id* |
Type: string<uint64> Идентификатор (resourceId) общего ящика. |
|
name* |
Type: string Имя общего ящика. |
|
createdAt |
Type: string<date-time> Дата и время создания общего ящика. |
|
updatedAt |
Type: string<date-time> Дата и время изменения общего ящика. |
401 Unauthorized
Пользователь не авторизован.
Body
application/json
{
"code": 0,
"message": "string",
"details": [
null
]
}
|
Name |
Description |
|
code |
Type: integer<int32> Код ошибки. |
|
details |
Type: any[] Дополнительные сведения об ошибке. |
|
message |
Type: string Описание ошибки. |
403 Forbidden
У пользователя или приложения нет прав на доступ к ресурсу, запрос отклонен.
Body
application/json
{
"code": 0,
"message": "string",
"details": [
null
]
}
|
Name |
Description |
|
code |
Type: integer<int32> Код ошибки. |
|
details |
Type: any[] Дополнительные сведения об ошибке. |
|
message |
Type: string Описание ошибки. |
404 Not Found
Запрашиваемый ресурс не найден.
Body
application/json
{
"code": 0,
"message": "string",
"details": [
null
]
}
|
Name |
Description |
|
code |
Type: integer<int32> Код ошибки. |
|
details |
Type: any[] Дополнительные сведения об ошибке. |
|
message |
Type: string Описание ошибки. |
500 Internal Server Error
Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
Body
application/json
{
"code": 0,
"message": "string",
"details": [
null
]
}
|
Name |
Description |
|
code |
Type: integer<int32> Код ошибки. |
|
details |
Type: any[] Дополнительные сведения об ошибке. |
|
message |
Type: string Описание ошибки. |
No longer supported, please use an alternative and newer version.