<<<<<<< HEAD
assets/partage.png
assets/renater.png

1 Informations sur le document

Confidentialité

Le contenu de ce document et de ses annexes est strictement confidentiel et ne peut être diffusé en dehors des intervenants directs (Zextras Services, Client).

Table 1. Liste des différentes versions
Version Date Modification Intervenant

1.0

08/11/2013

Création

Cloud Temple, Service développement

1.1

21/11/2013

Ajout appels

Cloud Temple, Service développement

1.2

10/12/2014

Ajout appels

Cloud Temple, Service développement

1.7

16/09/2015

Nouveaux appels + Ajout de remarques d’utilisation de l’API.

Cloud Temple, Service développement

1.8

18/09/2015

Mise en forme aux couleurs Partage

Cloud Temple, Service Delivery Manager

1.9

24/09/2015

Modification des entrées de l’API + Remarques générales

Cloud Temple, Service Delivery Manager

1.10

05/11/2015

N° de version. Table des matières. Complément p15 et 37

Cloud Temple, Service Delivery Manager

1.11

29/01/2016

Verionning. Mise à jour Fonctionnalité Export/Restore

Cloud Temple, Service Delivery Manager

1.12

26/02/2016

Ajout notify_user pour ExportAccount et zimbraPrefFromDisplay pour createaccount, modifyaccount, getaccount

Cloud Temple, Service Delivery Manager

1.13

06/12/2016

Avertissement sur l’utilisation GetAllAccount

Cloud Temple, Service développement

1.14

23/12/2016

Mise à jour des valeurs et descriptions des sorties displayName et zimbraAccountStatus de l’appel GetAllAccount

Cloud Temple, Service développement

1.15

23/03/2017

Mise à jour de l’appel GetAllAccount pour le simplifier et gagner en performance ainsi que la possibilité de choisir ses attributs

Cloud Temple, Service développement

1.16

26/10/2017

Ajout d’un texte explicatif sur les contraintes de caches de Zimbra

Cloud Temple, Service développement

1.17

13/02/2018

Mise à jour du connecteur Zimbra SOAP

Zextras Services, Service développement

1.18

20/09/2018

Mise à jour de la documentation API et Ajout de l'attribut attrs pour l'appel GetAllAccounts.

Zextras Services, Service développement

2.0

08/11/2019

Mise à niveau structurelle de l'API.

Zextras Services, Service développement

2.1

08/11/2019

Ajout du chapitre 11 - Partages.

Zextras Services, Service développement

Sommaire

2 Environnement

API: https://api.partage.renater.fr/service/domain/

2.1 Remarques Générales

L’API contrôle les paramètres obligatoires et ignore les paramètres non valides.

Sauf spécification contraire, toutes les quantités de données sont expérimentées en octet.

Pour les appels de modification, seuls les paramètres envoyés sont modifiés. Les autres paramètres restent inchangés côté Zimbra.

Pour les appels de lecture, tous les paramètres indiqués dans les tableaux de "Sortie" ne sont pas forcément remontés s’ils sont vides du côté Zimbra.

Un délai d’attente maximal pour chaque appels est de 5 minutes.

Dû au mode de fonctionnement de Zimbra, certaines modifications et actions réalisées sur les comptes Partage, bien qu'étant prise en compte immédiatement, ne sont visibles qu’après expiration d’un cache applicatif, qui peut aller jusqu'à 15 minutes. Il faut donc prendre en compte ce délai de rafraichissement, avant d’effectuer des requêtes de contrôle liés à ces modifications, et s’assurer de leur prise en compte.

3 Authentfication

La première étape pour utiliser l’API est l’authentification. Après authentification, un token sera retourné par le serveur. Ce token devra être utilisé pour autoriser les autres appels à l’API.

https://api.partage.renater.fr/service/domain/Auth?domain=domain.com&timestamp=1135280708&preauth=f8f9ad772dea7be5382d24d5713bb850c5a9e572

Entrée : /service/domain/Auth

via: [GET, POST]

3.1 Paramètres d’entrée

assets/partage.png
assets/renater.png

1 Informations sur le document

Confidentialité

Le contenu de ce document et de ses annexes est strictement confidentiel et ne peut être diffusé en dehors des intervenants directs (Zextras Services, Client).

Table 1. Liste des différentes versions
Version Date Modification Intervenant

1.0

08/11/2013

Création

Cloud Temple, Service développement

1.1

21/11/2013

Ajout appels

Cloud Temple, Service développement

1.2

10/12/2014

Ajout appels

Cloud Temple, Service développement

1.7

16/09/2015

Nouveaux appels + Ajout de remarques d’utilisation de l’API.

Cloud Temple, Service développement

1.8

18/09/2015

Mise en forme aux couleurs Partage

Cloud Temple, Service Delivery Manager

1.9

24/09/2015

Modification des entrées de l’API + Remarques générales

Cloud Temple, Service Delivery Manager

1.10

05/11/2015

N° de version. Table des matières. Complément p15 et 37

Cloud Temple, Service Delivery Manager

1.11

29/01/2016

Verionning. Mise à jour Fonctionnalité Export/Restore

Cloud Temple, Service Delivery Manager

1.12

26/02/2016

Ajout notify_user pour ExportAccount et zimbraPrefFromDisplay pour createaccount, modifyaccount, getaccount

Cloud Temple, Service Delivery Manager

1.13

06/12/2016

Avertissement sur l’utilisation GetAllAccount

Cloud Temple, Service développement

1.14

23/12/2016

Mise à jour des valeurs et descriptions des sorties displayName et zimbraAccountStatus de l’appel GetAllAccount

Cloud Temple, Service développement

1.15

23/03/2017

Mise à jour de l’appel GetAllAccount pour le simplifier et gagner en performance ainsi que la possibilité de choisir ses attributs

Cloud Temple, Service développement

1.16

26/10/2017

Ajout d’un texte explicatif sur les contraintes de caches de Zimbra

Cloud Temple, Service développement

1.17

13/02/2018

Mise à jour du connecteur Zimbra SOAP

Zextras Services, Service développement

1.18

20/09/2018

Mise à jour de la documentation API et Ajout de l'attribut attrs pour l'appel GetAllAccounts.

Zextras Services, Service développement

2.0

08/01/2020

Mise à jour du socle OS + Framework de l'API PARTAGE.

Zextras Services, Service développement

Sommaire

2 Environnement

API: https://api.partage.renater.fr/service/domain/

2.1 Remarques Générales

L’API contrôle les paramètres obligatoires et ignore les paramètres non valides.

Sauf spécification contraire, toutes les quantités de données sont expérimentées en octet.

Pour les appels de modification, seuls les paramètres envoyés sont modifiés. Les autres paramètres restent inchangés côté Zimbra.

Pour les appels de lecture, tous les paramètres indiqués dans les tableaux de "Sortie" ne sont pas forcément remontés s’ils sont vides du côté Zimbra.

Un délai d’attente maximal pour chaque appels est de 5 minutes.

Dû au mode de fonctionnement de Zimbra, certaines modifications et actions réalisées sur les comptes Partage, bien qu'étant prise en compte immédiatement, ne sont visibles qu’après expiration d’un cache applicatif, qui peut aller jusqu'à 15 minutes. Il faut donc prendre en compte ce délai de rafraichissement, avant d’effectuer des requêtes de contrôle liés à ces modifications, et s’assurer de leur prise en compte.

3 Authentfication

La première étape pour utiliser l’API est l’authentification. Après authentification, un token sera retourné par le serveur. Ce token devra être utilisé pour autoriser les autres appels à l’API.

https://api.partage.renater.fr/service/domain/Auth?domain=domain.com&timestamp=1135280708&preauth=f8f9ad772dea7be5382d24d5713bb850c5a9e572

Entrée : /service/domain/Auth

via: [GET, POST]

3.1 Paramètres d’entrée

Entrées Typages Obligatoire Description

domain

String

oui

Domaine sur lequel l’utilisateur veut travailler.

preauth

String

oui

Hash d’authentification

timestamp

Timestamp / integer en seconde

oui

Justifier la proximité temporelle de la requête.

Cet appel retourne une réponse avec le token.

<?xml version="1.0" encoding="utf-8" ?>
<Response>
<status>1</status>
<message>Success</message>
<Token>4ba1818fda3a115434…d33363a3865652d383765382d343965392d3383</Token>
</Response>

3.2 Paramètres de sortie

Sortie Valeurs Description

Message

Description de la réponse

Status

0

Authentification réussie

Status

Autre

Authentification échouée

Token

Token d’authentification

3.3 Description du mécanisme de clé preauth

Le mécanisme d’authentification fonctionne grâce à une clé partagée (preAuthKey) entre l’API et le client. La clé générée est unique pour chaque domaine de messagerie.

Remarque : les appels disponibles par Webservices seront limités à la gestion des domaines de messagerie.

