| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" href="../includes/main.css" type="text/css"> |
| <link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> |
| <title>Apache CloudStack | The Power Behind Your Cloud</title> |
| </head> |
| <body> |
| <div id="insidetopbg"> |
| <div id="inside_wrapper"> |
| <div class="uppermenu_panel"> |
| <div class="uppermenu_box"></div> |
| </div> |
| <div id="main_master"> |
| <div id="inside_header"> |
| <div class="header_top"> |
| <a class="cloud_logo" href="http://cloudstack.org"></a> |
| <div class="mainemenu_panel"></div> |
| </div> |
| </div> |
| <div id="main_content"> |
| <div class="inside_apileftpanel"> |
| <div class="inside_contentpanel" style="width:930px;"> |
| <div class="api_titlebox"> |
| <div class="api_titlebox_left"> |
| <span> |
| Apache CloudStack 4.14.1.0-SNAPSHOT Root Admin API Reference |
| </span> |
| <p></p> |
| <h1>listLdapUsers</h1> |
| <p>Lists LDAP Users according to the specifications from the user request.</p> |
| </div> |
| <div class="api_titlebox_right"> |
| <a class="api_backbutton" href="../index.html"></a> |
| </div> |
| </div> |
| <div class="api_tablepanel"> |
| <h2>Request parameters</h2> |
| <table class="apitable"> |
| <tr class="hed"> |
| <td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>domainid</i></td><td style="width:500px;"><i>linked domain</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>keyword</i></td><td style="width:500px;"><i>List by keyword</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>listtype</i></td><td style="width:500px;"><i>Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>page</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>pagesize</i></td><td style="width:500px;"><i></i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><i>userfilter</i></td><td style="width:500px;"><i>Determines what type of filter is applied on the list of users returned from LDAP. |
| valid values are |
| 'NoFilter' no filtering is done, |
| 'LocalDomain' users already in the current or requested domain will be filtered out of the result list, |
| 'AnyDomain' users that already exist anywhere in cloudstack will be filtered out, and |
| 'PotentialImport' all users that would be automatically imported from the listing will be shown, including those that are already in cloudstack, the later will be annotated with their userSource</i></td><td style="width:180px;"><i>false</i></td> |
| </tr> |
| </table> |
| </div> |
| <div class="api_tablepanel"> |
| <h2>Response Tags</h2> |
| <table class="apitable"> |
| <tr class="hed"> |
| <td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>conflictingusersource</strong></td><td style="width:500px;">The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">The user's domain</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>email</strong></td><td style="width:500px;">The user's email</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>firstname</strong></td><td style="width:500px;">The user's firstname</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>lastname</strong></td><td style="width:500px;">The user's lastname</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>principal</strong></td><td style="width:500px;">The user's principle</td> |
| </tr> |
| <tr> |
| <td style="width:200px;"><strong>username</strong></td><td style="width:500px;">The user's username</td> |
| </tr> |
| </table> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div id="footer"> |
| <div id="comments_thread"> |
| <script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test" async="true"></script> |
| <noscript> |
| <iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&page=4.2.0/rootadmin"></iframe> |
| </noscript> |
| </div> |
| <div id="footer_mainmaster"> |
| <p> |
| Copyright © 2015 The Apache Software Foundation, Licensed under the |
| <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0.</a> |
| <br> |
| Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation. |
| </p> |
| </div> |
| </div> |
| </div> |
| </div> |
| </body> |
| </html> |
