Vous êtes sur la page 1sur 27

OmniVista 8770

API de gestion des utilisateurs


Version 4.1 - Avril 2019
8AL90710FRAE Ed. 01
Mentions légales
Le nom et le logo d'Alcatel-Lucent sont des marques commerciales de Nokia utilisées sous licence par
ALE. Pour en savoir plus sur les marques utilisées par les sociétés affiliées de la Holding ALE, veuillez
consulter : www.al-enterprise.com/fr-fr/documentation-juridique/marques-copyright. Toutes les autres
marques sont la propriété de leurs titulaires respectifs.
Ni la Holding ALE ni ses sociétés affiliées ne peuvent être tenues responsables de l'éventuelle
inexactitude des informations contenues dans ce document, qui sont sujettes à modification sans
préavis.
© 2019 ALE International. Tous droits réservés. www.al-enterprise.com/fr-fr

Avertissement
Bien que des efforts aient été faits pour vérifier l'exhaustivité et l'exactitude des informations contenues
dans cette documentation, ce document est fourni « tel quel ». Pour obtenir des informations plus
précises sur l'intercompatibilité, les limites du produit, la politique logicielle et la liste des fonction,
veuillez vous référer aux documents précis publiés sur le site web Business Partner.
Dans l'intérêt du développement continu des produits, ALE International se réserve le droit d'apporter
des améliorations à ce document et aux produits qu'il décrit, à tout moment et sans préavis ni
obligation.

Le marquage CE indique que ce produit est conforme aux Directives du Conseil ssuivantes :
• 2014/53/EU pour équipement radio
• 2014/35/EU et 2014/30/EU pour les équipements autres que radio (y compris les équipements de
terminaux de télécommunication câblés)
• 2014/34/EU pour équipement ATEX
• 2011/65/UE (RoHS)
• 2012/19/EU (WEEE)
Sommaire
API de gestion des utilisateurs

Chapitre 1
Documents de référence

Chapitre 2
Présentation

2.1 Introduction.......................................................................................................................................5
2.2 Sources API fournies dans le serveur OmniVista 8770 ........................6
2.3 Utilisation de ce document................................................................................................ 6

Chapitre 3
Description détaillée

3.1 Objets API........................................................................................................................................... 8


3.1.1 Hiérarchie des objets API................................................................................................................. 8
3.1.2 Objets Schema........................................................................................................................................10
3.1.3 Objets Data............................................................................................................................................ 10
3.1.4 Objets Template...................................................................................................................................19
3.2 Ensemble des opérations prises en charge par l'API............................21
3.2.1 Présentation...........................................................................................................................................21
3.2.2 En-tête...................................................................................................................................................... 21
3.2.3 Méthode Get.......................................................................................................................................... 22
3.2.4 Méthode Create................................................................................................................................... 24
3.2.5 Méthode Update................................................................................................................................... 25
3.2.6 Méthode Delete................................................................................................................................... 25
3.3 Gestion des erreurs.................................................................................................................26
3.4 Compatibilité descendante.............................................................................................. 27

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 3/27


Chapitre

1 Documents de référence

Le tableau ci-dessous recense les documents pouvant être associés au présent document :

Titre du document Numéro de référence

[1] Manuel administrateur 8AL90703xxyy

[2] Manuel d'installation 8AL90704xxyy

[3] Guide de Sécurité 8AL90705xxyy

[4] Tickets de taxation et de statistiques VoIP 8AL90706xxyy

[5] SNMPproxy 8AL90707xxyy

[6] OpenTouch Suite - Option de taxation RTU 8AL90712xxyy

[7] API de gestion des utilisateurs 8AL90710xxyy

[8] Liste des fonctionnalités et disponibilité OmniVista 8770 8AL91400xxyy

[9] Manuel de l'administrateur OTBE/OTMS 8AL90505xxyy

[10] Guide de déploiement de serveur pour les 8AL90345xxyy


télétravailleurs qui utilisent des postes de bureau
[11] Alarmes internes OmniVista 8770 3BH290010425DTZZA
[12] Outil de planification des capacités OmniVista 8770 TBE074

Dans le présent document, les références croisées sont identifiées par le numéro figurant dans la
première colonne dans le tableau ci-dessus.
Les numéros de référence sont indiqués dans la dernière colonne, xx correspondant au code de
langue du document et yy à l'édition incrémentée du document.

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 4/27


Chapitre

2 Présentation

2.1 Introduction
L'OmniVista 8770 offre une solution API (Application Programming Interface) permettant de configurer
des utilisateurs et des équipements à partir d'applications tierces. Cette solution API est basée sur le
protocole SOAP (Simple Object Access Protocol).
L'API permet de créer, consulter, modifier ou supprimer des utilisateurs à partir d'applications tierces.
Elle concerne les utilisateurs suivants :
• Utilisateurs de base de l'annuaire de l'entreprise. Ils ne sont pas associés à un équipement et ne
sont rattachés à aucun serveur de communication (OpenTouch ou OmniPCX Enterprise).
• Utilisateurs OXE associés à un équipement déclaré dans l'OmniPCX Enterprise et n'ayant pas
accès aux applications OpenTouch.
• Utilisateurs OXE (également appelés Connection users) associés à un équipement déclaré dans
l'OmniPCX Enterprise et ayant accès aux applications OpenTouch ou aux boîtes vocales de
l'OTMC.
• Utilisateurs OT (également appelés Conversation users) associés à un équipement déclaré dans
l'OpenTouch et ayant accès ou non aux applications OpenTouch.
L'API permet également de créer des équipements et d'associer/dissocier des équipements à/d'un
utilisateur. Cela s'applique aux équipements SIP pouvant être déployés sans leur adresse MAC (auto-
assignation), applications et postes secondaires (configuration multi-équipements). Pour voir la liste
des équipements avec auto-assignation et applications, consultez le document [8].
Ces fonctions sont similaires à celles de l'application Users de l'OmniVista 8770. L'API ne permet pas
de configurer :
• les méta profils
• les équipements qui ne sont pas associés à un utilisateur
• les utilisateurs et les équipements via le provisionnement en masse
L'utilisation de l'API nécessite une licence dédiée dans l'OmniVista 8770 (appelée OpenAPI). Le statut
de la licence peut être vérifié dans le menu d'aide d'un client OmniVista 8770 (chemin d'accès : Help >
About).

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 5/27


