プロバイダーを更新

メールプロバイダーを更新します。credentials オブジェクトには、メールプロバイダー（name プロパティで指定）に応じて異なるプロパティが必要です。

• mandrill には api_key が必要です
• sendgrid には api_key が必要です
• sparkpost には api_key が必要です。必要に応じて、region を eu に設定すると、西ヨーロッパでホストされている SparkPost サービスを使用できます。北米でホストされている SparkPost サービスを使用するには、null に設定します。region に指定できる有効な値は eu または null のみです。
• mailgun には api_key と domain が必要です。必要に応じて、ヨーロッパでホストされている Mailgun サービスを使用する場合は region を eu に設定し、それ以外の場合は null に設定します。region に指定できる有効な値は eu または null のみです。
• ses には accessKeyId、secretAccessKey、region が必要です
• smtp には smtp_host、smtp_port、smtp_user、smtp_pass が必要です

プロバイダーの種類によっては、メール送信時に使用されるさまざまな設定オプションを含む settings オブジェクトを指定できます。

• smtp プロバイダーでは、settings に headers オブジェクトを含めることができます。

  • AWS SES SMTP ホストを使用する場合は、X-SES-Configuration-Set ヘッダーに設定セット名を指定できます。値は文字列である必要があります。
  • SparkPost ホストを使用する場合は、X-MSYS_API ヘッダーの値を指定できます。値はオブジェクトである必要があります。

  ses プロバイダーでは、settings に message オブジェクトを含めることができ、configuration_set_name プロパティに設定セット名を指定できます。値は文字列である必要があります。

PATCH https://{tenantDomain}/api/v2/emails/provider

Go

Go

package example

import (
    context "context"

    client "github.com/auth0/go-auth0/management/management/client"
    emails "github.com/auth0/go-auth0/management/management/emails"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &emails.UpdateEmailProviderRequestContent{}
    client.Emails.Provider.Update(
        context.TODO(),
        request,
    )
}

200

{
  "credentials": {
    "api_user": "<string>",
    "region": "<string>",
    "smtp_host": "<string>",
    "smtp_port": 123,
    "smtp_user": "<string>"
  },
  "default_from_address": "<string>",
  "enabled": true,
  "name": "sendgrid",
  "settings": {}
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

ボディ

application/jsonapplication/x-www-form-urlencoded

credentials · object

プロバイダーの使用に必要な認証情報。

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Show child attributes

default_from_address · string

他のアドレスが指定されていない場合に "from" として使用するメールアドレス。

enabled · boolean

プロバイダーが有効（true）か無効（false）か。

name · enum<string>

メールプロバイダーの名前。mailgun、mandrill、sendgrid、resend、ses、sparkpost、smtp、azure_cs、ms365、または custom を指定できます。

利用可能なオプション: mailgun, mandrill, sendgrid, resend, ses, sparkpost, smtp, azure_cs, ms365, custom

settings · object

プロバイダー固有の設定

レスポンス

200

application/json

メールプロバイダーが正常に更新されました。

credentials · object

プロバイダーの使用に必要な認証情報。

Show child attributes

default_from_address · string

他のアドレスが指定されていない場合に "from" として使用するメールアドレス。

enabled · boolean · デフォルト: true

プロバイダーが有効（true）か無効（false）か。

name · string · デフォルト: sendgrid

メールプロバイダーの名前。mailgun、mandrill、sendgrid、resend、ses、sparkpost、smtp、azure_cs、ms365、または custom を指定できます。

settings · object

プロバイダー固有の設定