DKIMドメイン・セレクタ登録

機能説明

作成者署名用の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	生成する鍵のビット長指定しない場合は、2048bitになります。
pending	boolean	0:1	-	検証前（利用不可）扱いで作成するフラグデフォルトは false（すぐに利用可能になる）です。

リクエストボディサンプル

{
  "domain": "example.com",
  "selector": "selectorhere",
  "bit_size": 2048,
  "pending": true
}

レスポンス

ステータスコード

状態	コード
成功	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	登録したビット長

成功

{"code":201, "domain":"example.com","selector":"selectorhere","public_key":"XXXXXXXXXXXXXXXX","type":"AUTHENTICATION","status":"VALIDATING","default":true,"bit_size":2048}

失敗

{"code":400,"error":"validation error", "validation_errors":{"domain":"required"}}