static/api/apidocs-4.16/apis/lockUser.html

<!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_controller"> <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.16.0.0 Root Admin API Reference </span> <p></p> <h1>lockUser</h1> <p>Locks a user account</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;"><strong>id</strong></td><td style="width:500px;"><strong>Locks user by user ID.</strong></td><td style="width:180px;"><strong>true</strong></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>id</strong></td><td style="width:500px;">the user ID</td> </tr> <tr> <td style="width:200px;"><strong>account</strong></td><td style="width:500px;">the account name of the user</td> </tr> <tr> <td style="width:200px;"><strong>accountid</strong></td><td style="width:500px;">the account ID of the user</td> </tr> <tr> <td style="width:200px;"><strong>accounttype</strong></td><td style="width:500px;">the account type of the user</td> </tr> <tr> <td style="width:200px;"><strong>apikey</strong></td><td style="width:500px;">the api key of the user</td> </tr> <tr> <td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date and time the user account was created</td> </tr> <tr> <td style="width:200px;"><strong>domain</strong></td><td style="width:500px;">the domain name of the user</td> </tr> <tr> <td style="width:200px;"><strong>domainid</strong></td><td style="width:500px;">the domain ID of the user</td> </tr> <tr> <td style="width:200px;"><strong>email</strong></td><td style="width:500px;">the user email address</td> </tr> <tr> <td style="width:200px;"><strong>firstname</strong></td><td style="width:500px;">the user firstname</td> </tr> <tr> <td style="width:200px;"><strong>icon</strong></td><td style="width:500px;">Base64 string representation of the resource icon</td> </tr> <tr> <td style="width:200px;"><strong>iscallerchilddomain</strong></td><td style="width:500px;">the boolean value representing if the updating target is in caller's child domain</td> </tr> <tr> <td style="width:200px;"><strong>isdefault</strong></td><td style="width:500px;">true if user is default, false otherwise</td> </tr> <tr> <td style="width:200px;"><strong>lastname</strong></td><td style="width:500px;">the user lastname</td> </tr> <tr> <td style="width:200px;"><strong>roleid</strong></td><td style="width:500px;">the ID of the role</td> </tr> <tr> <td style="width:200px;"><strong>rolename</strong></td><td style="width:500px;">the name of the role</td> </tr> <tr> <td style="width:200px;"><strong>roletype</strong></td><td style="width:500px;">the type of the role</td> </tr> <tr> <td style="width:200px;"><strong>secretkey</strong></td><td style="width:500px;">the secret key of the user</td> </tr> <tr> <td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the user state</td> </tr> <tr> <td style="width:200px;"><strong>timezone</strong></td><td style="width:500px;">the timezone user was created in</td> </tr> <tr> <td style="width:200px;"><strong>username</strong></td><td style="width:500px;">the user name</td> </tr> <tr> <td style="width:200px;"><strong>usersource</strong></td><td style="width:500px;">the source type of the user in lowercase, such as native, ldap, saml2</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_maincontroller"> <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>

static/api/apidocs-4.16/apis/lockUser.html (147 lines of code) (raw):