Skip to content
Browse files

generated pages

  • Loading branch information...
1 parent 4d4f275 commit bcbb6ff5efee54f5f80a223046fc5b88043736dc @turtlebender turtlebender committed May 15, 2012
Showing with 41 additions and 5 deletions.
  1. +39 −4 api.html
  2. +2 −1 api.json
View
43 api.html
@@ -15,7 +15,8 @@
<ul>
<li><div><a href="#users">Users</a></div>
<ul>
- <li><div><a href="#GET-/users"><span class="method justendpoint"><span class="endpoint"><span class="verb">GET</span> <span class="path">/users</span></span></a></div></li>
+ <li><div><a href="#GET-/users/<username>"><span class="method justendpoint"><span class="endpoint"><span class="verb">GET</span> <span class="path">/users/<username></span></span></a></div></li>
+ <li><div><a href="#POST-/Users"><span class="method justendpoint"><span class="endpoint"><span class="verb">POST</span> <span class="path">/Users</span></span></a></div></li>
</ul></li>
</ul>
@@ -40,22 +41,56 @@
</div>
<h1 id="users">Users</h1>
-<h2 id="GET-/users"><span class="method justendpoint"><span class="endpoint"><span class="verb">GET</span> <span class="path">/users</span></span></h2>
+<h2 id="GET-/users/<username>">GET /users/<username></h2>
<p>Retrieves the user object.</p>
<h4>example request</h4>
-<pre class="shell"><code>curl https://nexus.api.globusonline.org/users/trhowe
+<pre class="shell"><code>curl https://nexus.api.globusonline.org/users/user
</code></pre>
<h4>response</h4>
<pre><code>{
- "username": "trhowe"
+ "username": "user",
+ "email_validated": true,
+ "fullname": "User Name",
+ "email": "no-reply@globusonline.org",
+ "system_admin": false
}
</code></pre>
+<h2 id="POST-/Users"><span class="method justendpoint"><span class="endpoint"><span class="verb">POST</span> <span class="path">/Users</span></span></h2>
+
+<p>Create a new user.</p>
+
+<h4>example request</h4>
+
+<pre class="shell"><code>curl -H "Content-Type: application/json" \
+ https://nexus.api.globusonline.org/Users
+ -d "{
+ "fullname": "User Name",
+ "email": "no-reply@globusonline.org",
+ "username": "user",
+ "password": "ChangeMe",
+ "opt_in": true
+ }"
+</code></pre>
+
+<h4>response</h4>
+
+<pre><code> {
+ "fullname": "User Name",
+ "email": "no-reply@globusonline.org",
+ "username": "user",
+ "password": "ChangeMe",
+ "opt_in": true,
+ "system_admin": false,
+ "email_validated": false
+ }
+</code></pre>
+
</div>
<script type="text/javascript" charset="utf-8">
$(function() {
View
3 api.json
@@ -1,6 +1,7 @@
{
"endpoints": [
- "GET /users"
+ "GET /users/<username>",
+ "POST /Users"
],
"version": "0.1.0"
}

0 comments on commit bcbb6ff

Please sign in to comment.
Something went wrong with that request. Please try again.