Différences entre versions de « WebAPI ACL.UsersList »

Version du 2 octobre 2017 à 11:02

Cette fonctionnalité n'est plus disponible depuis la version 6.02

L'API par Webservice vous permet de piloter ou d'interroger votre solution de gestion depuis un programme externe via un langage normalisé. Pour obtenir plus d'informations sur la bibliothèque d'APIs, consultez la page de documentation suivante : Interface de programmation applicative par Webservice (API).

L'API ACL permet de gérer la sécurité des transactions et de la session

Methode ACL.UsersList

Appel Web : http://xx.xx.xx.xx/core/api/ACL.UsersList

UserInfo[] ACL.UsersList ([<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a> userName = null], [<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean'>Boolean</a> localStore = True], [<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean'>Boolean</a> remoteStore = True], [xml|json output = xml ])

Obtient la liste les utilisateurs autorisés sur le système

Arguments :

Nom	Type	Description
userName	<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a>	(optionnel, par défaut: null) Si précisé, renvoi les informations de l'utilisateur spécifié, utilisez le terme '%' pour préciser des noms d'utilisateurs à trou. (exemple : 'u%' pour renvoyer tous les utilisateurs dont le nom commence par la lettre 'u'.
localStore	<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean'>Boolean</a>	(optionnel, par défaut: True) Inclure dans les résultats les utilisateurs du magasin que gère ce service
remoteStore	<a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean'>Boolean</a>	(optionnel, par défaut: True) Inclure dans les résultats les utilisateurs des magasins que ce service ne gère pas
output	xml\|json	(optionnel, par défaut: xml) Format de la réponse
Retour	UserInfo[]	Liste des utilisateurs

Politique de sécurité et règles d'accès à l'API :

aucune, cette API est disponible pour tous

@@ Ligne 1 : / Ligne 1 : @@
-{{DebutInfoCartographe}}{{FinInfoCartographe}}
+{{DebutInfoCartographe}}{{Jusqua|6.02}}
+L'API par Webservice vous permet de piloter ou d'interroger votre solution de gestion depuis un programme externe via un langage normalisé.
+Pour obtenir plus d'informations sur la bibliothèque d'APIs, consultez la page de documentation suivante : [[NF13075|Interface de programmation applicative par Webservice (API)]].
+<div id='api-body'><p class='prp'>L'API ACL permet de gérer la sécurité des transactions et de la session</p><h2>Methode ACL.UsersList</h2><p class='appel'><span class='lbl'>Appel Web&nbsp;:</span> <span class='vlr'>http://xx.xx.xx.xx/core/api/ACL.UsersList</span></p><p class='signature'><span class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.ACL+UserInfo|UserInfo]][]</span> <span class='method-name'>ACL.UsersList</span><span class='parameters'>&nbsp;(<span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></span> <span class='parameter-name'>userName</span> = null]</span>, <span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean'>Boolean</a></span> <span class='parameter-name'>localStore</span> = True]</span>, <span class='opt'>[<span class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean'>Boolean</a></span> <span class='parameter-name'>remoteStore</span> = True]</span>, <span class='opt'>[<span class='parameter-type'>xml|json</span> <span class='parameter-name'>output</span> = xml ]</span>)</span></p><p class='mrp'>Obtient la liste les utilisateurs autorisés sur le système</p><div class='args'><p><span class='lbl'>Arguments&nbsp;:</span></p><table class='t-args'><tr><thead><th>Nom</th><th>Type</th><th>Description</th></thead></tr><tr><th class='parameter-name'>userName</th><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.String'>String</a></td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: null)<br/></span><span class='param-doc'>Si précisé, renvoi les informations de l'utilisateur spécifié, utilisez le terme '%' pour préciser des noms d'utilisateurs à trou. (exemple : 'u%' pour renvoyer tous les utilisateurs dont le nom commence par la lettre 'u'.</span></td></tr><tr><th class='parameter-name'>localStore</th><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean'>Boolean</a></td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: True)<br/></span><span class='param-doc'>Inclure dans les résultats les utilisateurs du magasin que gère ce service</span></td></tr><tr><th class='parameter-name'>remoteStore</th><td class='parameter-type'><a href='http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean'>Boolean</a></td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: True)<br/></span><span class='param-doc'>Inclure dans les résultats les utilisateurs des magasins que ce service ne gère pas</span></td></tr><tr><th class='parameter-name'>output</th><td class='parameter-type'>xml|json</td><td class='parameter-txt'> <span class='optionel'>(optionnel, par défaut: xml)<br/></span><span class='param-doc'>Format de la réponse</span></td></tr><tr class='t-return'><th>Retour</th><td class='return-type'>[[WebAPI Type RepDaemon.WebService2.CoreAPI.ACL+UserInfo|UserInfo]][]</td><td class='return-doc'>Liste des utilisateurs</td></tr></table><p><span class='lbl'>Politique de sécurité et règles d'accès à l'API&nbsp;:</span></p><p style='padding-left:1em;'>aucune, cette API est disponible pour tous</p></div></div>
+{{FinInfoCartographe}}[[Catégorie:Webservice API|ACL.UsersList]]