Chapitre 2 Présentation

Requêtes HTTPS
Composant API

Application
Users
Utilisateur API Méta
profils

Serveur

Profils
OXE

OmniPCX Enterprise

Modèles
OT

OpenTouch

Figure 2.1 : Présentation d'une solution API pour la configuration d'utilisateurs et d'équipements depuis
une application tierce (utilisateur API)

Les données échangées avec des applications tierces sont cryptées en HTTPS. Chaque requête
HTTPS est authentifiée à l'aide d'un compte administrateur OmniVista 8770 dédié (identifiant et mot de
passe) créé lors de l'installation du serveur OmniVista 8770.
Le nombre de transactions réalisées en parallèle depuis différentes applications tierces via cette API
est limité par un paramètre de configuration de l'application LDAP (chemin d'accès dans l'application
Administration de l'OmniVista 8770 : nmc > Application Configuration > Applications Settings >
OpenApiManagement > OpenApi). Le serveur maître doit être redémarré pour appliquer la
modification. Par défaut, le nombre maximum de transactions parallèles est de 5. Lorsque la limite est
dépassée, la transaction qui suit est rejetée et le message d'erreur ci-après s'affiche : Too many
parallel requests.

2.2 Sources API fournies dans le serveur OmniVista 8770


Toutes les sources API sont fournies dans le serveur OmniVista 8770 (chemin d'accès : /8770/
client/data/import). Le fichier openapisamplelient.zip contient les sources pour un
exemple, un wsdl et un xsd.

2.3 Utilisation de ce document


Ce document fournit des détails sur :
• Les objets API modifiables depuis un client API et leur hiérarchie
• L'ensemble des opérations prises en charge par l'API

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 6/27


Chapitre 2 Présentation

Ce document ne contient aucune information sur l'installation ou l'administration de l'OmniVista 8770 et


ne fournit aucune description du client API.

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 7/27


Chapitre

3 Description détaillée

3.1 Objets API


3.1.1 Hiérarchie des objets API
Les données renvoyées par l'API sont incluses dans des objets définis dans la hiérarchie ci-dessous.

Schéma

OV8770 Données Utilisateur Equipement

Méta profil

Modèle

Modèle
d'équipement

Légende :

<OV8770 noInstance> Dossier vide


<Schema/>
<Data noInstance>
Dossier avec
<User> exemple
<Device/>
</User>
</Data>
<Template noInstance>
<MetaProfile/>
<DeviceTemplate/>
</Template>
</OV8770>

Figure 3.1 : Hiérarchie des objets API

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 8/27


Chapitre 3 Description détaillée

Le tableau ci-dessous présente la hiérarchie des objets de données (également appelés ressources)
renvoyés par l'API :

tableau 3.1 : Hiérarchie des objets de données

Hiérarchie Ressource

/ov8770 Hiérarchie Ov8770

/ov8770/schema Schéma

/ov8770/schema/user Schéma d'utilisateur

/ov8770/schema/device Schéma d'équipement

/ov8770/schema/metaprofile Schéma de méta profil

/ov8770/schema/devicetemplate Schéma de modèle d'équipement

/ov8770/schema/listresult Liste de résultats


Note :
Description de la liste des résultats (schéma) renvoyée
par une opération Get.

/ov8770/data/users Utilisateurs

/ov8770/data/users/{UID} Utilisateur avec uid={UID}


où {UID} correspond à un nom d'utilisateur

/ov8770/data/users/{UID}/devices Équipements associés à un utilisateur avec


uid={UID}
où {UID} correspond à un nom d'utilisateur

/ov8770/data/users/{UID}/devices/ Équipement avec directorynumber= {directo-


{directorynumber} rynumber}
où {directorynumber} correspond au numéro
d'annuaire de l'équipement

/ov8770/templates/metaprofiles Méta profils d'utilisateur

/ov8770/templates/metaprofiles/{cn} Méta profil d'utilisateur avec cn={cn}


où {cn} correspond à un nom de méta profil

/ov8770/templates/devicetemplates Modèles d'équipement OpenTouch

/ov8770/templates/devicetemplates/ Modèle d'équipement OpenTouch avec ldap


{dn} Dn={dn}
où {dn} correspond à un nom distinctif de modè-
le d'équipement

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 9/27


Chapitre 3 Description détaillée

3.1.2 Objets Schema


Une instance de schéma listée dans la hiérarchie est un fichier XML qui définit les paramètres d'un
objet renvoyé par l'API.
Par exemple, le schéma d'utilisateur fournit la description des paramètres de l'utilisateur.
Note :
Le flux XML est conforme au format GMI défini dans gmi.xsd.

3.1.3 Objets Data


3.1.3.1 Présentation
Cette section fournit des informations détaillées sur le contenu d'une définition de schéma suite à une
requête Get (/ov8770/schema/xxx).

