作成者署名用のDKIMドメインを登録し、自動的にRSA暗号鍵の1024bit,2048bit,3072bitのいずれかの鍵長のキーペアを生成、ドメインとセレクタとともにシステムに保存する。
新たに登録されたドメインの場合、優先的に署名するセレクタが自動的に指定される。
既に登録済みのドメインの場合は新たにセレクタを登録するが、該当ドメインあたりの登録済みセレクタ数の上限に達している場合は登録できない。
また、DKIMドメインとインバウンド受信ドメインの登録数を合計した数が上限に達している場合は新たなドメインを登録できない。
サーバの混雑状況等の理由により、メール配信において最新の情報が反映されるまでにタイムラグが発生する場合がある。
リクエスト
エンドポイント
/v1/domains/authentications
HTTPメソッド
POST もしくは PUT
リクエストボディ
JSON形式であること
|
要素名
|
型
|
要素数
|
制限
|
説明
|
|---|---|---|---|---|
| domain | 文字列 | 1 |
半角英数字 . - 最大253文字 |
ドメイン |
| selector | 文字列 | 1 | 半角英数字 -(ハイフン) .(ピリオド) _(アンダーバー) 最大63文字まで | セレクタ |
| bit_size | 数値 | 0:1 | 1024, 2048, 3072のいずれか |
生成する鍵のビット長 |
| pending | boolean | 0:1 |
|
検証前（利用不可）扱いで作成するフラグ デフォルトは false（すぐに利用可能になる） |
リクエストボディサンプル
レスポンス
ステータスコード
|
状態
|
コード
|
|---|---|
| 成功 | 200 |
| リクエストボディがjsonではない | 400 |
| jsonリクエストのバリデーションエラー | 400 |
| 認証失敗 | 401 |
| 存在しないエンドポイント | 404 |
| 既に登録されている等の理由で登録に失敗した | 403 |
| 許可されていないHTTPメソッド | 405 |
| システムエラーが発生した | 500 |
| システムが一時的にサービスを提供できない状態になっている | 503 |
| システムのタイムアウト | 504 |
レスポンスボディ
|
要素名
|
型
|
要素数
|
説明
|
|---|---|---|---|
| code | 数値 | 1 | ステータスコード |
| domain | 文字列 | 1 | 登録したドメイン |
| selector | 文字列 | 1 | 登録したセレクタ |
| public_key | 文字列 | 1 | 生成した公開鍵 |
| type | 文字列 | 1 | AUTHENTICATION 固定 |
| status | 文字列 | 1 | VALIDATED 検証済 VALIDATING 未検証 |
| default | 真偽値 | 1 | 優先的に署名に使用するセレクタかどうか |
| bit_size | 数値 | 1 | 登録したビット長 |