A partir de cette clé, le client va construire un ticket preAuth en utilisant les paramètres suivants :

  • Nom du domaine

  • Timestamp en seconde (pour justifier la proximité temporelle de la clé)

  • preAuthKey du domaine ("6b7ead4bd425836e8cf0079cd6c1a05acc127acd07c8ee4b61023e19250e929c")

  • HMAC SHA-1 des données utilisant la clé

Exemple : 

preAuth = hmac("domain.com|1135280708", "6b7ead4bd425836e8cf0079cd6c1a05acc127acd07c8ee4b61023e19250e929c");
preAuth => f8f9ad772dea7be5382d24d5713bb850c5a9e572

Une fois la clé preAuth générée, le client fera son appel d’authentification à l’API en passant les paramètres suivants :

  • Nom du domaine

  • Timestamp utilisé

  • preAuth

De son côté, l’API utilisera les paramètres reçu pour recréer la clé preAuth. Si celle-ci correspond, il y a authentification. L’API renvoie alors un Token avec une durée de vie pour le reste des appels à effectuer.

Remarque : la clé preAuth aura une durée de vie de 5 minutes entre le moment où elle est générée, et le moment où elle est envoyée à l’API pour authentification. Au-delà, elle ne sera plus valide, il faudra en générer une nouvelle.

4 Accounts

4.1 AddAccountAlias

Entrée : /service/domain/AddAccountAlias/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

alias

String

oui

Alias à ajouter

name

String

oui

Adresse mail principale du compte.

 
https://api.partage.renater.fr/service/domain/AddAccountAlias/<token>?name=compte@domain.com&alias=compte2@domain.com
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Ok

Status

Autre

Ko

4.2 CancelExportAccount

Entrée : /service/domain/CanvelExportAccount/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

name

String

oui

Adresse mail principale du compte à exporter

ticket

integer

oui

Numéro du ticket à annuler

 
https://api.partage.renater.fr/service/domain/CancelExportAccount/<token>?name=compte@domain.com&ticket=443
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Annulation enregistrée

Status

Autre

Annulation échouée

4.3 CancelRestoreAccount

Entrée : /service/domain/CancelRestoreAccount/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

name

String

oui

Adresse mail principale du compte

ticket

Integer

oui

Numéro du ticket à annuler

 
https://api.partage.renater.fr/service/domain/CancelRestoreAccount/<token>?name=compte@domain.com&ticket=458
Sortie Valeurs Desription

Message

Description de la réponse

Status

0

Annulation enregistrée

Status

Autre

Annulation échouée

4.4 CreateAccount

Entrée : /service/domain/CreateAccount/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

carLicense

String

Numéro EPPN de l’utilisateur

co

String

Nom du pays

company

String

Nom de la société ou de l'étalissement

description

String

Description du compte

displayName

String

Nom affiché dans les emails

facsimileTelephoneNumber

String

Fax de l'utilisateur

givenName

String

Prénom de l'utilisateur

homePhone

String

Téléphone domicile de l'utilisateur

initials

String

Initial (M. ou Mme)

l

String

Ville de l'utilisateur

mobile

String

Numéro de mobile de l'utilisateur

name

Adresse mail valide

Oui

Adresse mail principale de l’utilisateur

pager

String

Numéro raccourci de l'utilisateur

password

String

Oui

Mot de passe en clair

postalCode

String

Code postal

sn

String

Nom de famille de l'utilisateur

st

String

État de l'utilisateur

street

String

Rue de l'utilisateur

telephoneNumber

String

Téléphone de l'utilisateur

title

String

Fonction de l'utilisateur

userPassword

String

Empreinte du mot de passe

zimbraAccountStatus

String(active, closed, locked, lockout, pending, maintenance)

État du compte (défaut active)

zimbraCOSId

String

Id de la classe de service

zimbraFeatureBriefcasesEnabled

String (TRUE, FALSE)

Onglet porte document

zimbraFeatureCalendarEnabled

String (TRUE, FALSE)

Onglet calendrier

zimbraFeatureContactsEnabled

String (TRUE, FALSE)

Onglet contact

zimbraFeatureMailEnabled

String (TRUE, FALSE)

Onglet mail

zimbraFeatureMailForwardingEnabled

String (TRUE, FALSE)

Permettre à l’utilisateur d’indiquer une adresse de redirection

zimbraFeatureOptionsEnabled

String (TRUE, FALSE)

Onglet préférences

zimbraFeatureTasksEnabled

String (TRUE, FALSE)

Onglet tâche

zimbraHideInGal

String (TRUE, FALSE)

Masquer dans la GAL

zimbraMailQuota

Integer (octet)

0=illimité

zimbraNotes

String

Notes libres

zimbraPasswordMustChange

String (TRUE, FALSE)

Doit changer son mot de passe à la prochaine connexion

zimbraPrefMailForwardingAddress

Adresse mail valide

Adresse de redirection saisie par l’utilisateur

zimbraPrefMailLocalDeliveryDisabled

String (TRUE, FALSE)

Ne pas conserver de copie des mails sur le client local

zimbraMailCanonicalAddress

String

Adresse email visible pour les messages sortants

zimbraPrefFromDisplay

String

Nom affiché visible pour les messages sortants

zimbraZimletAvailableZimlets

Array

Liste des zimlets activés pour l'utilisateur

zimbraMailForwardingAddress

Adresse mail valide

Adresse de redirection cachée à l’utilisateur

 
https://api.partage.renater.fr/service/domain/CreateAccount/<token>?name=compte@domain.com&password=secret&givenName=Family
Sortie Valeurs Decritpion

Message

Description de la réponse

Status

0

Création réussie

Status

Autre

Création échouée

Remarque : Pour créer un compte le paramètre password est obligatoire. Il contient le mot de passe en clair de l’utilisateur. Si vous disposez uniquement de l’empreinte du mot de passe de l’utilisateur, laissez le paramètre password vide, et insérez l’empreinte à l’aide du paramètre userPassword.

Les formats d’empreinte acceptés sont ceux de Zimbra.

RFC2256/2307 : password of user. Stored encoded as SSHA (salted-SHA1)

http://www.rfc-editor.org/info/rfc2256

http://www.rfc-editor.org/info/rfc2307

4.5 DeleteAccount

Entrée : /service/domain/DeleteAccount/<token>

via: [GET, POST]

Entrées Valeurs Obligatoire Description

name

String

oui

Adresse mail principale du compte à supprimer.

 
https://api.partage.renater.fr/service/domain/DeleteAccount/<token>?name=compte@domain.com
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Suppression réussie

Status

Autre

Suppression échouée

4.6 ExportAccount

Entrée : /service/domain/ExportAccount/<token>

via: [GET, POST]

Entrées Valeurs Obligatoire Description

ftp_host

String

oui

Host du serveur FTP

ftp_login

String

oui

Identifiant de connexion

ftp_password

String

oui

Mot de passe de connexion

ftp_port

integer

oui

Port de connexion

name

String

oui

Adresse mail principale du compte à exporter.

notify_user

Boolean

non

Notification de l’utilisateur (Défaut: 0)

 
https://api.partage.renater.fr/service/domain/ExportAccount/<token>?name=compte@domain.com&ftp_host=ftp.partage.renater.fr&ftp_login=Renater&ftp_password=xxxxx&ftp_port=22&notify_user=1
Sortie Valeurs Description

ticket

integer

Id du job

Message

Description de la réponse

Status

0

Demande enregistrée

Status

Autre

Demande échouée

Remarque : Le processus utilise un mode de connexion passif depuis les plages IP suivantes :

194.254.240.0/23
194.254.242.0/24

4.7 GetAccount

Entrée : /service/domain/GetAccount/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

name

Adresse mail valide

Oui

Adresse mail principale de l’utilisateur

 
https://api.partage.renater.fr/service/domain/GetAccount/<token>?name=compte@domain.com
Sorties Valeurs Description

admin

String

Profil admin de l'utilisateur. NULL=utilisateur, ETABLI=administrateur d'établissement, DOMAIN=administrateur de domaine, READ=administrateur de domaine en lecture seule.

carLicense

String

Numéro EPPN de l’utilisateur

co

String

Nom du pays

company

String

Nom de la société ou de l'étalissement

description

String

Description du compte

displayName

String

Nom affiché dans les emails

facsimileTelephoneNumber

String

Fax de l'utilisateur

givenName

String

Prénom de l'utilisateur

homePhone

String

Téléphone domicile de l'utilisateur

id

String

ID Zimbra de l'utilisateur

initials

String

Initial (M. ou Mme)

l

String

Ville de l'utilisateur

mav_redirection

String

Email de forward à utiliser après la transformation du compte en mail à vie.

mav_transformation

String (TRUE,FALSE)

Ordonne au système la transformation du compte en mail à vie.

mobile

String

Numéro de mobile de l'utilisateur

name

Adresse mail valide

Adresse mail principale de l’utilisateur

pager

String

Numéro raccourci de l'utilisateur

postalCode

String

Code postal

sn

String

Nom de famille de l'utilisateur