3.1.3.2 Usager
Les utilisateurs peuvent être des utilisateurs OT (également appelés Conversation users), des
utilisateurs OXE ou des utilisateurs OXE ayant accès à des applications OpenTouch ou OTMC
(également appelés Connection users). Ils sont déclarés dans l'OmniVista 8770 et dans les nœuds
correspondants (OmniPCX Enterprise, OpenTouch et/ou OTMC) auxquels ils sont associés.
Lors de la création d'un utilisateur à l'aide d'un méta profil, un ou plusieurs équipements peuvent
également être créés et associés à cet utilisateur.
La manière dont un équipement est associé à un utilisateur lors de la création d'un utilisateur diffère
selon le type d'utilisateur : Connection ou Conversation.
Pour Connection users, le choix d'associer ou non un équipement de type donné est effectué en
assignant un profil d'équipement (pour softphone ou mobile) ou un type de poste (pour un poste DECT
secondaire) dans la demande de création d'un utilisateur. Les numéros d'annuaire des équipements
associés sont automatiquement calculés à partir des paramètres définis dans le méta profil sélectionné
ou expressément indiqués dans la demande de création d'un utilisateur.
Pour Conversation users, le méta profil sélectionné détermine expressément le ou les équipements
(depuis les types poste de bureau ou softphone uniquement) à associer à l'utilisateur.
Les paramètres utilisateurs renvoyés par l'API sont listés dans le tableau ci-dessous. Les autres
paramètres sont inclus dans des méta profils et/ou conservent leurs valeurs par défaut.

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 10/27


Chapitre 3 Description détaillée

Attribut Accès Filtrage Description Remarques

directoryhierarchy WCREATE_RUP- N Hiérarchie d'an- Obligatoire pour l'opération


DATE nuaire OmniVista Create. Non modifiable.
8770 dans laquelle
Attribut défini dans la base
l'utilisateur est créé
de données LDAP OmniVista
(correspond à l'at-
8770 par l'administrateur
tribut DN existant
OmniVista 8770 ou par l'ad-
dans LDAP)
ministrateur client à l'aide du
protocole LDAP standard.
Les valeurs peuvent être ob-
tenues par le biais d'une re-
quête LDAP. L'API ne fournit
aucune valeur. Si une valeur
est spécifiée, elle doit exister
dans l'OmniVista 8770.

uid READWRITE O Identifiant utilisa- Obligatoire pour les opéra-


teur (unique pour tions Get (utilisant un ID),
une instance) Update et Delete.
Optionnel pour l'opération
Create. Il peut être modifié
lors de l'opération Update.

sn READWRITE O Nom de l'utilisateur Obligatoire pour l'opération


(correspond à l'at- Create.
tribut SN existant
Optionnel pour l'opération
dans LDAP)
Update.

givenname READWRITE O Prénom de l'utilisa-


teur (correspond à
l'attribut givenNa-
me existant dans
LDAP)

login WCREATE_RUP- N Nom de connexion Si aucune valeur n'est saisie,


DATE de l'utilisateur le nom de connexion est gé-
néré selon une règle de créa-
tion de nom de connexion
définie dans le méta profil et
l'OmniVista 8770

Civilité READWRITE O Titre de l'utilisateur Obligatoire pour l'opération


Create lorsque des méta
profils sont utilisés.
Optionnel pour l'opération
Update.
La valeur est incluse dans le
XSD.

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 11/27


Chapitre 3 Description détaillée

Attribut Accès Filtrage Description Remarques

courrier READWRITE O Identifiant de mes- Obligatoire pour l'opération


sagerie électroni- Create lorsque des méta
que de l'utilisateur profils sont utilisés.
(correspond à l'at-
La messagerie électronique
tribut mail existant
de l'utilisateur peut être modi-
dans LDAP)
fiée pour les utilisateurs d'an-
nuaire entreprise de base et
les utilisateurs OXE.

TelephoneNumber WCREATE_RUP- O Numéro d'annuaire Optionnel, sera dérivé si au-


DATE de l'utilisateur. cune valeur n'est fournie

MetaProfile WCREATE_RUP- N Nom du méta profil Optionnel pour les opérations


DATE appliqué à l'utilisa- Create, Update et Get.
teur
Note :
Bien qu'il soit optionnel pour
l'opération Create, un méta
profil doit être utilisé pour créer
un utilisateur OXE, un utilisateur
Connection ou un utilisateur
Conversation. Sans méta profil,
seuls les utilisateurs d'annuaire
entreprise de base peuvent être
créés.

Noeud READONLY N Nom du nœud sur Applicable à l'opération Get


lequel l'utilisateur uniquement. Concerne le
est créé. nœud principal sur lequel
l'utilisateur est créé (nœud
OmniPCX Enterprise ou
OpenTouch)

GUIPassword WRITEONLY* N Mot de passe d'au- Optionnel pour les opérations


thentification utilisé Create, Update et Get.
pour accéder aux Cette valeur annule et rem-
applications GUI. place la valeur définie dans
un méta profil.

TUIPassword WRITEONLY N Mot de passe d'au- Optionnel pour les opérations


thentification utilisé Create, Update et Get.
pour accéder aux Cette valeur annule et rem-
applications TUI. place la valeur définie dans
un méta profil.

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 12/27


Chapitre 3 Description détaillée

Attribut Accès Filtrage Description Remarques

CostCentername READWRITE O Centre de coûts Optionnel pour les opérations


auquel l'utilisateur Create, Update et Get.
appartient. Utilisé à Cette valeur annule et rem-
des fins de comp- place la valeur définie dans
tabilité. un méta profil.
La valeur doit avoir été confi-
gurée au préalable sur le
nœud OmniPCX Enterprise.

Devicekey WCREATE_RUP- N Device key Applicable à l'opération


DATE Create uniquement si un
méta profil est utilisé et intè-
gre un modèle d'équipement.
L'OmniVista 8770 fournit la
valeur par défaut.

Devicepassword WRITEONLY N Mot de passe de Applicable à l'opération


l'équipement. Create uniquement si un
méta profil est utilisé et intè-
gre un modèle d'équipement.
L'OmniVista 8770 fournit la
valeur par défaut.

DeviceType WCREATE_RUP- N Type d'équipement Applicable uniquement lors-


