Configure email provider

Create an email provider. The credentials object requires different properties depending on the email provider (which is specified using the name property):

• mandrill requires api_key
• sendgrid requires api_key
• sparkpost requires api_key. Optionally, set region to eu to use the SparkPost service hosted in Western Europe; set to null to use the SparkPost service hosted in North America. eu or null are the only valid values for region.
• mailgun requires api_key and domain. Optionally, set region to eu to use the Mailgun service hosted in Europe; set to null otherwise. eu or null are the only valid values for region.
• ses requires accessKeyId, secretAccessKey, and region
• smtp requires smtp_host, smtp_port, smtp_user, and smtp_pass

Depending on the type of provider it is possible to specify settings object with different configuration options, which will be used when sending an email:

• smtp provider, settings may contain headers object.
  • When using AWS SES SMTP host, you may provide a name of configuration set in X-SES-Configuration-Set header. Value must be a string.
  • When using Sparkpost host, you may provide value for X-MSYS_API header. Value must be an object.
• For ses provider, settings may contain message object, where you can provide a name of configuration set in configuration_set_name property. Value must be a string.

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

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    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.CreateEmailProviderRequestContent{
        Name: management.EmailProviderNameEnumMailgun,
        Credentials: &management.EmailProviderCredentialsSchema{
            EmailProviderCredentialsSchemaZero: &management.EmailProviderCredentialsSchemaZero{
                ApiKey: "api_key",
            },
        },
    }
    client.Emails.Provider.Create(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.emails.provider.create({
        name: "mailgun",
        credentials: {
            apiKey: "api_key",
        },
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.emails.provider.create({
        name: "mailgun",
        credentials: {
            apiKey: "api_key",
        },
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/emails/provider \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "credentials": {
    "api_key": "<string>"
  },
  "enabled": true,
  "default_from_address": "<string>",
  "settings": {}
}
'

import requests

url = "https://{tenantDomain}/api/v2/emails/provider"

payload = {
    "credentials": { "api_key": "<string>" },
    "enabled": True,
    "default_from_address": "<string>",
    "settings": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/emails/provider",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'credentials' => [
        'api_key' => '<string>'
    ],
    'enabled' => true,
    'default_from_address' => '<string>',
    'settings' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}/api/v2/emails/provider")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"credentials\": {\n    \"api_key\": \"<string>\"\n  },\n  \"enabled\": true,\n  \"default_from_address\": \"<string>\",\n  \"settings\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/emails/provider")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"credentials\": {\n    \"api_key\": \"<string>\"\n  },\n  \"enabled\": true,\n  \"default_from_address\": \"<string>\",\n  \"settings\": {}\n}"

response = http.request(request)
puts response.read_body

201

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

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Corps

application/jsonapplication/x-www-form-urlencoded

name · enum<string> · requis

Name of the email provider. Can be mailgun, mandrill, sendgrid, resend, ses, sparkpost, smtp, azure_cs, ms365, or custom.

Options disponibles: mailgun, mandrill, sendgrid, resend, ses, sparkpost, smtp, azure_cs, ms365, custom

credentials · object · requis

Credentials required to use the provider.

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Show child attributes

enabled · boolean · défaut: true

Whether the provider is enabled (true) or disabled (false).

default_from_address · string

Email address to use as "from" when no other address specified.

settings · object | null

Specific provider setting

Réponse

201

application/json

Email provider successfully created.

name · string · défaut: sendgrid

Name of the email provider. Can be mailgun, mandrill, sendgrid, resend, ses, sparkpost, smtp, azure_cs, ms365, or custom.

enabled · boolean · défaut: true

Whether the provider is enabled (true) or disabled (false).

default_from_address · string

Email address to use as "from" when no other address specified.

credentials · object

Credentials required to use the provider.

Show child attributes

settings · object

Specific provider setting