st

String

État de l'utilisateur

status

0

Requête réussie

status

Autre

Requête échouée

street

String

Rue de l'utilisateur

telephoneNumber

String

Téléphone de l'utilisateur

title

String

Fonction de l'utilisateur

used

Integer (octet)

Volumétrie de la boîte mail.

userPassword

String

Empreinte du mot de passe

zimbraAccountStatus

String(active, closed, locked, lockout, pending, maintenance)

État du compte (défaut active)

zimbraCOSId

String

Id de la classe de service

zimbraFeatureBriefcasesEnabled

String (TRUE, FALSE)

Onglet porte document

zimbraFeatureCalendarEnabled

String (TRUE, FALSE)

Onglet calendrier

zimbraFeatureContactsEnabled

String (TRUE, FALSE)

Onglet contact

zimbraFeatureMailEnabled

String (TRUE, FALSE)

Onglet mail

zimbraFeatureMailForwardingEnabled

String (TRUE, FALSE)

Permettre à l’utilisateur d’indiquer une adresse de redirection

zimbraFeatureOptionsEnabled

String (TRUE, FALSE)

Onglet préférences

zimbraFeatureTasksEnabled

String (TRUE, FALSE)

Onglet tâche

zimbraHideInGal

String (TRUE, FALSE)

Masquer dans la GAL

zimbraLastLogonTimestamp

Timestamp (%Y%m%d%H%M%SZ)

Date et heure de dernière connexion de l'utiisateur. Attention, cette valeur n'est pas mise à jour temps réel.

zimbraMailAlias

Array

Liste des alais du compte

zimbraMailCanonicalAddress

String

Adresse email visible pour les messages sortants

zimbraMailForwardingAddress

Adresse mail valide

Adresse de redirection cachée à l’utilisateur

zimbraMailQuota

Integer (octet)

0=illimité

zimbraNotes

String

Notes libres

zimbraPasswordMustChange

String (TRUE, FALSE)

Doit changer son mot de passe à la prochaine connexion

zimbraPrefFromDisplay

String

Adresse email visible pour les messages sortants

zimbraPrefMailForwardingAddress

Adresse mail valide

Adresse de redirection saisie par l’utilisateur

zimbraPrefMailLocalDeliveryDisabled

String (TRUE, FALSE)

Ne pas conserver de copie des mails sur le client local

zimbraZimletAvailableZimlets

Array

Liste des zimlets activés pour l'utilisateur

Remarque : Pour pouvoir sauvegarder le numéro d’EPPN des utilisateurs dans le LDAP de Zimbra, le champ carLicense a été détourné.

Information sur les statuts (zimbraAccountStatus) :

  • active: Le statut normal d'un compte. Les mails entrants sont délivrés et les utilisateurs peuvent se connecter à l'interface.

  • maintenance: En maintenance, la connexion est désactivée et le courrier adressé au compte est mis en file d'attente au niveau des MTA. Un compte peut être configuré automatiquement en mode de maintenance lors de la sauvegarde du compte, l'importation ou la restauration de sa boîte aux lettres. (Attention, statut automatique géré par Zimbra)

  • pending: Statut qui peut être attribué lorsqu'un nouveau compte est créé et n'est pas encore prêt à devenir actif. La connexion est désactivée et les messages sont rejetés. (Attention, statut automatique géré par Zimbra)

  • locked: Lorsqu'un compte est verrouillé, l'utilisateur ne peut pas se connecter, mais le courrier est quand même délivré au compte. Le statut verrouillé peut être activé si vous soupçonnez qu'un compte de messagerie a été piraté ou qu'il est utilisé de manière non autorisée.

  • closed: Lorsqu'un compte est fermé, la connexion est désactivée et les messages sont rejetés. Ce statut est utilisé pour clôturer un compte avant sa suppression définitive du serveur.

  • lockout: Identique au statut locked, le statut lockout est défini automatiquement lorsque le nombre de tentative de connexion invalide pour l'utilisateur dépasse le seuil autorisé. La durée du blocage du compte est définie par la COS. Vous pouvez modifier mnuellement le statut du compte à tout moment. (Attention, statut automatique géré par Zimbra)

4.8 GetAllAccounts

Entrée : /service/domain/GetAllAccounts/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

attrs

String

non

Possibilité d’ajouter ses attributs Zimbra (identiques à ceux du GetAccount) séparés par des virgules ex: mail,zimbraMailAlias

ldap_query

String

Filtre LDAP de recherche. Exemple: (zimbraAccountStatus=closed).

limit

integer

Défaut 100 (attention !)

offset

integer

Défaut 0

sortascending

Integer(0,1)

0=desc, 1=asc

sortby

String (mail, givenName, sn, displayName)

oui

 

https://api.partage.renater.fr/service/domain/GetAllAccounts/<token>?offset=0&limit=500&sortby=mail&sortascending=1
Sorties Valeurs Description

message

Description de la réponse

status

0

Requête réussie

status

Autre

Requête échouée

search-total

Nombre maximum d'éléments pour la requête

accounts

Array

Liste des comptes

          cos-name (attr. par defaut)

String

Nom de la classe de service

          DisplayName (attr. par defaut)

String

Nom affiché

          id (attr. par defaut)

String

Id du compte

          quota (attr. par defaut)

Integer

Quantité de stockage allouée à l’utilisateur

          used (attr. par defaut)

Integer

Quantité de stockage réellement utilisée

          zimbraAccountStatus (attr. par defaut)

String(active, closed, locked, lockout, pending, maintenance)

Etat du compte défaut active

          zimbraCOSId (attr. par defaut)

String

Identifiant de la classe service

          zimbraLastLogonTimestamp (attr. par defaut)

Timestamp

Timestamp de dernière connexion

 
<?xml version="1.0" encoding="utf-8" ?>
<Response>
<status>1</status>
<message>Success</message>
<accounts>
<account>
<name>compte@domain.com</name>
<zimbraAccountStatus>active</zimbraAccountStatus>
<displayName>M. Compte</displayName>
…
</account>
...
</accounts>
</Response>

Cet appel permet de récupérer un certain nombre de caractéristiques de l’ensemble des comptes d’un domaine. Cette récupération peut être coûteuse dans le cas d’un grand nombre de comptes (>1000) si la pagination n’est pas utilisée (attributs limit et offset), au point d'échouer si ce nombre est trop important. Il est donc prévu deux modes de fonctionnement en fonction du contenu de l’argument "attrs" :

  • sans argument "attrs" : mode de fonctionnement normal avec les valeurs récupérées décrites ci-dessous. Certaines étant particulièrement coûteuses à récupérer (used , quota, admin, cos_name)

  • avec argument "attrs" : possibilité de choisir parmi toutes les valeurs récupérées par l’appel GetAccount. Seules les valeurs indiquées sont récupérées, permettant ainsi "d’alléger" l’appel, avec la limitation suivante : les valeurs issues de la COS (non personnalisées pour le compte) ne sont pas remontées. Il est alors nécessaire de faire un appel GetAccount pour les obtenir.

Mode normal (argument "attrs" absent) :

Voir le tableau de sortie ci-dessus pour le retour des attributs par défaut.

Mode alternatif (argument "attrs" présent) :

"attrs" contient une ou plusieurs valeurs parmi les noms de paramètres pouvant être remontés ci-dessous. Seuls ces paramètres seront alors remontés. Exemple : "attrs= zimbraAccountStatus,mail,zimbraFeatureMailForwardingEnabled,zimbraPrefMailForwardingAddress". Attention : les paramètres issus de la COS du compte (et non personnalisés pour ce compte) ne sont pas remontés car absents de la base LDAP interrogée dans ce cas. Pour obtenir la valeur d’un paramètre non remonté il faut faire un appel GetAccount.

Attention : A partir de 1000 comptes, il est fortement recommandé d’utiliser la pagination avec les attributs limit et offset pour cet appel. la valeur par défaut étant de 100, nous assurons une compatibilité avec la version actuelle de Zimbra de Partage. Zimbra gére incorrectement cet appel avec un grand nombre de resultats retournés.

Attention : Il n’est pas possible d’utiliser les attributs used et quota dans la directive sortBy de l’appel. La mise à jour des attributs used et quota est asynchrone. Les valeurs sont collectées une fois par jour. Un quota à zéro indique un quota illimité.

4.9 GetExportAccount

Entrée : /service/domain/GetExportAccount/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

name

String

oui

Adresse mail principale du compte à exporter

ticket

integer

oui

Numéro de ticket d'exportation de compte

 
https://api.partage.renater.fr/service/domain/GetExportAccount/<token>?name=compte@domain.com&ticket=443
Sortie Valeurs Description

Message

Description de la réponse

name

String

Le nom du compte

position

integer

Position du ticket dans la file d’attente

Status

0

Ok

Status

Autre

Ko

ticket

integer

Numéro de ticket d'exportation de compte

4.10 GetRestoreAccount

Entrées : /service/domain/GetRestoreAccount/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