DATE associé à l'utilisa- que des méta profils sont uti-
teur. lisés. Cette valeur annule et
remplace la valeur définie
dans un méta profil.
Note :
La liste des valeurs applicables
est fournie dans la
documentation de l'API et dans
le XSD.

DeviceDirectory- WCREATE_RUP- N Numéro d'annuaire Facultatif. Applicable unique-


Number DATE du poste de bureau ment pour Conversation
SIP users. Dérivé d'un méta profil
si aucune valeur n'est four-
nie.

ClientId WCREATE_RUP- O Identifiant client Optionnel. Cette valeur est


DATE défini lors de la définie par défaut sur Ope-
création de l'utilisa- nAPI.
tion

keyProfile READWRITE N Touches de fonc- Facultatif


tions prédéfinies
programmées sur
l'équipement

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 13/27


Chapitre 3 Description détaillée

Attribut Accès Filtrage Description Remarques

gsmNumber WCREATE_RUP- N Numéro GSM du Optionnel (si fourni, OTC


DATE OTC smartphone smartphone est entièrement
associé à un utili- créé sur les nœuds Om-
sateur Connection niPCX Enterprise/Open-
Touch, y compris l'extension
à distance associée sur Om-
niPCX Enterprise, dans le
cas contraire il est partielle-
ment créé sur le nœud
OpenTouch uniquement)

otMobileDevicePr READWRITE N Profil de terminal Optionnel (si fourni, OTC


ofile de téléphone smartphone est créé avec
mobile OT utilisé des paramètres
pour associer un d'équipement
OTC smartphone à supplémentaires, tels que OT
un utilisateur device directory number,
Connection Remote extension number
et System speed dial
number, dans le cas
contraire il n'est pas créé).
otDeviceDirectory WCREATE_RUPD N Numéro d'annuaire Optionnel (dérivé d'un méta
Number ATE du OTC profil si aucune valeur n'est
smartphone fournie)
associé à un
utilisateur
Connection
remoteExtensionN WCREATE_RUPD N Numéro du poste Optionnel (dérivé d'un méta
umber ATE distant utilisé pour profil si aucune valeur n'est
associer le OTC fournie)
smartphone au
poste bureau
principal de
l'utilisateur
Connection
(configuration
poste tandem/
multi-équipements)
abbreviatedNumb WCREATE_RUPD N Numéro abrégé Optionnel (dérivé d'un méta
er ATE utilisé lorsque le profil si aucune valeur n'est
OTC smartphone fournie)
fonctionne en
cellulaire
uniquement (avec
numéro GSM) ou
en bimode
(cellulaire/Wi-Fi).

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 14/27


Chapitre 3 Description détaillée

Attribut Accès Filtrage Description Remarques

mainDeviceTempl READWRITE N Profil d'équipement Optionnel (applicable


ate utilisé pour uniquement pour OTC PC et
déclarer un postes de bureau SIP).
équipement SIP en
tant que poste de
bureau principal
d'un utilisateur
OXE/Connection
avec le type
d'équipement
défini sur SIP
extension
softphoneProfile WCREATE_RUPD N Profil d'équipement Optionnel (applicable
ATE utilisé pour uniquement pour OTC PC).
déclarer un OTC
PC en tant que
poste secondaire
d'un utilisateur
Connection.
softphoneOxeProf WCREATE_RUPD N Profil d'utilisateur Optionnel (si fournie, cette
ile ATE OXE utilisé pour valeur annule et remplace la
créer valeur définie dans un méta
l'hébergement profil. Si elle n'est pas fournie
d'extension et si le méta profil ne contient
secondaire OTC aucun profil utilisateur OXE
PC. dans les paramètres OTC
PC, la création d'une
extension secondaire a lieu
avec les valeurs OXE par
défaut).
softphonedeviceDi WCREATE_RUPD N Numéro d'annuaire Optionnel (s'il n'est pas
rectoryNumber ATE de l'OTC PC fourni, le numéro d'annuaire
associé à un de l'OTC PC est généré à
utilisateur partir du méta profil).
Connection ou
Conversation.
dectStationType WCREATE_RUPD N Type de poste du Optionnel (si fourni, un
ATE combiné DECT combiné DECT est ajouté en
déclaré en tant que tant que poste secondaire).
poste secondaire
d'un utilisateur
OXE/Connection.

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 15/27


Chapitre 3 Description détaillée

Attribut Accès Filtrage Description Remarques

dectProfile WCREATE_RUPD N Profil d'utilisateur Optionnel (si fournie, cette


ATE OXE utilisé pour valeur annule et remplace la
créer le combiné valeur définie dans un méta
DECT. profil. Si elle n'est pas fournie
et si le méta profil ne contient
aucun profil utilisateur OXE
dans les paramètres DECT,
le combiné DECT est créé
avec les valeurs OXE par
défaut).
dectDirectoryNum WCREATE_RUPD N Numéro d'annuaire Optionnel (s'il n'est pas
ber ATE du combiné DECT fourni, le numéro d'annuaire
du combiné DECT est
généré à partir du méta
profil).

Accès WRITEONLY : Concerne les attributs tels que les mots de passe. L'opération Get ne renvoie
aucune valeur pour cet attribut ou renvoie une valeur de type ********.
Accès WCREATE_RUPDATE : La valeur de l'attribut correspondant ne peut être spécifiée que lors de
l'opération Create (non applicable à l'opération Update).

3.1.3.3 Device [Appareil]


