Obtenir le fournisseur de courriel

Récupérez les détails de la configuration du fournisseur de courriel dans votre locataire. Vous pouvez également spécifier une liste de champs à inclure ou à exclure.

GET 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.GetEmailProviderRequestParameters{
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    client.Emails.Provider.Get(
        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": {}
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de requête

fields · string

Liste de champs séparés par des virgules à inclure ou à exclure (selon include_fields) dans le résultat. Laissez ce champ vide pour récupérer name et enabled. Les champs supplémentaires disponibles incluent credentials, default_from_address et settings.

include_fields · boolean

Indique si les champs spécifiés doivent être inclus (true) ou exclus (false).

Réponse

200

application/json

Fournisseur de courriel récupéré 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 indiqué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