xml_ns0_user.html 8.27 KB
Newer Older
Spiros Koulouzis's avatar
Spiros Koulouzis committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->

  <title>drip-api: user</title>

  <!-- Mobile viewport optimized: j.mp/bplateviewport -->
  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <!-- Bootstrap core CSS -->
  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">

  <!--custom css for these pages-->
  <link rel="stylesheet" href="css/style.css">

  <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
  <!--[if lt IE 9]>
  <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
  <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
  <![endif]-->
</head>

<body data-spy="scroll" data-target="#apinav">

  <nav class="navbar navbar-inverse navbar-fixed-top">
    <div class="container-fluid">
      <div class="navbar-header">
        <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
          <span class="sr-only">Toggle navigation</span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
        </button>
        <a class="navbar-brand" href="index.html">drip-api: user</a>
      </div>
      <div id="navbar" class="navbar-collapse collapse">
        <ul class="nav navbar-nav navbar-right">
          <li><a href="resources.html">Resources</a></li>
          <li><a href="data.html">Data Types</a></li>
          <li><a href="downloads.html">Files and Libraries</a></li>
        </ul>
      </div>
    </div>
  </nav>

  <div class="container-fluid">
    <div class="row">
      <div class="col-sm-3 col-md-2 sidebar" id="apinav">
        <ul class="nav nav-sidebar">
          <li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
        </ul>
      </div>

      <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
        <ol class="breadcrumb" id="top">
          <li class="active dropdown"><a href="index.html">Home</a></li>
          <li class="active dropdown"><a href="syntax_xml.html">XML</a></li>
          <li class="dropdown"><a href="xml_ns0_user.html">user</a></li>
        </ol>

      <h1 class="page-header">user <small>Data Type</small></h1>

Spiros Koulouzis's avatar
Spiros Koulouzis committed
67
      <p>This class represents a user.</p>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103

      <dl class="dl-horizontal">
        <dt>Namespace</dt>
        <dd>(Default)</dd>
        <dt>Schema</dt>
        <dd><a href="ns0.xsd">ns0.xsd</a></dd>
      </dl>

      <table class="table datatype-properties">
        <caption>Properties</caption>
        <thead>
        <tr>
          <th>name</th>
          <th>data type</th>
          <th>type</th>
          <th>namespace</th>
          <th>min/max occurs</th>
          <th>description</th>
        </tr>
        </thead>
        <tbody>
        <tr>
          <td>  <span class="property-name">accountNonExpired</span>
</td>
          <td>  <span class="datatype-reference">boolean
</span>
</td>
          <td>  <span class="property-type">element
</span>
</td>
          <td>  <span class="property-namespaceInfo">
</span>
</td>
          <td>  <span class="property-minMaxOccurs">1/1
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
104
          <td>  <span class="property-description">If the account is not expired</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
</td>
        </tr>
        <tr>
          <td>  <span class="property-name">accountNonLocked</span>
</td>
          <td>  <span class="datatype-reference">boolean
</span>
</td>
          <td>  <span class="property-type">element
</span>
</td>
          <td>  <span class="property-namespaceInfo">
</span>
</td>
          <td>  <span class="property-minMaxOccurs">1/1
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
122
          <td>  <span class="property-description">If the account is not locked</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
</td>
        </tr>
        <tr>
          <td>  <span class="property-name">credentialsNonExpired</span>
</td>
          <td>  <span class="datatype-reference">boolean
</span>
</td>
          <td>  <span class="property-type">element
</span>
</td>
          <td>  <span class="property-namespaceInfo">
</span>
</td>
          <td>  <span class="property-minMaxOccurs">1/1
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
140
          <td>  <span class="property-description">If the credentials are not expired</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
</td>
        </tr>
        <tr>
          <td>  <span class="property-name">enabled</span>
</td>
          <td>  <span class="datatype-reference">boolean
</span>
</td>
          <td>  <span class="property-type">element
</span>
</td>
          <td>  <span class="property-namespaceInfo">
</span>
</td>
          <td>  <span class="property-minMaxOccurs">1/1
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
158
          <td>  <span class="property-description">If the account is enabled</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
</td>
        </tr>
        <tr>
          <td>  <span class="property-name">id</span>
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
          <td>  <span class="property-type">element
</span>
</td>
          <td>  <span class="property-namespaceInfo">
</span>
</td>
          <td>  <span class="property-minMaxOccurs">0/1
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
176 177
          <td>  <span class="property-description">The unique id of this object. This value is auto-generated when the DAO
saves this object</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
</td>
        </tr>
        <tr>
          <td>  <span class="property-name">password</span>
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
          <td>  <span class="property-type">element
</span>
</td>
          <td>  <span class="property-namespaceInfo">
</span>
</td>
          <td>  <span class="property-minMaxOccurs">0/1
</span>
</td>
          <td>  <span class="property-description">&nbsp;</span>
</td>
        </tr>
        <tr>
          <td>  <span class="property-name">roles</span>
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
          <td>  <span class="property-type">element
</span>
</td>
          <td>  <span class="property-namespaceInfo">
</span>
</td>
          <td>  <span class="property-minMaxOccurs">0/unbounded
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
213
          <td>  <span class="property-description">The roles assigned to this user.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
</td>
        </tr>
        <tr>
          <td>  <span class="property-name">username</span>
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
          <td>  <span class="property-type">element
</span>
</td>
          <td>  <span class="property-namespaceInfo">
</span>
</td>
          <td>  <span class="property-minMaxOccurs">0/1
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
231
          <td>  <span class="property-description">The username</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
232 233 234 235 236 237 238 239
</td>
        </tr>
        </tbody>
      </table>

      <p class="lead">Example</p>
      
      <pre class="prettyprint language-xml example">&lt;u-----&gt;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
240
  &lt;id&gt;58e3946e0fb4f562d84ba1ad&lt;/id&gt;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
241
  &lt;password&gt;...&lt;/password&gt;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
242
  &lt;username&gt;user&lt;/username&gt;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
243
  &lt;accountNonExpired&gt;true&lt;/accountNonExpired&gt;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
244
  &lt;accountNonLocked&gt;true&lt;/accountNonLocked&gt;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
245
  &lt;credentialsNonExpired&gt;true&lt;/credentialsNonExpired&gt;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
246
  &lt;enabled&gt;true&lt;/enabled&gt;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
247
  &lt;roles&gt;[&quot;ADMIN&quot;,&quot;USER&quot;]&lt;/roles&gt;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
&lt;/u-----&gt;
</pre>

        <footer class="footer">
          <div class="container">
            <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
          </div>
        </footer>

      </div>
    </div>
  </div>


  <!-- JavaScript placed at the end of the document so the pages load faster. -->
  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>

  <!-- Bootstrap core JavaScript
  ================================================== -->
  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>

  <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
  <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
  <script>
    $(function() {
      $(".clickable-row").click(function() {
        window.document.location = $(this).data("href");
      });

      $('[data-toggle="tooltip"]').tooltip()
    });
  </script>

</body>
</html>