Les équipements ne peuvent être créés que s'ils sont associés à un utilisateur. Dans un contexte API,
les équipements sont créés et associés à un utilisateur par le biais de méta profils. L'API prend en
charge la création de tous les équipements à l'exception de ceux qui ne peuvent pas être déployés
sans adresse MAC et de ceux déclarés en tant que postes secondaires (configuration multi-
équipements).
Un nouvel équipement peut être créé et associé à l'utilisateur au moment de la création de l'utilisateur,
ou à tout moment après la création de l'utilisateur.
L'API prend en charge uniquement l'opération de mise à jour pour les postes secondaires. Celle-ci se
limite à la mise à jour de l'attribut deviceTemplate. Si cette mise à jour passe d'une valeur vide à
une autre valeur, un équipement SIP est associé à l'extension SIP secondaire. Si cette mise à jour
passe d'une valeur à une valeur vide, les paramètres SIP sont supprimés de l'extension SIP
secondaire.
Les paramètres de l'équipement renvoyés par l'API sont listés dans le tableau ci-dessous. Les autres
paramètres sont inclus dans des modèles d'équipement et/ou conservent leurs valeurs par défaut.

Attribut Accès Filtrage Description Remarques

DeviceId READONLY O Identifiant de l'équipe- Pour l'opération Create, la valeur


ment (unique pour sera dérivée.
une instance)

DeviceType READONLY O Type d'équipement Dérivé du modèle d'équipement,


applicable uniquement à l'opération
Get

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 16/27


Chapitre 3 Description détaillée

Attribut Accès Filtrage Description Remarques

directoryNumber WCREATE O Numéro d'annuaire de Obligatoire pour les opérations Get


l'équipement et Delete.
Optionnel pour l'opération Create
(voir la remarque ci-dessous) :
• Si cet attribut est vide ou
correspond au numéro
d'annuaire principal de
l'utilisateur, un équipement SIP
est créé en tant que poste de
bureau principal de l'utilisateur.
Dans ce cas, une valeur doit
également être renseignée pour
l'attribut deviceTemplate.
• Si une valeur est assignée à cet
attribut et si elle diffère du
numéro d'annuaire principal de
l'utilisateur, un poste secondaire
est ajouté à l'utilisateur avec le
type défini par
OXEStationType (tous les
types possibles, y compris
l'extension SIP). Si
OXEStationType correspond
à l'extension SIP et si une
valeur est assignée à
deviceTemplate, un
équipement SIP est également
associé à la nouvelle extension
secondaire ajoutée.

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 17/27


Chapitre 3 Description détaillée

Attribut Accès Filtrage Description Remarques

DeviceTemplate READWRITE N Modèle à utiliser pour Pour l'opération Create :


attribuer des paramè-
• Si cet attribut est vide ou
tres prédéfinis à l'équi-
correspond au numéro
pement SIP.
d'annuaire principal de
l'utilisateur (et si
deviceFreeNumberRange est
vide), un équipement SIP est
créé en tant que poste de
bureau principal de l'utilisateur,
à condition que le type
d'extension principal soit
extension SIP.
• Si une valeur est assignée à cet
attribut et si celle-ci est
différente du numéro d'annuaire
principal de l'utilisateur (ou si
une valeur est assignée à
deviceFreeNumberRange),
une deuxième extension SIP est
ajoutée avec l'association
d'équipement SIP (poste de
bureau SIP ou OTC PC)
L'opération de mise à jour s'ap-
plique uniquement aux extensions
secondaires. Si cette mise à jour
passe d'une valeur vide à une autre
valeur, un équipement SIP est as-
socié à l'extension SIP secondaire.
Si cette mise à jour passe d'une va-
leur à une valeur vide, les paramè-
tres SIP sont supprimés de l'exten-
sion SIP secondaire.

Devicekey WCREATE N Clé d'équipement de- Défini sur le numéro d'annuaire de


mandée lorsqu'un utili- l'équipement si ce champ n'est pas
sateur se connecte renseigné.
pour la première fois
Optionnel pour l'opération Get.
au poste (nom de con-
nexion).

Devicepassword WRITEONLY N Mot de passe de Défini sur le numéro d'annuaire de


l'équipement deman- l'équipement si ce champ n'est pas
dé lorsqu'un utilisateur renseigné.
se connecte pour la
Optionnel pour l'opération Get.
première fois au poste
(saisie du mot de pas-
se).

deviceFreeNum- WCREATE N Plage de numéros li- Optionnel (voir la remarque ci-des-


berRange bres utilisée pour four- sous).
nir un numéro d'an-
nuaire disponible à
l'équipement.

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 18/27


Chapitre 3 Description détaillée

Attribut Accès Filtrage Description Remarques

gsmNumber WCREATE N Numéro GSM du OTC Attribut optionnel pour OTC


smartphone associé à smartphone (OpenTouch version
un utilisateur logicielle 13 ou supérieure)
Connection
remoteExtensionN WCREATE N Numéro du poste Attribut obligatoire pour OTC
umber distant utilisé pour smartphone (OpenTouch version
associer le OTC logicielle 13 ou supérieure)
smartphone au poste
bureau principal de
l'utilisateur Connection
(configuration poste
tandem/multi-
équipements)
abbreviatedNumb WCREATE N Numéro abrégé utilisé Attribut optionnel pour OTC
er lorsque le OTC smartphone (OpenTouch version
smartphone logicielle 13 ou supérieure)
fonctionne en
cellulaire uniquement
(avec numéro GSM)
ou en bimode
(cellulaire/Wi-Fi).
OXEStationType WCREATE_RUPD N Type d'extension Obligatoire pour créer un poste
ATE utilisé pour créer le secondaire (le numéro d'annuaire
poste secondaire d'un du poste secondaire est défini par
utilisateur OXE/ l'attribut directoryNumber (si
Connection configuré) ou calculé à partir de
l'attribut
deviceFreeNumberRange (valeur
OX)).
OXEProfile WCREATE_RUPD N Profil d'utilisateur OXE Optionnel (si laissé vide, le poste
ATE utilisé pour créer le secondaire est créé avec les
poste secondaire. valeurs par défaut)

