Modifier le fournisseur

Mettez à jour un fournisseur de courriel. L’objet credentials requiert différentes propriétés selon le fournisseur de courriel (spécifié à l’aide de la propriété name) :

• mandrill requiert api_key
• sendgrid requiert api_key
• sparkpost requiert api_key. Vous pouvez aussi définir region sur eu pour utiliser le service SparkPost hébergé en Europe de l’Ouest; définissez-la sur null pour utiliser le service SparkPost hébergé en Amérique du Nord. eu ou null sont les seules valeurs valides pour region.
• mailgun requiert api_key et domain. Vous pouvez aussi définir region sur eu pour utiliser le service Mailgun hébergé en Europe; sinon, définissez-la sur null. eu ou null sont les seules valeurs valides pour region.
• ses requiert accessKeyId, secretAccessKey et region
• smtp requiert smtp_host, smtp_port, smtp_user et smtp_pass

Selon le type de fournisseur, il est possible de spécifier l’objet settings avec différentes options de configuration qui seront utilisées lors de l’envoi d’un courriel :

• Pour le fournisseur smtp, settings peut contenir l’objet headers.

  • Si vous utilisez l’hôte SMTP AWS SES, vous pouvez fournir un nom d’ensemble de configuration dans l’en-tête X-SES-Configuration-Set. La valeur doit être une chaîne.
  • Si vous utilisez l’hôte SparkPost, vous pouvez fournir une valeur pour l’en-tête X-MSYS_API. La valeur doit être un objet.

  Pour le fournisseur ses, settings peut contenir l’objet message, dans lequel vous pouvez fournir un nom d’ensemble de configuration dans la propriété configuration_set_name. La valeur doit être une chaîne.

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,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.emails.provider.update({});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.emails.provider.update({});
}
main();

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

import requests

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

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

response = requests.patch(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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'credentials' => [
        'api_key' => '<string>'
    ],
    'default_from_address' => '<string>',
    'enabled' => true,
    '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.patch("https://{tenantDomain}/api/v2/emails/provider")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"credentials\": {\n    \"api_key\": \"<string>\"\n  },\n  \"default_from_address\": \"<string>\",\n  \"enabled\": true,\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::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"credentials\": {\n    \"api_key\": \"<string>\"\n  },\n  \"default_from_address\": \"<string>\",\n  \"enabled\": true,\n  \"settings\": {}\n}"

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

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": {}
}

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

credentials · object

Identifiants requis pour utiliser le fournisseur.

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Show child attributes

default_from_address · string

Adresse de courriel à utiliser comme "from" lorsqu’aucune autre adresse n’est précisée.

enabled · boolean

Indique si le fournisseur est activé (true) ou désactivé (false).

name · enum<string>

Nom du fournisseur de courriel. Peut être mailgun, mandrill, sendgrid, resend, ses, sparkpost, smtp, azure_cs, ms365 ou custom.

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

settings · object | null

Paramètre propre au fournisseur

Réponse

200

application/json

Fournisseur de courriel mis à jour avec succès.

credentials · object

Identifiants requis pour utiliser le fournisseur.

Show child attributes

default_from_address · string

Adresse de courriel à utiliser comme "from" lorsqu’aucune autre adresse n’est précisée.

enabled · boolean · défaut: true

Indique si le fournisseur est activé (true) ou désactivé (false).

name · string · défaut: sendgrid

Nom du fournisseur de courriel. Peut être mailgun, mandrill, sendgrid, resend, ses, sparkpost, smtp, azure_cs, ms365 ou custom.

settings · object

Paramètre propre au fournisseur