Перейти к документации
API

Вход под одним адресом

Собственный пароль позволяет человеку войти в OpenEmail под одним адресом и читать и отправлять только его почту.

GET/domains/{id}/addresses/{addressId}/login

Выполняет любой из 3 запросов в вашем рабочем пространстве.

GET /domains/{id}/addresses/{addressId}/login

Собственный пароль позволяет человеку войти в OpenEmail под одним адресом и читать и отправлять только его почту.

Прочитать сведения о входе

Требуется members:write, как и для задания пароля. login равен null, если у адреса нет пароля.

curl
curl "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/login" -H "$AUTH"
Ответ
{  "object": "address_login",  "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",  "address": "[email protected]",  "login": {    "userId": "W2xR8tLq5nYc3vKp9mBd7fHs1aJe4gZu",    "name": "Invoices",    "createdAt": "2026-09-20T09:30:00.000Z",    "createdBy": "Ana Lima",    "passwordSetAt": "2026-09-28T14:05:00.000Z",    "passwordSetBy": "Ana Lima",    "lastSignedInAt": "2026-10-01T07:58:12.000Z"  }}

Ключ, ограниченный определёнными адресами или доменами, отклоняется с 422 capability_unsupported, а приложению, действующему от имени участника, доступен только вход адреса, который охватывает этот участник.

Задать пароль

Требуется members:write. PUT /domains/{id}/addresses/{addressId}/login с { password } задаёт адресу пароль или заменяет имеющийся. created говорит, новый ли это вход.

curl
curl -X PUT "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/login" -H "$AUTH" \  -H "Content-Type: application/json" \  -d '{ "password": "'"$INBOX_PASSWORD"'" }'
Ответ
{  "object": "address_login",  "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",  "address": "[email protected]",  "login": {    "userId": "W2xR8tLq5nYc3vKp9mBd7fHs1aJe4gZu",    "name": "Invoices",    "createdAt": "2026-09-20T09:30:00.000Z",    "createdBy": "Ana Lima",    "passwordSetAt": "2026-09-28T14:05:00.000Z",    "passwordSetBy": "Ana Lima",    "lastSignedInAt": "2026-10-01T07:58:12.000Z"  },  "created": false}

Пароль должен содержать не меньше 8 символов, в том числе строчную букву, заглавную букву, цифру и специальный символ, иначе вызов даёт 422 invalid_parameter на password. OpenEmail никому его не отправляет, поэтому передайте его сами.

Замена пароля завершает сеансы всех, кто вошёл со старым паролем, и удаляет добавленные ими адреса пересылки.

Адрес, под которым уже входит аккаунт OpenEmail, отклоняется с 409 account_exists, а выключенный адрес с 409 address_unavailable. Первый пароль в рабочем пространстве, тариф которого не включает участников команды, отклоняется с 403 plan_required.

Ключ или приложение должны иметь каждый скоуп, который может использовать вход для одного адреса, иначе запрос отклоняется с 403 insufficient_authority.

Токену доступа OAuth для этого вызова нужен код подтверждения. Пока приложение не подтвердило код за последние 60 минут, вызов отвечает 403 step_up_required и ничего не меняет. У API-ключа его никогда не спрашивают. Страница «Аутентификация» показывает, как запросить код и подтвердить его.

Удалить вход

Требуется members:write. DELETE /domains/{id}/addresses/{addressId}/login отбирает пароль и завершает сеансы всех, кто им пользовался. Адрес и его почта остаются.

curl
curl -X DELETE "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/login" -H "$AUTH"
Ответ
{  "object": "address_login",  "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",  "address": "[email protected]",  "deleted": true}

Адрес без пароля даёт 404.

Справочник