Note :
Lorsqu'un équipement est créé pour un utilisateur, son numéro d'annuaire est attribué comme suit :
1. Utilisation de la valeur directoryNumber indiquée dans les données d'entrée de l'équipement si cette valeur est
définie. Dans le cas contraire :
2. Récupération d'un DirectoryNumber dans la plage deviceFreeNumberRange si cette plage est définie. Dans le
cas contraire :
3. Récupération d'un DirectoryNumber dans la plage user.metaprofile.deviceFreeNumberRange si cette plage est
définie. Dans le cas contraire :
4. Erreur. Impossible d'obtenir un directoryNumber.

3.1.4 Objets Template


3.1.4.1 Méta-profil
Les méta profils contiennent les paramètres nécessaires à la création des utilisateurs OT ou OXE. Les
méta profils simplifient la création d'utilisateurs : ils évitent la tâche fastidieuse de saisie des
paramètres un à un pour chaque utilisateur. Les paramètres sont complétés par les valeurs définies
dans le méta profil sélectionné.

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 19/27


Chapitre 3 Description détaillée

Les méta profils peuvent également contenir des profils OmniPCX Enterprise et des modèles
OpenTouch créés sur leurs nœuds respectifs et récupérés par l'OmniVista 8770 après une
synchronisation.
Les méta profils ne peuvent pas être configurés par le biais d'une API. Ils doivent être créés et
configurés à l'aide de l'application Users de l'OmniVista 8770.
Contrairement aux méta profils utilisés pour les Conversation users, les méta profils pour les
Connection users ne déterminent pas les types d'équipement qui seront associés à l'utilisateur lors de
la création d'un utilisateur, mais définissent uniquement les règles de calcul automatique des numéros
d'annuaire, selon le type d'équipement. La sélection des équipements à associer à un utilisateur en
cours de création est effectuée en assignant un profil d'équipement dans la demande de création d'un
utilisateur.
L'API ne peut renvoyer qu'un sous-ensemble minimal de paramètres de méta profil via l'opération Get
(voir : Méthode Get à la page 22). Les paramètres de méta profil renvoyés par l'API sont les suivants :

Attribut Accès Filtrage Description Remarques

cn READONLY O Nom du méta profil À spécifier dans l'objet


(correspond à l'attri- User lors de la création.
but cn existant dans
LDAP)

Description READONLY N Description du méta Pour information seule-


profil. ment.

UserType READONLY N Type d'utilisateur Utilisateur OXE ou OT.

NodeDN READONLY O Le Distinguished Na- Nœud OmniPCX Enter-


me LDAP du nœud prise ou OpenTouch
principal sur lequel
l'utilisateur doit être
créé.

devicetemplate READONLY N Device template Modèle utilisé pour


créer et associer un
équipement à l'utilisa-
teur

3.1.4.2 Device template


Les modèles d'équipement contiennent une liste de paramètres prédéfinis permettant de créer et
d'associer un équipement aux utilisateurs OT lors de leur création.
Les modèles d'équipement ne peuvent pas être configurés par le biais d'une API. Ils doivent être créés
sur leurs nœuds respectifs et récupérés par l'OmniVista 8770 après une synchronisation.
L'API ne peut renvoyer qu'un sous-ensemble minimal de paramètres de modèle d'équipement via
l'opération Get (voir : Méthode Get à la page 22). Les paramètres de modèle d'équipement renvoyés
par l'API sont les suivants :

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 20/27


Chapitre 3 Description détaillée

Attribut Accès Filtrage Description Remarques

cn READONLY O Nom du modèle À spécifier dans l'ob-


d'équipement jet Device lors de la
(correspond à l'at- création.
tribut cn existant
dans LDAP)

modelName Nom du modèle


