POST Proveedor de correo electrónico

Cree un proveedor de correo electrónico. El objeto credentials requiere propiedades diferentes según el proveedor de correo electrónico (que se especifica mediante la propiedad name):

• mandrill requiere api_key
• sendgrid requiere api_key
• sparkpost requiere api_key. Opcionalmente, establezca region en eu para usar el servicio de SparkPost alojado en Europa occidental; establézcalo en null para usar el servicio de SparkPost alojado en Norteamérica. eu o null son los únicos valores válidos para region.
• mailgun requiere api_key y domain. Opcionalmente, establezca region en eu para usar el servicio de Mailgun alojado en Europa; establézcalo en null en caso contrario. eu o null son los únicos valores válidos para region.
• ses requiere accessKeyId, secretAccessKey y region
• smtp requiere smtp_host, smtp_port, smtp_user y smtp_pass

Según el tipo de proveedor, es posible especificar un objeto settings con distintas opciones de configuración que se usarán al enviar un correo electrónico:

• En el proveedor smtp, settings puede contener el objeto headers.
  • Al usar el host SMTP de AWS SES, puede proporcionar el nombre de un conjunto de configuración en el encabezado X-SES-Configuration-Set. El valor debe ser una cadena.
  • Al usar el host de SparkPost, puede proporcionar un valor para el encabezado X-MSYS_API. El valor debe ser un objeto.
• Para el proveedor ses, settings puede contener el objeto message, donde puede proporcionar el nombre de un conjunto de configuración en la propiedad configuration_set_name. El valor debe ser una cadena.

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

201

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

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

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

Cuerpo

application/jsonapplication/x-www-form-urlencoded

credentials · object · requerido

Credenciales necesarias para usar el proveedor.

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Show child attributes

name · enum<string> · requerido

Nombre del proveedor de correo electrónico. Puede ser mailgun, mandrill, sendgrid, resend, ses, sparkpost, smtp, azure_cs, ms365 o custom.

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

default_from_address · string

Dirección de correo electrónico que se usará como "from" cuando no se especifique otra dirección.

enabled · boolean · predeterminado: true

Indica si el proveedor está habilitado (true) o deshabilitado (false).

settings · object

Configuración específica del proveedor

Respuesta

201

application/json

El proveedor de correo electrónico se creó correctamente.

credentials · object

Credenciales necesarias para usar el proveedor.

Show child attributes

default_from_address · string

Dirección de correo electrónico que se usará como "from" cuando no se especifique otra dirección.

enabled · boolean · predeterminado: true

Indica si el proveedor está habilitado (true) o deshabilitado (false).

name · string · predeterminado: sendgrid

Nombre del proveedor de correo electrónico. Puede ser mailgun, mandrill, sendgrid, resend, ses, sparkpost, smtp, azure_cs, ms365 o custom.

settings · object

Configuración específica del proveedor