Configurations¶

Ces routes lisent et modifient une configuration identifiée par le privilège qui la protège. Le contenu de value dépend du privilège demandé.

Warning

Certaines configurations contiennent des secrets ou des informations d’infrastructure. L'api renvoie notamment clientId et clientSecret déchiffrés pour ProConnect. Ne journalisez pas les réponses et utilisez un compte technique strictement limité.

Configurations prises en charge¶

Valeur de `privilege`	Privilège réellement contrôlé	Contenu
`admin_email_server`	`admin_email_server`	Serveur de courrier sortant
`admin_search`	`admin_search`	Présentation et comportement de la recherche
`admin_sso`	`admin_connections`	Connexion SSO et correspondance des attributs
`admin_proconnect`	`admin_connections`	Connexion ProConnect
`admin_document_editors`	`admin_parameters`	Éditeurs de documents
`admin_parameters_watermark`	`admin_parameters_watermark`	Paramètres historiques du filigrane
`admin_shippings`	`admin_shippings`	Service d’envoi de courriers
`admin_organization_email_signatures`	`admin_organization_email_signatures`	Signatures électroniques partagées
`admin_mercure`	`admin_mercure`	Activation de la LAD Mercure
`admin_folders`	`admin_folders`	Affichage des dossiers
`admin_followed_mail`	`admin_followed_mail`	Affichage des courriers suivis
`admin_tones`	`admin_tones`	Gestion des tonalité IA

La configuration Maarch2Maarch utilise une route dédiée présentée dans les références Connecteurs. Les configurations actuelles du filigrane et de l'export SEDA utilisent également leurs propres routes dans cette section Administration.

Lire une configuration¶

Route¶

GET /rest/configurations/{privilege}

Authentification, privilège et périmètre¶

La route est authentifiée. Elle contrôle le privilège indiqué dans le tableau précédent. La configuration porte sur l’instance complète, sans restriction par entité.

Paramètres d’URL¶

Valeur	Type	Obligatoire	Description
`privilege`	string	Oui	Identifiant de la configuration et du privilège protecteur

Retour¶

Code HTTP	Type	Description	Exemple
`200`	object	Configuration trouvée	`{"configuration":{"privilege":"admin_proconnect","value":{"url":"https://<nom-de-domaine>","clientId":"<identifiant>","clientSecret":"<secret>","enabled":true}}}`
`200`	object	Configuration ProConnect encore absente	`{"configuration":{"privilege":"admin_proconnect","value":null}}`
`403`	object	Privilège absent	`{"errors":"Service forbidden"}`
`403`	object	Configuration inconnue, sauf ProConnect	`{"errors":"Service admin_inconnu is unknown"}`

Données¶

Valeur	Type	Description
`configuration.privilege`	string	Identifiant de la configuration
`configuration.value`	object ou null	Valeurs propres à la configuration

Modifier une configuration¶

Route¶

PUT /rest/configurations/{privilege}

Authentification, privilège et périmètre¶

La route applique les mêmes contrôles que la lecture. Seules les onze valeurs de privilege listées plus haut sont acceptées. La modification est globale à l’instance.

Paramètres d’URL¶

Valeur	Type	Obligatoire	Description
`privilege`	string	Oui	Configuration à modifier

Body¶

Le schéma dépend de privilege. Les structures explicitement validées par l'api sont résumées ci-dessous.

Configuration	Valeurs principales confirmées
`admin_email_server`	`type`, `from`, puis paramètres SMTP ou Microsoft OAuth selon `type`
`admin_search`	`listDisplay` et `listEvent`
`admin_sso`	`url`, `ssoLogoutUrl`, `mapping[]` avec `ssoId` et `maarchId`
`admin_proconnect`	`enabled`, `url`, `clientId`, `clientSecret`
`admin_document_editors`	`default` et configurations `onlyoffice`, `collaboraonline`, `office365sharepoint`
`admin_shippings`	`uri`, `authUri`, `enabled`
`admin_organization_email_signatures`	`signatures[]` avec `label` et `content`
`admin_mercure`	`enabledLad`
`admin_folders`, `admin_followed_mail`	`listDisplay.templateColumns` et `listDisplay.subInfos[]`