name

String

oui

Adresse mail principale du compte

ticket

Integer

oui

Numéro de ticket de restauration de compte

 
https://api.partage.renater.fr/service/domain/GetRestoreAccount/<token>?name=compte@domain.com&ticket=443
Sortie Valeurs Description

datepref

Timestamp

Date de restauration demandée

Message

Description de la réponse

name

String

Adresse mail principale du compte

position

integer

Position du ticket dans la file d’attente

Status

0

Ok

Status

Autre

Ko

ticket

integer

Numéro de ticket de restauration de compte

4.11 ListExportAccounts

Entrée : /service/domain/ListExportAccounts/<token>

via : [GET, POST]

https://api.partage.renater.fr/service/domain/ListExportAccounts/<token>
Sortie Valeurs Description

accounts

array

Liste des comptes du domaine en file d’attente

Message

Description de la réponse

Status

0

Demande enregistrée

Status

Autre

Demande échouée

4.12 ListRestoreAccounts

Entrée : /service/domain/ListRestoreAccounts/<token>

via : [GET, POST]

https://api.partage.renater.fr/service/domain/ListRestoreAccounts/<token>
Sortie Valeurs Description

accounts

array

Liste des comptes du domaine en file d’attente

Message

Description de la réponse

Status

0

Demande enregistrée

Status

Autre

Demande échouée

4.13 ModifyAccount

Entrée : /service/domain/ModifyAccount/<token>

via : [GET, POST]

Dans cet appel, il est nécessaire de ne lister que les attributs que l’on veut changer. Noter que, dans le cas de zimbraAllowFromAddress, toute valeur passée remplacera toutes les adresses existantes.

Entrées Valeurs Obligatoire Description

carLicense

String

Numéro EPPN de l’utilisateur

co

String

Nom du pays

company

String

Nom de la société ou de l'étalissement

description

String

Description du compte

displayName

String

Nom affiché dans les emails

facsimileTelephoneNumber

String

Fax de l'utilisateur

givenName

String

Prénom de l'utilisateur

homePhone

String

Téléphone domicile de l'utilisateur

initials

String

Initial (M. ou Mme)

l

String

Ville de l'utilisateur

mobile

String

Numéro de mobile de l'utilisateur

name

Adresse mail valide

Adresse mail principale de l’utilisateur

pager

String

Numéro raccourci de l'utilisateur

postalCode

String

Code postal

sn

String

Nom de famille de l'utilisateur

st

String

État de l'utilisateur

street

String

telephoneNumber

String

Rue de l'utilisateur

title

String

Fonction de l'utilisateur

userPassword

String

Empreinte du mot de passe

zimbraAccountStatus

String(active, closed, locked, lockout, pending, maintenance)

État du compte (défaut active)

zimbraAllowFromAddress

Array

Adresses acceptées comme adresse d’origine

zimbraCOSId

String

Id de la classe de service

zimbraFeatureBriefcasesEnabled

String (TRUE, FALSE)

Onglet porte document

zimbraFeatureCalendarEnabled

String (TRUE, FALSE)

Onglet calendrier

zimbraFeatureContactsEnabled

String (TRUE, FALSE)

Onglet contact

zimbraFeatureMailEnabled

String (TRUE, FALSE)

Onglet mail

zimbraFeatureMailForwardingEnabled

String (TRUE, FALSE)

Permettre à l’utilisateur d’indiquer une adresse de redirection

zimbraFeatureOptionsEnabled

String (TRUE, FALSE)

Onglet préférences

zimbraFeatureTasksEnabled

String (TRUE, FALSE)

Onglet tâche

zimbraHideInGal

String (TRUE, FALSE)

Masquer dans la GAL

zimbraMailQuota

Integer (octet)

0=illimité

zimbraNotes

String

Notes libres

zimbraPasswordMustChange

String (TRUE, FALSE)

Doit changer son mot de passe à la prochaine connexion

zimbraPrefMailForwardingAddress

Adresse mail valide

Adresse de redirection saisie par l’utilisateur

zimbraPrefMailLocalDeliveryDisabled

String (TRUE, FALSE)

Ne pas conserver de copie des mails sur le client local

zimbraMailCanonicalAddress

String

Adresse email visible pour les messages sortants

zimbraPrefFromDisplay

String

Adresse email visible pour les messages sortants

zimbraZimletAvailableZimlets

Array

Liste des zimlets activés pour l'utilisateur

zimbraMailForwardingAddress

Adresse mail valide

Adresse de redirection cachée à l’utilisateur

 
https://api.partage.renater.fr/service/domain/ModifyAccount/<token>?name=compte@domain.com&zimbraHideInGal=TRUE
Sortie Valeurs Description

aliases

Array

Liste des alias du compte

Message

Description de la réponse

Status

0

Modification réussie

Status

Autre

Modification échouée

Remarque : Il n’est pas possible de changer le mot de passe en clair de l’utilisateur avec l’appel ModifyAccount.

Pour changer le mot de passe en clair de votre compte, vous devez utiliser l’appel SetPassword.

Remarque : L’attribut zimbraAllowFromAddress permet d’autoriser une ou plusieurs adresses mail en tant qu’adresse d’expédition pour un utilisateur donné. Attention, seules des adresses non utilisées peuvent être renseignées dans cet attribut.

Pour autoriser l’utilisation d’adresses mail de groupe, vous devez utiliser les appels AddSendAsGroup et DeleteSendAsGroup.

Remarque : Pour transformer un compte en mail à vie il faut indiquer le mail de redirection dans l'attribut zimbraNotes de la façon suivante: zimbraNotes="_MAV_user@domain.com".

L'action de transformation en mail à vie est asynchrone. Vous recevrez un rapport de transformation en mail à vie à la fin de chaque opération.

Remarque : Pour remettre un attribut à la valeur de la COS, il faut modifier l'attribut avec une valeur vide (attribut="") pour les attributs monovalué, et un tableau vide (attribut=[]) pour les attributs multivalué.

4.14 RemoveAccountAlias

Entrée : /service/domain/RemoveAccountAlias/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

alias

String

oui

Alias à supprimer

name

String

oui

Adresse mail principale du compte

 
https://api.partage.renater.fr/service/domain/RemoveAccountAlias/<token>?name=compte@domain.com&alias=compte2@domain.com
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Ok

Status

Autre

Ko

4.15 RenameAccount

Entrée : /service/domain/RenameAccount/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

name

String

oui

Adresse mail principale du compte à renommer

newname

String

oui

Nouvelle adresse mail du compte

 
https://api.partage.renater.fr/service/domain/RenameAccount/<token>?name=compte@domain.com&newname=nouveaunom@domain.com
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Renommage réussi

Status

Autre

Renommage échoué

Remarque : le renommage de compte n’est possible que sur le même nom de domaine.

4.16 RestoreAccount

Entrée : /service/domain/RestoreAccount/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

datepref

Timestamp Unix

oui

Date de restauration souhaitée

name

String

oui

Adresse mail principale du compte

 
https://api.partage.renater.fr/service/domain/RestoreAccount/<token>?name=compte@domain.com&datepref=1410682753
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Demande enregistrée

Status

Autre

Demande échouée

ticket

integer

Numéro de ticket généré

4.17 SetPassword

Permet de modifier le mot de passe d’un utilisateur à l’aide d’un mot de passe en clair.

Entrée : /service/domain/SetPassword/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

name

String

oui

Adresse mail principale du compte

password

String

oui

Nouveau mot de passe en clair

 
https://api.partage.renater.fr/service/domain/SetPassword/<token>?name=compte@domain.com&password=azerty
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Ok

Status

Autre

Ko

Remarque : La modification du mot de passe de l'utilisateur aura pour effet d'invalider toutes les sessions en cours.

Remarque : Pour modifier le mot de passe à l’aide d’une empreinte, vous devez utiliser l’appel ModifyAccount et l’attribut userPassword.

5 Alias

5.1 GetAllAliases

Entrée : /service/domain/GetAllAliases/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

limit

integer

Défaut 100

offset

integer

Défaut 0

 
https://api.partage.renater.fr/service/domain/GetAllAliases/<token>?offset=0&limit=500
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Ok

Status

Autre

Ko

search-total

Integer

Nombre maximum d'éléments pour la requête

aliases

Array

     alias

          name

String

Nom de l’alias

          target

String

Cible de l’alias

          type

String

Type de la cible (account, dl(groupe))

6 Classes de service

6.1 GetAllCos

Permet de récupérer l’ensemble des classes de service de la plateforme Partage.

Entrée : /service/domain/GetAllCos/<token>

via : [GET, POST]

https://api.partage.renater.fr/service/domain/GetAllCos/<token>
Sorties Valeurs Description

cn

String

RFC2556 : common name(s) for wich the entity is known by

description

String

Description de la cos dans zimbra

id

String

Alias de zimbraId

name

String

Nom de la cos dans Zimbra

zimbraId

String

