Метод CreateDomainIdentity
Создает адрес в каталоге. Нужный каталог определяется по сервисному аккаунту, от имени которого выполняется запрос.
Запрос
POST /v2/email/identities HTTP/2
Заголовки запроса
Используйте в запросе общие заголовки.
Тело запроса
{
"EmailIdentity": "<адрес>",
"Tags": [
{
"Key": "<ключ_метки>",
"Value": "<значение_метки>"
}
],
"DkimSigningAttributes": {
"DomainSigningSelector": "<название_селектора>",
"DomainSigningPrivateKey": "<закрытый_ключ>"
},
"ConfigurationSetName": "<название_конфигурации>"
}
|
Параметр |
Описание |
|
|
Тип: string. Адрес. |
|
|
Тип: array. Массив меток для адреса. Максимальное количество — 50 меток. |
|
|
Тип: string. Ключ метки. Минимальная длина ключевого слова — 1 символ, максимальная — 63 символа. |
|
|
Тип: string. Значение метки. Минимальная длина значения метки — 0 символов (значение отсутствует), максимальная — 256 символов. |
|
|
Тип: object. Объект, который содержит параметры для создания DKIM-подписи. |
|
|
Тип: string. Название селектора, который используется для идентификации открытого ключа в конфигурации DNS для домена. Минимальная длина названия селектора —— 1 символ, максимальная — 63 символа. |
|
|
Тип: string. Закрытый ключ, который используется для генерации DKIM-подписи. Закрытый ключ должен использовать 1024- или 2048-битное шифрование RSA и должен быть закодирован с использованием кодировки base64. Минимальная длина ключа —— 1 символ, максимальная — 20480 символов. |
|
|
Тип: string. Название конфигурации, которую вы хотите привязать к адресу. Конфигурация должна находиться в том же каталоге, что и адрес. |
Ответы
200 OK
{
"IdentityType": "<тип_адреса>",
"VerifiedForSendingStatus": <статус_верификации_для_отправки_писем>,
"DkimAttributes": {
"SigningEnabled": <использование_DKIM>,
"Status": "<статус_поиска_DKIM>",
"Tokens": [
"<селектор_для_открытого_ключа>"
],
"SigningAttributesOrigin": "<способ_конфигурации_DKIM>",
"NextSigningKeyLength": "<длина_следующего_ключа>",
"CurrentSigningKeyLength": "<длина_текущего_ключа>"
}
}
|
Параметр |
Описание |
|
|
Тип: string. Тип адреса. Возможное значение — |
|
|
Тип: boolean. Указывает, подтверждено ли владение адресом. Возможные значения: Вы можете отправлять электронные письма только с проверенных адресов. |
|
|
Тип: object. Объект, который содержит параметры DKIM-подписи. |
|
|
Тип: boolean. Указывает, используется ли DKIM-подпись при отправке электронной почты с этого адреса. Возможные значения: |
|
|
Тип: string. Указывает, удалось ли Yandex Cloud Postbox обнаружить DKIM-подпись в DNS-конфигурации адреса. Возможные значения:
|
|
|
Тип: array. Список селекторов для идентификации открытого ключа. Тип для селектора: string. |
|
|
Тип: string. Указывает, как была настроена DKIM-подпись. Значение |
|
|
Тип: string. Используется только для совместимости с AWS. |
|
|
Тип: string. Используется только для совместимости с AWS. |
Ответ 200 OK может содержать дополнительные параметры. Он не возвращается строго в формате, указанном выше.
Ошибки
Для всех ошибок тело ответа представлено в одинаковом формате:
{
"Code": "<название_ошибки>",
"message": "<пояснение_к_ошибке>"
}
Название ошибки заимствуется из ее кода, например BadRequestException.
Возможные ошибки:
|
Код ошибки |
Описание |
|
|
В запросе переданы неправильные заголовки или параметры. |
|
|
Не найден запрашиваемый ресурс. |
|
|
Конфигурация с таким названием уже существует, выберите другие имя. |
|
|
Конфликт операций. Дождитесь завершения предыдущей операции и повторите запрос. |
|
|
При вызове запроса превышена квота. |
|
|
При вызове запроса превышен лимит. |