Introduction Guide de l'utilisateur Guide administrateur fonctionnel Guide administrateur technique Installation Prérequis pour Maarch Parapheur Breaking Change Exploitation Architecture technique Description du modèle de configuration Description du modèle de données Description des webservices Configurations Documents Utilisateurs Historique Modèles de circuit privés

Configurations

Modification de la configuration du serveur email

Route

PATCH /rest/configurations/{id}

Paramètres

  • id : Correspond à l'identifiant technique de la configuration du serveur mail (configurations.id)
Body
Valeur Type Obligatoire Description
type string Oui Type de configuration
host string Oui Host
port integer Oui Port
auth boolean Oui Authentification
user string Non Identifiant utilisateur
password string Non Mot de passe utilisateur
secure string Oui Méthode de sécurité
from string Oui Email d'envoi
Exemple
{
    "label" : "mail",
    "value" : {
        "type"      : "smtp",
        "host"      : "smtp.gmail.com",
        "port"      : 465,
        "auth"      : true,
        "user"      : "paul.walker@ff.com",
        "password"  : "Bryan",
        "secure"    : "ssl",
        "from"      : "notifications@ff.org"
    }
}

Retour

Code Http Type Description Exemple
204 null La configuration a bien été enregistré
400 array Un paramètre obligatoire est manquant ['errors' => '...']
403 array L'utilisateur n'a pas le privilège 'manage_configuration' ['errors' => 'Privilege forbidden']
500 array Une erreur s'est produite ['errors' => '...']

results matching ""

    No results matching ""