Id zimbra de la classe de service

 
<?xml version="1.0" encoding="utf-8" ?>
<Response>
<status>1</status>
<message>Success</message>
<coses>
<cose>
<name>staff_renater</name>
<id>d7d2f33b-c7fc-4064-b6ea-f52218503e3c</id>
<cn>staff_renater</cn>
<zimbraId>d7d2f33b-c7fc-4064-b6ea-f52218503e3c</zimbraId>
</cose>
…
</coses>
</Response>

6.2 GetCos

Permet de récupérer les attributs Zimbra d’une classe de service

Entrées : /service/domain/GetCos/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

Name

String

oui

Nom de la classe de service

https://api.partage.renater.fr/service/domain/GetCos/<token>?name=staff_renater_fr
Sorties Valeurs Description

name

String

Nom de la classe de service

zimbraDumpsterEnabled

String

Dossier benne

zimbraExternalSharingEnabled

String

Fonction partage externe

zimbraFeatureBriefcasesEnabled

String

Onglet Porte-Document

zimbraFeatureCalendarEnabled

String

Onglet Calendrier

zimbraFeatureChangePasswordEnabled

String

Fonction changer son mot de passe

zimbraFeatureContactsEnabled

String

Onglet Contact

zimbraFeatureConversationsEnabled

String

Mode conversation

zimbraFeatureDistributionListFolderEnabled

String

Distribution Lists Folder

zimbraFeatureExportFolderEnabled

String

Exporter

zimbraFeatureFiltersEnabled

String

Filtres de mails

zimbraFeatureFlaggingEnabled

String

Activer les drapeaux

zimbraFeatureGalAutoCompleteEnabled

String

Saisie automatique à partir de la liste GAL

zimbraFeatureGalEnabled

String

Accès à la liste GAL

zimbraFeatureGroupCalendarEnabled

String

Calendrier de groupe

zimbraFeatureHtmlComposeEnabled

String

Ecriture HTML

zimbraFeatureIdentitiesEnabled

String

Avatar

zimbraFeatureImapDataSourceEnabled

String

Accès externe IMAP

zimbraFeatureImportFolderEnabled

String

Importer

zimbraFeatureMailEnabled

String

Onglet Mail

zimbraFeatureMailForwardingEnabled

String

Permettre à l’utilisateur d’indiquer une adresse de redirection

zimbraFeatureMailPriorityEnabled

String

Priorité du mail

zimbraFeatureMailSendLaterEnabled

String

Envoi du mail plus tard

zimbraFeatureManageZimlets

String

Gestion des zimlets

zimbraFeatureMAPIConnectorEnabled

String

Connecteur IMAP (Microsoft Outlook)

zimbraFeatureMobileSyncEnabled

String

Synchonisation mobile

zimbraFeatureNewMailNotificationEnabled

String

Notification de nouveau mail

zimbraFeatureOptionsEnabled

String

Onglet Préférences

zimbraFeatureOutOfOfficeReplyEnabled

String

Mail automatique de notification d’absence

zimbraFeaturePop3DataSourceEnabled

String

Accès externe POP3

zimbraFeatureReadReceiptsEnabled

String

Activer les accusés de lecture

zimbraFeatureSavedSearchesEnabled

String

Fonction recherche sauvegardée

zimbraFeatureSharingEnabled

String

Fonction Partage

zimbraFeatureSkinChangeEnabled

String

Fonction changer de skin

zimbraFeatureTaggingEnabled

String

Fonction Tags

zimbraFeatureTasksEnabled

String

Onglet Tâches

zimbraId

String

Id zimbra

zimbraImapEnabled

String

Activation IMAP

zimbraMailQuota

Integer

Quota par défaut de la COS (Octet)

zimbraPop3Enabled

String

Activation du POP3

zimbraPublicSharingEnabled

String

Fonction partage public

zimbraZimletAvailableZimlets

Array

Liste des zimlets par défaut de la classe de service

 
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<status type="integer">0</status>
<message>Opération réalisée avec succès !</message>
<cos>
<zimbraZimletAvailableZimlets type="array">
<zimbraZimletAvailableZimlet>!com_zimbra_url</zimbraZimletAvailableZimlet>
<zimbraZimletAvailableZimlet>!com_zimbra_email</zimbraZimletAvailableZimlet>
<zimbraZimletAvailableZimlet>+com_zimbra_smime</zimbraZimletAvailableZimlet>
<zimbraZimletAvailableZimlet>!com_zimbra_date</zimbraZimletAvailableZimlet>
<zimbraZimletAvailableZimlet>+com_zimbra_ymemoticons</zimbraZimletAvailableZimlet>
<zimbraZimletAvailableZimlet>-com_zimbra_click2call_cisco</zimbraZimletAvailableZimlet>
<zimbraZimletAvailableZimlet>+com_zimbra_emailtemplates</zimbraZimletAvailableZimlet>
<zimbraZimletAvailableZimlet>!com_zimbra_attachmail</zimbraZimletAvailableZimlet>
<zimbraZimletAvailableZimlet>!com_zimbra_attachcontacts</zimbraZimletAvailableZimlet>
<zimbraZimletAvailableZimlet>-com_zimbra_click2call_mitel</zimbraZimletAvailableZimlet>
<zimbraZimletAvailableZimlet>+com_zimbra_webex</zimbraZimletAvailableZimlet>
<zimbraZimletAvailableZimlet>+com_zimbra_srchhighlighter</zimbraZimletAvailableZimlet>
<zimbraZimletAvailableZimlet>+com_zimbra_phone</zimbraZimletAvailableZimlet>
<zimbraZimletAvailableZimlet>+com_zimbra_voiceprefs</zimbraZimletAvailableZimlet>
</zimbraZimletAvailableZimlets>
<name>staff_renater_fr</name>
<zimbraId>3de8ec0b-037a-4dea-94be-de2d70ab9a91</zimbraId>
<zimbraFeatureSkinChangeEnabled>TRUE</zimbraFeatureSkinChangeEnabled>
<zimbraFeatureConversationsEnabled>TRUE</zimbraFeatureConversationsEnabled>
<zimbraFeatureFlaggingEnabled>TRUE</zimbraFeatureFlaggingEnabled>
<zimbraFeatureMailForwardingEnabled>TRUE</zimbraFeatureMailForwardingEnabled>
<zimbraFeatureReadReceiptsEnabled>TRUE</zimbraFeatureReadReceiptsEnabled>
<zimbraFeatureTaggingEnabled>TRUE</zimbraFeatureTaggingEnabled>
<zimbraFeatureNewMailNotificationEnabled>TRUE</zimbraFeatureNewMailNotificationEnabled>
<zimbraFeatureOptionsEnabled>TRUE</zimbraFeatureOptionsEnabled>
<zimbraPop3Enabled>TRUE</zimbraPop3Enabled>
<zimbraFeatureSharingEnabled>TRUE</zimbraFeatureSharingEnabled>
<zimbraMailQuota>0</zimbraMailQuota>
<zimbraFeatureGalEnabled>TRUE</zimbraFeatureGalEnabled>
<zimbraFeatureGroupCalendarEnabled>TRUE</zimbraFeatureGroupCalendarEnabled>
<zimbraFeatureMailPriorityEnabled>TRUE</zimbraFeatureMailPriorityEnabled>
<zimbraDumpsterEnabled>FALSE</zimbraDumpsterEnabled>
<zimbraFeatureHtmlComposeEnabled>TRUE</zimbraFeatureHtmlComposeEnabled>
<zimbraFeatureMAPIConnectorEnabled>TRUE</zimbraFeatureMAPIConnectorEnabled>
<zimbraFeatureSavedSearchesEnabled>TRUE</zimbraFeatureSavedSearchesEnabled>
<zimbraFeatureIdentitiesEnabled>TRUE</zimbraFeatureIdentitiesEnabled>
<zimbraImapEnabled>TRUE</zimbraImapEnabled>
<zimbraFeatureFiltersEnabled>TRUE</zimbraFeatureFiltersEnabled>
<zimbraFeatureOutOfOfficeReplyEnabled>TRUE</zimbraFeatureOutOfOfficeReplyEnabled>
<zimbraFeatureBriefcasesEnabled>FALSE</zimbraFeatureBriefcasesEnabled>
<zimbraFeatureContactsEnabled>TRUE</zimbraFeatureContactsEnabled>
<zimbraExternalSharingEnabled>TRUE</zimbraExternalSharingEnabled>
<zimbraFeatureCalendarEnabled>TRUE</zimbraFeatureCalendarEnabled>
<zimbraFeatureMobileSyncEnabled>FALSE</zimbraFeatureMobileSyncEnabled>
<zimbraFeaturePop3DataSourceEnabled>TRUE</zimbraFeaturePop3DataSourceEnabled>
<zimbraFeatureExportFolderEnabled>TRUE</zimbraFeatureExportFolderEnabled>
<zimbraFeatureTasksEnabled>TRUE</zimbraFeatureTasksEnabled>
<zimbraFeatureGalAutoCompleteEnabled>TRUE</zimbraFeatureGalAutoCompleteEnabled>
<zimbraFeatureMailSendLaterEnabled>FALSE</zimbraFeatureMailSendLaterEnabled>
<zimbraFeatureImapDataSourceEnabled>TRUE</zimbraFeatureImapDataSourceEnabled>
<zimbraFeatureChangePasswordEnabled>TRUE</zimbraFeatureChangePasswordEnabled>
<zimbraFeatureMailEnabled>TRUE</zimbraFeatureMailEnabled>
<zimbraFeatureDistributionListFolderEnabled>TRUE</zimbraFeatureDistributionListFolderEnabled>
<zimbraFeatureImportFolderEnabled>TRUE</zimbraFeatureImportFolderEnabled>
<zimbraPublicSharingEnabled>TRUE</zimbraPublicSharingEnabled>
<zimbraFeatureManageZimlets>TRUE</zimbraFeatureManageZimlets>
</cos>
</Response>

