json_User.html 6.41 KB
Newer Older
Spiros Koulouzis's avatar
Spiros Koulouzis committed
1 2 3 4 5 6 7 8
<!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 -->

Spiros Koulouzis's avatar
Spiros Koulouzis committed
9
  <title>drip-api: User</title>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
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

  <!-- 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>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
38
        <a class="navbar-brand" href="index.html">drip-api: User</a>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
39 40 41
      </div>
      <div id="navbar" class="navbar-collapse collapse">
        <ul class="nav navbar-nav navbar-right">
Spiros Koulouzis's avatar
Spiros Koulouzis committed
42
          <li><a href="resources.html">Resources</a></li>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
          <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_json.html">JSON</a></li>
          <li class="dropdown"><a href="json_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

      <dl class="dl-horizontal">
      </dl>

      <table class="table datatype-properties">
        <caption>Properties</caption>
        <thead>
        <tr>
          <th>name</th>
          <th>data type</th>
          <th>description</th>
        </tr>
        </thead>
        <tbody>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
83
          <td>  <span class="property-name">password</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
84
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
85
          <td>  <span class="datatype-reference">string
Spiros Koulouzis's avatar
Spiros Koulouzis committed
86 87 88 89 90 91
</span>
</td>
          <td>  <span class="property-description"></span>
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
92
          <td>  <span class="property-name">id</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
93
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
94
          <td>  <span class="datatype-reference">string
Spiros Koulouzis's avatar
Spiros Koulouzis committed
95 96
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
97 98
          <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
99 100 101
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
102
          <td>  <span class="property-name">username</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
103
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
104
          <td>  <span class="datatype-reference">string
Spiros Koulouzis's avatar
Spiros Koulouzis committed
105 106
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
107
          <td>  <span class="property-description">The username</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
108 109 110
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
111
          <td>  <span class="property-name">accountNonExpired</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
112
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
113
          <td>  <span class="datatype-reference">boolean
Spiros Koulouzis's avatar
Spiros Koulouzis committed
114 115
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
116
          <td>  <span class="property-description">If the account is not expired</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
117 118 119
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
120
          <td>  <span class="property-name">accountNonLocked</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
121
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
122
          <td>  <span class="datatype-reference">boolean
Spiros Koulouzis's avatar
Spiros Koulouzis committed
123 124
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
125
          <td>  <span class="property-description">If the account is not locked</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
126 127 128
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
129
          <td>  <span class="property-name">credentialsNonExpired</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
130
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
131
          <td>  <span class="datatype-reference">boolean
Spiros Koulouzis's avatar
Spiros Koulouzis committed
132 133
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
134
          <td>  <span class="property-description">If the credentials are not expired</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
135 136 137
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
138
          <td>  <span class="property-name">enabled</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
139
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
140
          <td>  <span class="datatype-reference">boolean
Spiros Koulouzis's avatar
Spiros Koulouzis committed
141 142
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
143
          <td>  <span class="property-description">If the account is enabled</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
144 145 146
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
147
          <td>  <span class="property-name">roles</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
148
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
149
          <td>  <span class="datatype-reference">array of string
Spiros Koulouzis's avatar
Spiros Koulouzis committed
150 151
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
152
          <td>  <span class="property-description">The roles assigned to this user.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
153 154 155 156 157 158 159 160
</td>
        </tr>
        </tbody>
      </table>

      <p class="lead">Example</p>
      
      <pre class="prettyprint language-js example">{
Spiros Koulouzis's avatar
Spiros Koulouzis committed
161 162
  &quot;password&quot; : &quot;...&quot;,
  &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
163 164 165 166
  &quot;username&quot; : &quot;user&quot;,
  &quot;accountNonExpired&quot; : true,
  &quot;accountNonLocked&quot; : true,
  &quot;credentialsNonExpired&quot; : true,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
167
  &quot;enabled&quot; : true,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
168
  &quot;roles&quot; : [ &quot;[\&quot;ADMIN\&quot;,\&quot;USER\&quot;]&quot;, &quot;...&quot; ]
Spiros Koulouzis's avatar
Spiros Koulouzis committed
169 170 171 172 173 174 175 176 177 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
}</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>