de l'équipement
(c'est-à-dire type
d'équipement)

Description READONLY N Description du Pour information


modèle d'équipe- seulement.
ment

NodeDN READONLY O Le Distinguished Nœud OpenTouch


Name LDAP du
nœud principal
sur lequel l'équi-
pement doit être
créé.

3.2 Ensemble des opérations prises en charge par l'API


3.2.1 Présentation
L'API prend en charge les opérations suivantes (également appelées méthodes) :
• Get (hiérarchie, donnée)
• Create (hiérarchie, donnée)
• Update (hiérarchie, donnée)
• Delete (hiérarchie)
Où :
• hierarchy est une chaîne URI (Uniform Resource Identifier) utilisée pour identifier un objet
• data est une chaîne qui peut être vierge (nulle), une chaîne de filtre LDAP ou une chaîne au format
XML.
Note :
La chaîne XML est conforme au format GMI défini dans gmi.xsd.
• La notation xxx> indique que des valeurs doivent être saisies pour l'attribut de la clé xxx.

3.2.2 En-tête
La zone d'en-tête de chaque transaction doit inclure les valeurs/attributs suivants :
• Nom de connexion (compte administrateur créé au préalable dans l'OmniVista 8770)
• Mot de passe (mot de passe associé au nom de connexion de l'administrateur, défini au préalable
dans l'OmniVista 8770)

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 21/27


Chapitre 3 Description détaillée

• Identification client (texte ASCII enregistré dans l'OmniVista 8770). Cet attribut peut également être
utilisé pour effectuer des recherches à partir de l'API. Si aucune valeur n'est spécifiée, la valeur est
définie par défaut sur OpenAPI.
• Remarques client (optionnel) : il s'agit d'un texte libre permettant aux utilisateurs finaux d'identifier
leurs opérations. La valeur n'est pas enregistrée dans l'OmniVista 8770, mais apparaît dans les
entrées du fichier journal.

3.2.3 Méthode Get


La méthode Get est utilisée généralement pour l'opération suivante :

Syntax Informations fournies Commentaires

Get (hierarchy, null) Renvoie la ou les instances Syntaxe générale


d'objet spécifiées dans la hié-
rarchie.

Get (hierarchy, filter) Renvoie tous les ID d'objet spé- Seuls les ID d'objet sont renvoyés
cifiés dans la hiérarchie et cor- lors de l'opération de recherche.
respondant aux critères de fil- Le critère de recherche doit être
trage. indiqué dans la syntaxe LDAP
standard.

Note :

• Pour toutes les opérations Get susceptibles de renvoyer des items multiples, le nombre maximal de résultats
de recherche est prédéfini dans l'OmniVista 8770 mais peut être modifié.
• Si la recherche n'aboutit qu'à un seul résultat, les données renvoyées sont les données XML de cet objet.
• Si la recherche aboutit à plusieurs résultats, les données renvoyées sont les données XML au format
listResult.
Le tableau ci-dessous répertorie les chaînes de hiérarchie et les filtres disponibles pouvant être
appliqués à la méthode Get. Dans le tableau, une cellule vide indique qu'aucun filtre n'est disponible
pour cette méthode Get.

tableau 3.2 : Utilisations possibles de la méthode Get

Hiérarchie Filtrage Résultat

/ov8770 Hiérarchie Ov8770

/ov8770/schema Liste de schémas

/ov8770/schema/user Schéma d'utilisateur

/ov8770/schema/device Schéma d'équipement

/ov8770/schema/metapro- Schéma de méta profil


file

/ov8770/schema/device- Schéma de modèle d'équipement


template

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 22/27


Chapitre 3 Description détaillée

Hiérarchie Filtrage Résultat

/ov8770/schema/listre- Schéma de liste de résultats


sult

/ov8770/data/users Chaîne de filtre de re- Dans l'exemple fourni, l'API renvoie la


cherche LDAP valide. liste des UID des utilisateurs dont le
nom commence par un A et le prénom
Par exemple :
commence par un L.
&(sn=A*)(gi venna-
me=L *) Si un seul utilisateur correspond à ces
critères, les données de cet utilisateur
sont renvoyées.
Exception en cas de filtre nul ou invali-
de.

/ov8770/data/users/{UID} Données de l'utilisateur uid={UID}


où {UID} correspond à un nom d'utili-
sateur

/ov8770/data/users/ Liste des équipements associés à l'utili-


{UID}/devices sateur avec uid={UID}
où {UID} correspond à un nom d'utili-
sateur

/ov8770/data/users/ Données d'un équipement avec directo-


{UID}/devices/{directo- rynumber={directorynumber} et as-
rynumber} socié à un {UID}
où {directorynumber} correspond
au numéro d'annuaire de l'équipement

/ov8770/templates/meta- Chaîne de filtre de re- Liste de tous les méta profils.


profiles cherche LDAP valide.
Par exemple : cn=A*

/ov8770/templates/meta- Données des méta profils avec


profiles/{cn} cn={cn}
où {cn} correspond à un nom de méta
profil

/ov8770/templates/devi- Chaîne de filtre de re- Liste de tous les modèles d'équipement


cetemplates cherche LDAP valide. OpenTouch
Par exemple : cn=A*

/ov8770/templates/devi- Données du modèle d'équipement


cetemplates/{dn} OpenTouch avec ldapDn={dn}
où {dn} correspond à un nom distinctif
de modèle d'équipement

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 23/27


Chapitre 3 Description détaillée

3.2.4 Méthode Create


La méthode Create est utilisée généralement pour l'opération suivante :

Syntax Informations fournies Commentaires

Create (hierarchy, data Crée la ou les instances d'objet


in XML format) spécifiées dans la hiérarchie.

Le tableau ci-dessous répertorie les chaînes de hiérarchie disponibles pouvant être appliquées à la
méthode Create.

tableau 3.3 : Utilisations possibles de la méthode Create

Hiérarchie Résultat

Create(/ov8770/data/users, data Crée un utilisateur avec les valeurs spécifiées dans les
in XML format) données d'entrée au format XML (peuvent inclure des
données sur l'équipement et la boîte vocale). L'utilisa-
teur est créé dans l'OmniVista 8770 et dans les nœuds
correspondants (OmniPCX Enterprise, OpenTouch
et/ou OTMC) auxquels il est associé. Les équipements
sont créés et associés à l'utilisateur, et des fichiers de
configuration sont créés pour la mise en service de
l'équipement.

Create (/ov8770/data/users/{UID}/ Crée un équipement SIP ou un équipement secondaire


devices, data in XML format) avec les valeurs spécifiées dans les données d'entrée
au format XML et associe cet équipement à l'utilisateur
dont uid={UID}.
La méthode Create appliquée aux équipements est
utilisée pour :
• associer un équipement SIP (y compris un OTC
PC) en tant que poste de bureau principal à
l'utilisateur (directoryNumber peut être laissé
vide ou correspondre au numéro d'annuaire
principal de l'utilisateur) ;
• ajouter un OTC smartphone à un utilisateur
Connection ;
• ajouter un poste secondaire (avec association
possible d'un équipement SIP), y compris un OTC
PC secondaire.
La méthode Create n'est pas utilisée pour associer
un équipement SIP à une extension (SIP) secondaire.
Cette opération doit être effectuée via la méthode Up-
date.

Note :

• L'opération Create est prise en charge uniquement pour les objets User ou les objets Device associés aux
utilisateurs.

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 24/27


Chapitre 3 Description détaillée

• L'opération Create ne prend pas en charge la réussite partielle comme le ferait le client OmniVista 8770.
• Seuls des équipements SIP avec une auto-assignation ou des applications peuvent être créés. Pour voir la
liste des équipements auto-provisionnés et applications, consultez le document [8].

3.2.5 Méthode Update


La méthode Update est utilisée généralement pour l'opération suivante :

Syntax Informations fournies Commentaires

Update (hierarchy, data Met à jour l'instance d'objet


in XML format) spécifiée dans la hiérarchie.

Le tableau ci-dessous répertorie les chaînes de hiérarchie disponibles pouvant être appliquées à la
méthode Update.

tableau 3.4 : Utilisations possibles de la méthode Update

Hiérarchie Résultat

Update(/ov8770/data/users/{UID}, Met à jour les paramètres de l'utilisateur avec les va-


data in XML format) leurs spécifiées dans les données d'entrée au format
XML.

Update(/ov8770/data/users/ {UID}/ Met à jour l'équipement avec les valeurs spécifiées


devices/{directorynumber}, data dans les données d'entrée au format XML. Cela
in XML format) s'applique uniquement aux extensions (SIP)
secondaires. Cette méthode est utilisée pour associer
ou dissocier un équipement SIP d'une extension (SIP)
secondaire en mettant à jour l'attribut
deviceTemplate.

Note :

• L'opération Update est uniquement possible pour les objets User et les extensions SIP secondaires.
• L'opération Update ne prend pas en charge la réussite partielle comme le ferait le client OmniVista 8770.
• Les données au format XML utilisées pour la mise à jour ne doivent contenir que les attributs et les valeurs à
mettre à jour. Concernant l'attribut MetaProfile, si les données d'entrée XML ne contiennent aucune
valeur pour l'attribut metaProfile, l'utilisateur est converti en utilisateur de base de l'annuaire d'entreprise.
Si les données d'entrée XML contiennent un attribut (autre que l'attribut metaprofile) sans valeur, la valeur
de l'attribut sera supprimée.

3.2.6 Méthode Delete


La méthode Delete est utilisée généralement pour l'opération suivante :

Syntax Informations fournies Commentaires

Delete (hierarchy) Supprime l'instance d'objet spé-


cifiée dans la hiérarchie et ses
objets associés.

Le tableau ci-dessous répertorie les chaînes de hiérarchie disponibles pouvant être appliquées à la
méthode Delete.

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 25/27


Chapitre 3 Description détaillée

tableau 3.5 : Utilisations possibles de la méthode Delete

Hiérarchie Résultat

Delete(/ov8770/data/users/{UID}) Supprime l'utilisateur avec uid={UID} et les équipe-


ments associés.

Delete(/ov8770/data/users/{UID}/ Dissocie l'équipement avec directorynumber={direc-


devices/{directorynumber}) torynumber} de l'utilisateur ayant un uid={UID}, et
supprime l'équipement de l'OmniVista 8770 et des
nœuds correspondants de l'équipement.
La méthode Delete appliquée aux équipements est
utilisée pour :
• supprimer les paramètres SIP de l'extension
principale de l'utilisateur ;
• supprimer totalement l'OTC smartphone ;
• supprimer totalement un poste secondaire
(éventuellement avec l'équipement SIP associé)
(par exemple, supprimer un OTC PC secondaire ou
un combiné DECT).
La méthode Delete n'est pas utilisée pour supprimer
les paramètres SIP depuis un équipement secondaire.
Cette opération doit être effectuée via la méthode Up-
date.

Delete(/ov8770/data/users/{UID}/ Dissocie tous les équipements de l'utilisateur ayant un


devices) uid={UID}, et supprime l'équipement de l'OmniVista
8770 et des nœuds correspondants des équipements.

3.3 Gestion des erreurs


Les exceptions émises par l'API comportent les informations suivantes :
• Code d'erreur (voir les codes d'erreur communs listés ci-dessous)
• Infos supplémentaires : ID ou attribut, ainsi que la valeur ayant déclenché l'exception
• Message d'erreur fourni en anglais
Les codes d'erreur communs sont les suivants :
• 11. Operation not supported (Opération non prise en charge)
• 12. Invalid input data (Données d'entrée invalides)
• 13. Invalid hierarchy (Hiérarchie invalide)
• 14. Unknown id (ID inconnu)
• 15. Duplicate id (Doublon de l'ID)
• 16. Invalid filter (Filtre invalide)
• 17. Missing attribute(s) (Attribut(s) manquant(s))
• 18. Too many parallel requests (Trop de requêtes en parallèle)
• 19. Not Licensed (Absence de licence)
• 20. Not Authenticated (Non authentifié)
• 21. Processing Error in 8770/Nodes (Erreur de traitement au niveau du 8770/des nœuds)

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 26/27


Chapitre 3 Description détaillée

1. Time out (Temporisation écoulée)


2. Node not reachable (Nœud inaccessible)
3. Error from Node (Erreur venant du nœud)
4. Invalid entry (Entrée invalide)
Note :
D'une manière générale, en cas d'erreur, l'API ne prend pas en charge le mécanisme de restauration automatique,
qui consiste en l'annulation automatique de toutes les opérations réalisées par la dernière demande d'API
exécutée jusqu'à la génération de l'erreur. Les demandes Get peuvent être utilisées pour connaître l'état actuel
des objets ayant été modifiés avant que l'erreur ne se produise. En cas d'échec lors de la création d'un utilisateur
avec des équipements (dû à une erreur de paramétrage), utiliser une demande Delete sur un utilisateur (ce qui a
pour effet de supprimer également ses équipements) est une manière simple d'appliquer une restauration
manuelle, avant d'essayer de créer à nouveau l'utilisateur et ses équipements.

3.4 Compatibilité descendante


L'API est compatible avec une version N+1 de l'OmniVista 8770. L'API définie dans l'OmniVista 8770
R2.0 est donc compatible avec la version majeure suivante de l'OmniVista 8770.
La version XML fournie dans le schéma doit être la version 2.0, qui correspond à l'OmniVista 8770
R2.0.

8AL90710FRAE - Ed. 01 - Avril 2019 - API de gestion des utilisateurs 27/27

Vous aimerez peut-être aussi