7 Domain

7.1 CountObjects

Entrée:/service/domain/CountObjects/<token>

via : [GET, POST]

Sorties Valeurs Description

type

userAccount, alias, dl, calresource

Type d’objet à compter

 
https://api.partage.renater.fr/service/domain/CountObjects/<token>?type=userAccount
Sorties Valeurs Description

count

Integer

Qunatité d'élément remontés

message

Description de la réponse

status

0

Requête réussie

status

Autre

Requête échouée

type

String

userAccount, alias, dl, calresource

7.2 GetDomain

Entrée : /service/domain/GetDomain/<token>

via : [GET, POST]

https://api.partage.renater.fr/service/domain/GetDomain/<token>
Sorties Valeurs Description

can-open-account

Boolean

Autorisation à ouvrir les boites mails des utilisateurs

description

String

Description

message

Description de la réponse

name

String

Nom du domaine

page-blanche

Integer

0 : Aucune inscription, 1 : Public, 2 : Etablissement, 3 : Masqué

quota

Integer

Alias de total-storage-allocated

status

0

Requête réussie

status

Autre

Requête échouée

total-storage-allocated

Integer (Octet)

Quantité de stockage alloué au domaine

total-storage-used

Integer (Octet)

Quantité de stockage réellement utilisé

used

Integer

Alias de total-storage-used

zimbraDomainDefaultCOSId

String

Id de la classe de service par défaut du domaine

zimbraDomainStatus

String

Etat du domaine

zimbraNotes

String

Notes libres

zimbraPreAuthKey

String

Clé PréAuth du domaine

zimbraPrefTimeZoneId

String

Id de la TimeZone par défaut du domaine

zimbraPublicServiceHostname

String

Nom d’hôte du service public

zimbraPublicServiceProtocol

String

Protocole de service public

zimbraSkinLogoAppBanner

String

url d’accès à l’image

zimbraSkinLogoLoginBanner

String

url d’accès à l’image

zimbraSkinLogoURL

String

url d’accès à l’image

zimlet-plus-url

Array

Paramétrage associé au zimlet Plus

7.3 ModifyDomain

Entrée : /service/domain/ModifyDomain/<token>

via : [GET, POST]

https://api.partage.renater.fr/service/domain/ModifyDomain/<token>
Entrées Valeurs Obligatoire Description

description

String

Description du domaine

page-blanche

Integer

0 : Aucune inscription, 1 : Public, 2 : Etablissement, 3 : Masqué

zimbraDomainStatus

String (active, closed)

État du domaine

zimbraNotes

String

Notes libres

zimbraPublicServiceHostname

String

Nom d’hôte du service public

zimbraPublicServiceProtocol

String

Protocole de service public

zimbraSkinLogoAppBanner

String

url d’accès à l’image

zimbraSkinLogoLoginBanner

String

url d’accès à l’image

zimbrazimbraSkinLogoURL

String

url d’accès à l’image
Sorties Valeurs Description

message

Description de la réponse

status

0

Requête réussie

status

Autre

Requête échouée

8 Groups

8.1 AddDistributionListAlias

Entrée : /service/domain/AddDistributionListAlias/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

alias

String

oui

Alias à ajouter

name

Strng

oui

Adresse mail principale du groupe

 
https://api.partage.renater.fr/service/domain/AddDistributionListAlias/<token>?name=compte@domain.com&alias=compte2@domain.com
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Ok

Status

Autre

Ko

8.2 AddGroupMembers

Entrée : /service/domain/AddGroupMembers/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

members

Array

Liste des membres à ajouter (emails)

name

String

oui

Adresse mail principale du groupe

 
https://api.partage.renater.fr/service/domain/AddGroupMembers/<token>?name=test@domain.com&members[]=user1@domain.com&members[]=user2@domain.com&members[]=user3@domain.com
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Provisionning réussie

Status

Autre

Provisionning échouée

Remarque : Si l’adresse mail d’un membre n’est pas valide, le membre sera ignoré et ne bloquera pas l’ensemble de la requête

8.3 AddSendAsGroup

Permet d’autoriser un nouveau compte à utiliser l’adresse mail du groupe en adresse d’expédition.

Entrée : /service/domain/AddSendAsGroup/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

account

String

oui

Adresse mail du compte à autoriser

name

String

oui

Adresse mail principale du groupe

 
https://api.partage.renater.fr/service/domain/AddSendAsGroup/<token>?name=group@domain.com&account=compte@domain.com
Sortie Valeurs Description

Message

Descritpion de la réponse

Status

0

Ok

Status

Autre

Ko

8.4 CreateGroup

Entrée : /service/domain/CreateGroup/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

description

String

Description du groupe

displayName

String

Nom affiché

name

Adresse mail valide

oui

Adresse mail principale du groupe

zimbraDistributionListSendShareMessageToNewMembers

String (TRUE, FALSE)

False=groupe, true=dl

zimbraHideInGal

String (TRUE, FALSE)

Masquer le groupe dans la liste GAL

zimbraMailStatus

String (enabled, disabled)

Discriminant groupe / DL

zimbraNotes

String

Notes libres

 
https://api.partage.renater.fr/service/domain/CreateGroup/<token>?name=direction@domain.com&zimbraMailStatus=disabled
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Création réussie

Status

Autre

Création échouée

Après création du groupe, il faudra utiliser l’appel AddGroupMembers pour ajouter des membres.

8.5 DeleteGroup

Entrée : /service/domain/DeleteGroup/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

name

String

oui

Adresse mail principale du groupe à supprimer.

 
https://api.partage.renater.fr/service/domain/DeleteGroup/<token>?name=test@domain.com
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Suppression réussie

Status

Autre

Suppression échouée

8.6 DeleteSendAsGroup

Supprime l’autorisation d’un compte à utiliser l’adresse mail du groupe en adresse d’expédition.

Entrée : /service/domain/DeleteSendAsGroup/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

account

String

oui

Adresse mail du compte à supprimer

name

String

oui

Adresse mail principale du groupe

 
https://api.partage.renater.fr/service/domain/DeleteSendAsGroup/<token>?name=group@domain.com&account=compte@domain.com
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Ok

Status

Autre

Ko

8.7 GetAllGroups

Entrée : /service/domain/GetAllGroups/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

ldap_query

String

Filtre LDAP de recherche. Exemple: (!(zimbraMailStatus=enabled)).

limit

Integer

Défaut 100

maxresults

Integer

Nombre maximum d'éléments en réponse, Défaut 100

offset

Integer

Défaut 0

sortascending

Integer (0, 1)

0=desc, 1=asc

sortby

String (mail, givenName, sn, displayName)

oui

Colonne de tri

 
https://api.partage.renater.fr/service/domain/GetAllGroups/<token>?maxresults=500&offset=0&limit=500&sortBy=mail&sortascending=1
Sorties Valeurs Description

message

Description de la réponse

search-total

Nombre maximum d'éléments pour la requête

status

0

Requête réussie

status

Autre

Requête échouée

group

          id

String

Id du groupe

          description

String

Description du groupe

          name

String

Adresse email du groupe

          zimbraHideInGal

String (TRUE, FALSE)

Masquer dans la GAL

          zimbraDistributionListSendShareMessageToNewMembers

String (TRUE, FALSE)

Informer les nouveaux membres des partages du groupe par email.

          zimbraMailAlias

String

Alias du groupe

          zimbraMailStatus

String (enabled, disabled)

Discriminant groupe / DL

 
<?xml version="1.0" encoding="utf-8" ?>
<Response>
<status>1</status>
<message>Success</message>
<groups>
<group>
<name>all@domain.com</name>
<zimbraMailStatus>enabled</zimbraAccountStatus>
<displayName>Tout le monde</displayName>
</group>
<group>
...
</group>+
</groups>
</Response>

8.8 GetGroup

Entrée : /service/domain/GetGroup/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

Name

Adresse mail valide

oui

Adresse mail principale du groupe

 
https://api.partage.renater.fr/service/domain/GetGroup/<token>?name=all@domain.com
Sorties Valeurs Description

