Différences entre versions de « WebAPI ACL.UsersList »
De Documentation Polaris
(Modification automatique par le cartographe) |
(Modification automatique par le cartographe) |
||
| Ligne 4 : | Ligne 4 : | ||
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)]]. | 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><br/><p class='appel'><span class='lbl'>Appel Web :</span> <span class='vlr'> | + | <div id='api-body'><p class='prp'>L'API ACL permet de gérer la sécurité des transactions et de la session</p><br/><p class='appel'><span class='lbl'>Appel Web :</span> <span class='vlr'>https://nur298.ws-dev.polarisgestionmag.net/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'> (<span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</span> <span class='parameter-name'>userName</span> = null]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</span> <span class='parameter-name'>localStore</span> = True]</span>, <span class='opt'>[<span class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</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 :</span></p><table class='t-args'><tr><th>Nom</th><th>Type</th><th>Description</th></tr><tr><th class='parameter-name'>userName</th><td class='parameter-type'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.String String]</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'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</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'>[http://social.msdn.microsoft.com/Search/fr-FR?query=System.Boolean Boolean]</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 :</span></p><p style='padding-left:1em;'>aucune, cette API est disponible pour tous</p></div></div> |
{{FinInfoCartographe}}[[Catégorie:Webservice ACL|UsersList]] | {{FinInfoCartographe}}[[Catégorie:Webservice ACL|UsersList]] | ||
Version du 18 juillet 2022 à 09:23
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
Appel Web : https://nur298.ws-dev.polarisgestionmag.net/core/api/ACL.UsersList
UserInfo[] ACL.UsersList ([String userName = null], [Boolean localStore = True], [Boolean remoteStore = True], [xml|json output = xml ])
Obtient la liste les utilisateurs autorisés sur le système
Arguments :
| Nom | Type | Description |
|---|---|---|
| userName | String | (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 | Boolean | (optionnel, par défaut: True) Inclure dans les résultats les utilisateurs du magasin que gère ce service |
| remoteStore | Boolean | (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