Exemple ProConnect vérifié¶

{
  "url": "https://<nom-de-domaine>",
  "clientId": "<identifiant>",
  "clientSecret": "<secret>",
  "enabled": true
}

Retour¶

Code HTTP	Type	Description	Exemple
`200`	object	Configuration enregistrée	`{"success":"success"}`
`400`	object	Corps invalide, le message précise la valeur concernée	`{"errors":"Body enabled is not set or not a boolean"}`
`403`	object	Privilège absent	`{"errors":"Service forbidden"}`
`403`	object	Valeur de `privilege` non modifiable	`{"errors":"Unknown privilege"}`

L'api peut également renvoyer un 400 lors de la validation d’une URL, d’un éditeur ou du serveur de courrier, avec le message technique observé pendant le contrôle.

Lire la configuration d'affichage des courriers suivis¶

Information

Cette route fournit au frontend la configuration de la liste des courriers suivis. Elle est documentée sans garantie de compatibilité pour un consommateur externe.

Route¶

GET /rest/followed-list/configuration

Authentification, privilège et périmètre¶

L'authentification REST est obligatoire. Le contrôleur ne vérifie aucun privilège fonctionnel supplémentaire. La route lit la configuration globale admin_followed_mail, sans restriction par entité.

La modification correspondante utilise PUT /rest/configurations/admin_followed_mail. L'implémentation contrôle actuellement le même identifiant technique, qui n'est pas attribuable dans l'interface, le privilège associé à cet écran est admin_folders_followed_mail.

Retour¶

Code HTTP	Type	Description	Exemple
`200`	object	Configuration d'affichage enregistrée	Voir l'exemple ci-dessous
`200`	object	Aucune configuration `admin_followed_mail` n'est enregistrée	`{"configuration":[]}`
`401`	object	Authentification absente ou invalide	`{"errors":"Authentication Failed"}`
`403`	object	Route indisponible pour l'utilisateur authentifié	`{"errors":"Service forbidden"}`

{
  "configuration": {
    "listDisplay": {
      "templateColumns": 7,
      "subInfos": [
        {
          "value": "getPriority",
          "label": "Priorité",
          "sample": "Très haute",
          "cssClasses": ["align_leftData"],
          "icon": "fa-traffic-light"
        }
      ]
    }
  }
}

Données¶

Valeur	Type	Description
`configuration`	object ou array	Configuration enregistrée, ou tableau vide lorsqu'elle est absente
`configuration.listDisplay`	object	Paramètres de présentation de la liste
`configuration.listDisplay.templateColumns`	integer	Modèle de colonnes utilisé par le frontend
`configuration.listDisplay.subInfos`	array	Informations secondaires affichées dans la liste
`subInfos[].value`	string	Identifiant de la donnée, par exemple `getPriority` ou `getFolders`
`subInfos[].cssClasses`	array	Classes CSS appliquées à la donnée
`subInfos[].label`	string	Libellé affiché, lorsqu'il a été enregistré
`subInfos[].sample`	string	Exemple de rendu, lorsqu'il a été enregistré
`subInfos[].icon`	string	Icône du configurateur, lorsqu'elle a été enregistrée

Lister les tonalités configurées¶

Route¶

GET /rest/tones

Authentification, privilège et périmètre¶

L'authentification REST est obligatoire, sans contrôle de privilège.

Retour¶

Code HTTP	Type	Description	Exemple
`200`	object	Configuration enregistrée	Voir l'exemple ci-dessous
`401`	object	Authentification absente ou invalide	`{"errors":"Authentication Failed"}`
`404`	object	Aucune configuration de tonalité trouvé	`{"error":"Tones configuration not found"}`

{
  "tones": [
    {
      "id": "informatif",
      "icon": "ℹ️",
      "label": "Informatif ℹ️"
    }
  ]
}