description

String

Description du groupe

displayName

String

Nom affiché

members

Array

Liste des membres (emails)

name

String

Nom principal du groupe

zimbraDistributionListSendShareMessageToNewMembers

String (TRUE, FALSE)

Lorsqu'un nouveau membre est ajouté, l'ensemble des membres sont informés par email

zimbraHideInGal

String (TRUE, FALSE)

Masquer le groupe dans la liste GAL

zimbraMailAlias

Array

Liste des alias du groupe

zimbraMailStatus

String (enabled, disabled)

Discriminant groupe / DL

zimbraNotes

String

Notes libres

 
<?xml version="1.0" encoding="utf-8" ?>
<Response>
<status>1</status>
<message>Success</message>
<group>
<name>all@domain.com</name>
<zimbraMailStatus>enabled</zimbraAccountStatus>
<displayName>Tout le monde</displayName>
…
<member>user1@domain.com</member>
<member>user2@domain.com</member>
<member>user3@domain.com</member>
</group>
</Response>

8.9 GetSendAsGroup

Permet de récupérer l’ensemble des comptes pouvant utiliser l’adresse mail du groupe en adresse d’expédition.

Entrées : /service/domain/GetSendAsGroup/<token>

via : [GET, POST]

Entrées Valeurs Obligatoire Description

name

String

oui

Adresse mail principale du groupe

 
https://api.partage.renater.fr/service/domain/GetSendAsGroup/<token>?name=group@domain.com
Sortie Valeurs Description

Accounts

Array

Liste des comptes

Message

Description de la réponse

Status

0

Ok

Status

Autre

Ko

8.10 ModifyGroup

Entrée : /service/domain/ModifyGroup/<token>

via : [GET, POST]

Dans cet appel, il est nécessaire de ne lister que les attributs que l’on veut changer

Entrées Valeurs Obligatoire Description

description

String

Description

displayName

String

Nom affiché

name

Adresse mail valide

oui

Adresse mail principale du groupe

zimbraDistributionListSendShareMessageToNewMembers

String (TRUE, FALSE)

False=groupe, true=dl

zimbraHideInGal

String (TRUE, FALSE)

Masquer dans la GAL

zimbraMailStatus

String (enabled, disabled)

Discriminant groupe/DL

zimbraNotes

String

Notes libres

 
https://api.partage.renater.fr/service/domain/ModifyGroup/<token>?name=test@domain.com&zimbraMailStatus=enabled
Sortie Valeurs Description

Message

Descritpion de la réponse

Status

0

Modification réussie

Status

Autre

Modification échouée

8.11 RemoveDistributionListAlias

Entrée : /service/domain/RemoveDistributionListAlias/<token>

via : [GET,POST]

Entrées Valeurs Obligatoire Description

alias

String

oui

Alias à supprimer

name

String

oui

Adresse mail principale du groupe

 
https://api.partage.renater.fr/service/domain/RemoveDistributionListAlias/<token>?name=compte@domain.com&alias=compte2@domain.com
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Ok

Status

Autre

Ko

8.12 RemoveGroupMembers

Entrée : /service/domain/RemoveGroupMembers/<token>

via : [GET,POST]

Entrées Valeurs Obligatoire Description

members

Array

Liste des membres à supprimer

name

String

oui

Adresse mail principale du groupe

 
https://api.partage.renater.fr/service/domain/RemoveGroupMembers/<token>?name=test@domain.com&members[]=user1@domain.com&members[]=user2@domain.com&members[]=user3@domain.com
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Provisionning réussie

Status

Autre

Provisionning échouée

Remarque : Si l’adresse mail d’un membre n’est pas valide, ou ne fait pas partie des membres du groupe, le membre sera ignoré et ne bloquera pas l’ensemble de la requête.

9 Resources

9.1 CreateResource

Entrée : /service/domain/CreateResource/<token>

via : [GET,POST]

Entrées Valeurs Obligatoire Description

co

String

Nom du pays

description

String

Description

displayName

String

oui

Nom affiché

l

String

Ville de la ressource

name

Adresse mail valide

oui

Adresse mail principale de la ressource

password

String

oui

Mot de passe en clair

postalCode

String

Code postal

st

String

État de la ressource

street

String

Rue de la ressource

userPassword

String

empreinte du mot de passe

zimbraAccountStatus

String (active, closed)

État de la ressource (défaut active)

zimbraCalResAutoAcceptDecline

String (TRUE, FALSE)

Accepte ou décline automatiquement les invitations

zimbraCalResAutoDeclineIfBusy

String (TRUE, FALSE)

Décline automatiquement les invitations si risque de conflit

zimbraCalResAutoDeclineRecurring

String (TRUE, FALSE)

Décline automatiquement les invitations récurrente

zimbraCalResBuilding

String

Bâtiment

zimbraCalResCapacity

Integer

Capacité

zimbraCalResContactEmail

String

Adresse mail du contact

zimbraCalResContactName

String

Nom du contact

zimbraCalResContactPhone

String

Téléphone du contact

zimbraCalResFloor

String

Etage

zimbraCalResLocationDisplayName

String

Nom du lieu affiché

zimbraCalResRoom

String

Salle

zimbraCalResSite

String

Lieu

zimbraCalResType

String (Location, Equipment)

oui

Type de la ressource

zimbraNotes

String

Notes libres

zimbraPrefCalendarForwardInvitesTo

Array

Faire suivre les invitations de calendrier à cette adresse

 
https://api.partage.renater.fr/service/domain/CreateResource/<token>?name=videoprojecteur@domain.com&password=secret&displayName=Video%20Projecteur
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Création réussie

Status

Autre

Création échouée

9.2 DeleteResource

Entrée : /service/domain/DeleteResource/<token>

via : [GET,POST]

Entrées Valeurs Obligatoire Descritpion

name

String

oui

Adresse mail principale de la resource à supprimer

 
https://api.partage.renater.fr/service/domain/DeleteResource/<token>?name=voiture@domain.com
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Suppression réussie

Status

Autre

Suppression échouée

9.3 GetAllResources

Entrée : /service/domain/GetAllResources/<token>

via : [GET,POST]

Entrées Valeurs Obligatoire Description

ldap_query

String

Filtre LDAP de recherche. Exemple: (zimbraCalResType=Equipment).

Limit

Integer

Défaut 100

maxresults

Integer

Nombre maximum d'éléments en réponse, Défaut 100

Offset

Integer

Défaut 0

sortascending

Integer (0, 1)

0=desc, 1=asc

sortby

String (mail, givenName, sn, displayName)

oui

Colonne de tri

 
https://api.partage.renater.fr/service/domain/GetAllResources/<token>?maxresults=500&offset=0&limit=500&sortby=mail&sortascending=1
Sorties Valeurs Description

message

Description de la réponse

search-total

Nombre maximum d'éléments pour la requête

status

0

Requête réussie

status

Autre

Requête échouée

resource

          displayName

String

Nom affiché de la ressource

          id

String

Id de la ressource

          name

String

Adresse email de la ressource

          zimbraCalResAutoAcceptDecline

String (TRUE, FALSE)

Accepte ou décline automatiquement les invitations

          zimbraCalResAutoDeclineIfBusy

String (TRUE, FALSE)

Décline automatiquement les invitations récurrente

          zimbraCalResAutoDeclineRecurring

String (TRUE, FALSE)

Décline automatiquement les invitations récurrente

          zimbraCalResType

String (Location, Equipment)

Type de la ressource

 
<?xml version="1.0" encoding="utf-8" ?>
<Response>
<status>1</status>
<message>Success</message>
<resources>
<resource>
<name>voiture@domain.com</name>
<zimbraAccountStatus>active</zimbraAccountStatus>
<displayName>Voiture Blanche</displayName>
< zimbraCalResType>Equipment</zimbraCalResType>
</resource>
<resource>
...
</resource>+
</resources>
</Response>

9.4 GetResource

Entrée : /service/domain/GetResource/<token>

via : [GET,POST]

Entrées Valeurs Obligatoire Description

Name

Adresse mail valide

Oui

Adresse mail principale de la ressource

 
https://api.partage.renater.fr/service/domain/GetResource/<token>?name=voiture@domain.com
Sortie Valeurs Description

co

String

Nom du pays

description

String

Description

displayName

String

Nom affiché

l

String

Ville de la ressource

name

Adresse mail valide

Adresse mail principale de la ressource

postalCode

String

Code postal

st

String

État de la ressource

street

String

Rue de la ressource

userPassword

String

Empreinte du mot de passe

zimbraAccountStatus

String (active, closed)

Etat de la ressource

zimbraCalResAutoAcceptDecline

String (TRUE, FALSE)

Accepte ou décline automatiquement les invitations

zimbraCalResAutoDeclineIfBusy

String (TRUE, FALSE)

Décline automatiquement les invitations si risque de conflit

zimbraCalResAutoDeclineRecurring

