using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Emails;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Emails.Provider.CreateAsync(
            new CreateEmailProviderRequestContent {
                Name = EmailProviderNameEnum.Mailgun,
                Credentials = new EmailProviderCredentialsSchemaZero {
                    ApiKey = "api_key"
                }
            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.CreateEmailProviderRequestContent{
        Name: management.EmailProviderNameEnumMailgun,
        Credentials: &management.EmailProviderCredentialsSchema{
            EmailProviderCredentialsSchemaZero: &management.EmailProviderCredentialsSchemaZero{
                ApiKey: "api_key",
            },
        },
    }
    mgmt.Emails.Provider.Create(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.emails.types.CreateEmailProviderRequestContent;
import com.auth0.client.mgmt.types.EmailProviderCredentialsSchema;
import com.auth0.client.mgmt.types.EmailProviderCredentialsSchemaZero;
import com.auth0.client.mgmt.types.EmailProviderNameEnum;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.emails().provider().create(
            CreateEmailProviderRequestContent
                .builder()
                .name(EmailProviderNameEnum.MAILGUN)
                .credentials(
                    EmailProviderCredentialsSchema.of(
                        EmailProviderCredentialsSchemaZero
                            .builder()
                            .apiKey("api_key")
                            .build()
                    )
                )
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Emails\Provider\Requests\CreateEmailProviderRequestContent;
use Auth0\SDK\API\Management\Types\EmailProviderNameEnum;
use Auth0\SDK\API\Management\Types\EmailProviderCredentialsSchemaZero;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->emails->provider->create(
    new CreateEmailProviderRequestContent([
        'name' => EmailProviderNameEnum::Mailgun->value,
        'credentials' => new EmailProviderCredentialsSchemaZero([
            'apiKey' => 'api_key',
        ]),
    ]),
);

from auth0.management import ManagementClient, EmailProviderCredentialsSchemaZero

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.emails.provider.create(
    name="mailgun",
    credentials=EmailProviderCredentialsSchemaZero(
        api_key="api_key",
    ),
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.emails.provider.create(
  name: "mailgun",
  credentials: {
    api_key: "api_key"
  }
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        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({
        domain: "{YOUR_DOMAIN}",
        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>"
  },
  "default_from_address": "<string>",
  "enabled": true,
  "settings": {}
}
'

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

Post Provider

Créez un fournisseur de courriel. L’objet credentials requiert différentes propriétés selon le fournisseur de courriel (indiqué par la propriété name) :

mandrill requiert api_key
sendgrid requiert api_key
sparkpost requiert api_key. Vous pouvez aussi définir region à eu pour utiliser le service SparkPost hébergé en Europe occidentale; définissez-le à null pour utiliser le service SparkPost hébergé en Amérique du Nord. eu et null sont les seules valeurs valides pour region.
mailgun requiert api_key et domain. Vous pouvez aussi définir region à eu pour utiliser le service Mailgun hébergé en Europe; sinon, définissez-le à null. eu et 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 préciser un 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 un objet headers.
- Si vous utilisez l’hôte SMTP d’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 de caractères.
- 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 un 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 de caractères.

POST

https://{tenantDomain}/api/v2

emails

provider

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Emails;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Emails.Provider.CreateAsync(
            new CreateEmailProviderRequestContent {
                Name = EmailProviderNameEnum.Mailgun,
                Credentials = new EmailProviderCredentialsSchemaZero {
                    ApiKey = "api_key"
                }
            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.CreateEmailProviderRequestContent{
        Name: management.EmailProviderNameEnumMailgun,
        Credentials: &management.EmailProviderCredentialsSchema{
            EmailProviderCredentialsSchemaZero: &management.EmailProviderCredentialsSchemaZero{
                ApiKey: "api_key",
            },
        },
    }
    mgmt.Emails.Provider.Create(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.emails.types.CreateEmailProviderRequestContent;
import com.auth0.client.mgmt.types.EmailProviderCredentialsSchema;
import com.auth0.client.mgmt.types.EmailProviderCredentialsSchemaZero;
import com.auth0.client.mgmt.types.EmailProviderNameEnum;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.emails().provider().create(
            CreateEmailProviderRequestContent
                .builder()
                .name(EmailProviderNameEnum.MAILGUN)
                .credentials(
                    EmailProviderCredentialsSchema.of(
                        EmailProviderCredentialsSchemaZero
                            .builder()
                            .apiKey("api_key")
                            .build()
                    )
                )
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Emails\Provider\Requests\CreateEmailProviderRequestContent;
use Auth0\SDK\API\Management\Types\EmailProviderNameEnum;
use Auth0\SDK\API\Management\Types\EmailProviderCredentialsSchemaZero;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->emails->provider->create(
    new CreateEmailProviderRequestContent([
        'name' => EmailProviderNameEnum::Mailgun->value,
        'credentials' => new EmailProviderCredentialsSchemaZero([
            'apiKey' => 'api_key',
        ]),
    ]),
);

from auth0.management import ManagementClient, EmailProviderCredentialsSchemaZero

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.emails.provider.create(
    name="mailgun",
    credentials=EmailProviderCredentialsSchemaZero(
        api_key="api_key",
    ),
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.emails.provider.create(
  name: "mailgun",
  credentials: {
    api_key: "api_key"
  }
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        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({
        domain: "{YOUR_DOMAIN}",
        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>"
  },
  "default_from_address": "<string>",
  "enabled": true,
  "settings": {}
}
'

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

Authorization

string

header

requis

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

Corps

credentials

object

requis

Identifiants requis pour utiliser le fournisseur.

Show child attributes

name

enum<string>

requis

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

default_from_address

string

Adresse courriel à utiliser comme « from » si aucune autre adresse n’est précisée.

enabled

boolean

défaut:true

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

settings

object | null

Paramètre propre au fournisseur

Réponse

Le fournisseur de courriel a été créé avec succès.

credentials

object

Identifiants requis pour utiliser le fournisseur.

Show child attributes

default_from_address

string

Adresse courriel à utiliser comme « from » si 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