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

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

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

Примечание

Чтобы выполнить запрос, приложению требуется разрешение на управление правами доступа к почтовым ящикам. Убедитесь, что вы включили его при настройке приложения на 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_owner
полные права на ящик, к которому предоставляется доступ;
shared_mailbox_imap_admin
управление ящиком в IMAP-клиенте;
shared_mailbox_sender
отправка писем по SMTP;
shared_mailbox_half_sender
ограниченная отправка писем по SMTP.

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

Responses

200 OK

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

Body

application/json

{
    "taskId": "string"
}

Name

Description

taskId*

Type: string

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

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 Описание ошибки.

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

Request

Path parameters

Query parameters

Body

Responses

200 OK

Body

401 Unauthorized

Body

403 Forbidden

Body

404 Not Found

Body

500 Internal Server Error

Body

Была ли статья полезна?