Domain Authentication
List all authenticated domains [GET]
Domain Authenticationの設定一覧取得URI引数 | 必須 | 条件 | 説明 |
---|---|---|---|
limit | No | integer | 一度に取得するドメイン数。 Example: 50 |
offset | No | integer | オフセット。 Example: 0 |
exclude_subusers | No | boolean | 結果からサブユーザのドメインを除外します。 Example: true |
username | No | string | 指定したユーザに割り当てられているDomain Authenticationを検索します。 ※構造計画研究所のマイページID(旧ユーザ名)ではなくSendGridアカウントのUsernameを指定してください。 Example: john |
domain | No | string | 指定したドメインにマッチするDomain Authenticationを検索します。 Example: example.com |
Request
1
|
|
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
|
Authenticate a domain [POST]
Domain Authenticationの作成
サブユーザのDomain Authenticationを作成する方法は以下の2通りあります。
1.親アカウントがusernameパラメータを指定してサブユーザの代わりにドメインを認証します。サブユーザは設定の確認や編集ができます。
2.親アカウントのDomain Authenticationをサブユーザに割り当てます。割り当てられたドメインがデフォルトとして利用されますが、サブユーザはそのドメインの確認や編集はできません。サブユーザ自身がドメイン認証設定を行うと、そちらの設定が優先されます。
設定の優先順位についてはこちらをご確認ください。
Domain Authenticationは最大3000まで作成可能です。
Body引数 | 必須 | 条件 | 説明 |
---|---|---|---|
domain | Yes | string | 対象のドメイン名. Example: example.com |
subdomain | No | string | Return-Pathに付加するサブドメイン名. Example: news |
username | No | string | Domain Authenticationを割り当てるサブユーザ名. Example: subuser |
ips | No | string[array] | カスタムSPF(ユーザがSPFレコードを管理)のレコードに含まれるIPアドレス. Example: 192.168.1.1 |
custom_spf | No | boolean | カスタムSPFもしくはSendGridがSPF設定を管理するかを指定します。 この設定は手動セキュリティの場合のみ有効です. Example: true |
default | No | boolean | 送信者のドメイン名がDomain Authenticationのドメインと一致しない場合にデフォルトの設定として使用するか否かを指定します. Example: false |
automatic_security | No | boolean | 自動セキュリティ設定。SendGridにSPFレコード、DKIMキー、DKIMキーローテーションの管理を許可するか否かを指定します. Example: false |
custom_dkim_selector | No | string | カスタムDKIMセレクタを指定します。 3桁の文字列または数字が利用できます. Example: 001 |
Request
1
|
|
1 2 3 4 5 6 7 8 9 10 11 12 |
|
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 |
|
Retrieve an authenticated domain [GET]
Domain Authenticationの取得URI引数 | 必須 | 条件 | 説明 |
---|---|---|---|
domain_id | Yes | string | Domain AuthenticationのID Example: 1234 |
Request
1
|
|
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 |
|
Update an authenticated domain [PATCH]
Domain Authenticationの更新URI引数 | 必須 | 条件 | 説明 |
---|---|---|---|
domain_id | Yes | string | Domain AuthenticationのID Example: 1234 |
Body引数 | 必須 | 条件 | 説明 |
---|---|---|---|
default | No | boolean | デフォルトで使用するDomain Authenticationを意味します。 デフォルト値 false. Example: false |
custom_spf | No | boolean | 手動セキュリティ用のカスタムSPFレコードを生成するか否かを示します。 デフォルト値 false. Example: false |
Request
1
|
|
1 2 3 4 |
|
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
|
Delete an authenticated domain [DELETE]
Domain Authenticationの削除URI引数 | 必須 | 条件 | 説明 |
---|---|---|---|
domain_id | Yes | string | Domain AuthenticationのID Example: 1234 |
Request
1
|
|
Response
1
|
|
Get the default authentication [GET]
デフォルトDomain Authenticationの取得URI引数 | 必須 | 条件 | 説明 |
---|---|---|---|
domain | No | string | Domain Authenticationのドメインに対応する送信ドメイン. Example: em.example.com |
Request
1
|
|
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
|
Add an IP to an authenticated domain [POST]
Domain AuthenticationへのIPアドレスの追加URI引数 | 必須 | 条件 | 説明 |
---|---|---|---|
id | Yes | integer | IPアドレスを追加するDomain AuthenticationのID. Example: 1234 |
Body引数 | 必須 | 条件 | 説明 |
---|---|---|---|
ip | Yes | string | Domain Authenticationに関連付けるIPアドレス. カスタムSPFでIPアドレスを直接指定する場合に使用されます. Example: 192.168.0.1 |
Request
1
|
|
1 2 3 |
|
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
|
Remove an IP from an authenticated domain [DELETE]
Domain AuthenticationからのIPアドレスの削除URI引数 | 必須 | 条件 | 説明 |
---|---|---|---|
id | Yes | integer | IPアドレスを削除するDomain AuthenticationのID. Example: 1234 |
ip | Yes | string | Domain Authenticationから削除するIPアドレス. Example: 127.0.0.1 |
Request
1
|
|
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
|
Validate a domain authentication [POST]
Domain Authenticationの検証
設定したドメインの検証を行うことができます。検証に失敗した場合は、その理由がエラーメッセージとして返されます。
URI引数 | 必須 | 条件 | 説明 |
---|---|---|---|
id | Yes | integer | 検証したいDomain AuthenticationのID. Example: 1234 |
Request
1
|
|
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
|
List the authenticated domains associated with a subuser [GET]
関連するDomain Authenticationの一覧取得URI引数 | 必須 | 条件 | 説明 |
---|---|---|---|
username | Yes | string | Domain Authenticationに割り当てられているサブユーザのユーザ名. |
Request
1
|
|
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
|
Disassociate an authenticated domain from a subuser [DELETE]
Domain Authenticationの割り当て解除URI引数 | 必須 | 条件 | 説明 |
---|---|---|---|
username | Yes | string | Domain Authenticationに割り当てられているサブユーザのユーザ名. |
Request
1
|
|
Response
1
|
|
Associate an authenticated domain with a subuser [POST]
Domain Authenticationの割り当てURI引数 | 必須 | 条件 | 説明 |
---|---|---|---|
domain_id | Yes | integer | サブユーザに割り当てるDomain AuthenticationのID. Example: 1234 |
Body引数 | 必須 | 条件 | 説明 |
---|---|---|---|
username | Yes | string | Domain Authenticationと関連付けるサブユーザのユーザ名. Example: janeexampexample@example.com |
Request
1
|
|
1 2 3 |
|
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
|