String (TRUE, FALSE)

Décline automatiquement les invitations récurrente

zimbraCalResBuilding

String

Bâtiment

zimbraCalResCapacity

Integer

Capacité

zimbraCalResContactEmail

String

Adresse mail du contact

zimbraCalResContactName

String

Nom du contact

zimbraCalResContactPhone

String

Téléphone du contact

zimbraCalResFloor

String

Etage

zimbraCalResLocationDisplayName

String

Nom du lieu affiché

zimbraCalResRoom

String

Salle

zimbraCalResSite

String

Lieu

zimbraCalResType

String (Location, Equipment)

Type de ressource

zimbraNotes

String

Notes libres

zimbraPrefCalendarForwardInvitesTo

Array

Faire suivre les invitaions de calendrier à cette adresse.
Politique de planning

Accepter automatiquement si l’opération est possible - Refuser automatiquement si risque de conflit

  • zimbraCalResAutoAcceptDecline: TRUE

  • zimbraCalResAutoDeclineIfBusy: TRUE

Accepter manuellement si l’opération est possible - Refuser automatiquement si risque de conflit

  • zimbraCalResAutoAcceptDecline: FALSE

  • zimbraCalResAutoDeclineIfBusy: TRUE

Toujours accepter automatiquement

  • zimbraCalResAutoAcceptDecline: TRUE

  • zimbraCalResAutoDeclineIfBusy: FALSE

Sans accepter automatiquement ni refuser automatiquement

  • zimbraCalResAutoAcceptDecline: FALSE

  • zimbraCalResAutoDeclineIfBusy: FALSE

9.5 ModifyResource

Entrée : /service/domain/ModifyResource/<token>

via : [GET,POST]

Dans cet appel, il est nécessaire de ne lister que les attributs que l’on veut changer.

Entrées Valeurs Obligatoire Description

co

String

Pays de la ressource

description

String

Description

displayName

String

Nom affiché

l

String

Ville de la ressource

name

Adresse mail valide

oui

Adresse mail principale de la ressource

postalCode

String

Code postal

st

String

État de la ressource

street

String

Rue de la ressource

userPassword

String

Empreinte du mot de passe

zimbraAccountStatus

String (active, closed)

Etat de la ressource

zimbraCalResAutoAcceptDecline

String (TRUE, FALSE)

Accepte ou décline automatiquement les invitations

zimbraCalResAutoDeclineIfBusy

String (TRUE, FALSE)

Décline automatiquement les invitations si risque de conflit

zimbraCalResAutoDeclineRecurring

String (TRUE, FALSE)

Accepte ou décline automatiquement les invitations

zimbraCalResBuilding

String

Bâtiment

zimbraCalResCapacity

Integer

Capacité

zimbraCalResContactEmail

String

Adresse mail du contact

zimbraCalResContactName

String

Nom du contact

zimbraCalResContactPhone

String

Téléphone du contact

zimbraCalResFloor

String

Etage

zimbraCalResLocationDisplayName

String

Nom du lieu affiché

zimbraCalResRoom

String

Salle

zimbraCalResSite

String

Lieu

zimbraCalResType

String (Location, Equipment)

Type de ressource

zimbraNotes

String

Notes libres

zimbraPrefCalendarForwardInvitesTo

Array

Faire suivre les invitations de calendrier à cette adresse

 
https://api.partage.renater.fr/service/domain/ModifyResource/<token>?name=voiture@domain.com&zimbraHideInGal=TRUE
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Modification réussie

Status

Autre

Modification échouée

Remarque : Pour changer le mot de passe en clair de votre ressource, vous devez utiliser l’appel SetPassword.

10 Traitement massif

L’API permettra comme pour le BSS de faire du traitement par lot en téléchargeant un fichier CSV.

Entrée : /service/domain/MassiveWorks/<token>

via : [POST]

Entrées Valeurs Obligatoire Description

File

Fichier csv

oui

Fichier à uploader

work

String

oui

Type d'éléments contenus dans le fichier.

work :

  1. accounts (Comptes utilisateurs)

  2. groups (Groupes, listes de distribution)

  3. members (Membres d’un groupe)

  4. resources (Ressources)

  5. alias

https://api.partage.renater.fr/service/domain/MassiveWorks/<token>

⇒ file : fichier csv

Sortie Valeurs Description

Message

Description de la réponse

Status

0

Provisionning réussie

Status

Autre

Provisionning échouée

Les fichiers csv doivent être structurés de la manière suivante :

La première colonne doit se nommer "action" et doit comprendre les valeurs CREATE, UPDATE ou DELETE.

La seconde colonne doit se nommer "name" et doit indiquer l’adresse mail de l'élément à manipuler.

Les colonnes suivantes doivent avoir pour nom, le nom de l’attribut Zimbra/partage que l’on veut manipuler.

La colonne password contiendra le mot de passe en clair.

La colonne userPassword contiendra l’empreinte du mot de passe.

Le changement de classe de service se fait via l’attribut zimbraCOSId.

Remarque : Le BSS dispose d’un mécanisme de verrouillage de l’appel MassiveWorks à chaque appel afin de limiter la charge sur le serveur. Ce mécanisme se déverrouille à la fin de chaque traitement pour laisser place au traitement suivant.

En cas de verrouillage de l’appel, la réponse est : "La ressource est temporairement occupée. Merci de renouveler l’opération ultérieurement". Rien ne sert de retenter l’appel trop rapidement, au-delà de 3 tentatives infructueuses, nous vous invitons à ouvrir un ticket auprès du support.

En annexe des fichiers csv d’exemple.

Vous pouvez retrouver la liste des attributs Zimbra/Partage que l’on peut appeler à l’aide des paramètres d’entrées décrits dans les appels précédents.

11 Partages

11.1 AddRootShare

Entrée : /service/domain/account/AddRootShare/<token>

via : [GET,POST]

Cet appel permet d'ajouter un partage root d'une boites de service à un ou plusieurs utilisateurs

Entrées Valeurs Obligatoire Description

account

String

oui

Adresse email du compte qui va fournir le partage root

recipients

Array

oui

Adresses email des personnes qui vont pouvoir accéder à ce partage root.

 
https://api.partage.renater.fr/service/domain/account/AddRootShare/<token>?account=balfservice@domain.com&recipients[]=user1@domain.com&recipients[]=user2@domain.com&recipients[]=user3@domain.com
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Modification réussie

Status

Autre

Modification échouée

Remarque : La création du partage root crée automatiquement un nouveau groupe sur PARTAGE qui sera nommé de la façon suivante pr_<adresse email de la boite de service>.

Vous pouvez utiliser l'appel AddRootShare pour permettre ultérieurement à un nouvel utilisateur de bénéficier du partage root.

11.2 RemoveRootShare

Entrée : /service/domain/account/RemoveRootShare/<token>

via : [GET,POST]

Cet appel permet de retirer un partage root d'une boites de service d'un ou plusieurs utilisateurs

Entrées Valeurs Obligatoire Description

account

String

oui

Adresse email du compte qui fournit le partage root

recipients

Array

oui

Adresses email des personnes à qui on retire le partage root.

 
https://api.partage.renater.fr/service/domain/account/RemoveRootShare/<token>?account=balfservice@domain.com&recipients[]=user1@domain.com&recipients[]=user2@domain.com
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Modification réussie

Status

Autre

Modification échouée

Remarque : Si on retire l'ensemble des personnes qui bénéfiaient du partage root, le groupe pr_<adresse email de la boite de service> ne sera pas supprimé.

Il n'est pas nécessaire de supprimer ce groupe.

11.3 AddRootDelegate

Entrée : /service/domain/account/AddRootDelegate/<token>

via : [GET,POST]

Cet appel permet d'ajouter aux bénéficiaires d'un partage root le droit d'envoyer des email "en tant que" et/ou "de la part de" de la boite de service source.

Entrées Valeurs Obligatoire Description

account

String

oui

Adresse email du compte qui fournit le partage root

right

String

oui

sendAs="en tant que", sendOnBehalfOf="de la part de"

 
https://api.partage.renater.fr/service/domain/account/AddRootDelegate/<token>?account=balfservice@domain.com&right=sendAs
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Modification réussie

Status

Autre

Modification échouée

11.4 RemoveRootDelegate

Entrée : /service/domain/account/RemoveRootDelegate/<token>

via : [GET,POST]

Cet appel permet de retirer aux bénéficiaires d'un partage root le droit d'envoyer des email "en tant que" et/ou "de la part de" de la boite de service source.

Entrées Valeurs Obligatoire Description

account

String

oui

Adresse email du compte qui fournit le partage root

right

String

oui

sendAs="en tant que", sendOnBehalfOf="de la part de"

 
https://api.partage.renater.fr/service/domain/account/RemoveRootDelegate/<token>?account=balfservice@domain.com&right=sendAs
Sortie Valeurs Description

Message

Description de la réponse

Status

0

Modification réussie

Status

Autre

Modification échouée