Update docs from commit 517076722e8b73d0ce8d18946d2f22fc62b39fb4
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/commit/931b3706 Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/tree/931b3706 Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/diff/931b3706 Branch: refs/heads/asf-site Commit: 931b3706d7e0fce3ab33a1e2314c894ce4bc86fe Parents: 82dfa2b Author: jenkins <bui...@apache.org> Authored: Fri Sep 8 19:10:15 2017 +0000 Committer: jenkins <bui...@apache.org> Committed: Fri Sep 8 19:10:15 2017 +0000 ---------------------------------------------------------------------- .../traffic_ops_api/v12/user.rst.txt | 45 +++++++++++++ .../development/traffic_ops_api/v12/user.html | 66 ++++++++++++++++++++ docs/master/searchindex.js | 2 +- 3 files changed, 112 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/931b3706/docs/master/_sources/development/traffic_ops_api/v12/user.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/development/traffic_ops_api/v12/user.rst.txt b/docs/master/_sources/development/traffic_ops_api/v12/user.rst.txt index 7ed6b58..fe07920 100644 --- a/docs/master/_sources/development/traffic_ops_api/v12/user.rst.txt +++ b/docs/master/_sources/development/traffic_ops_api/v12/user.rst.txt @@ -375,6 +375,51 @@ Users | + +**POST /api/1.2/users/register** + + Register a user and send registration email. + + Authentication Required: Yes + + Role(s) Required: Admin or Operations + + **Request Properties** + + +-------------------------+--------+----------+-------------------------------------------------+ + | Parameter | Type | Required | Description | + +=========================+========+==========+=================================================+ + |``email`` | string | yes | Email address of the new user. | + +-------------------------+--------+----------+-------------------------------------------------+ + |``role`` | int | yes | Role ID of the new user. | + +-------------------------+--------+----------+-------------------------------------------------+ + |``tenantId`` | int | yes | Tenant ID of the new user. | + +-------------------------+--------+----------+-------------------------------------------------+ + + + **Request Example** :: + + { + "email": "f...@bar.com" + "role": 1, + "tenantId": "1" + } + +| + + **Response Example** :: + + { + "alerts": [ + { + "level":"success", + "text":"Sent user registration to f...@bar.com with the following permissions [ role: admin | tenant: root ]" + } + ] + } + +| + **GET /api/1.2/users/:id/deliveryservices** Retrieves all delivery services assigned to the user. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_. http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/931b3706/docs/master/development/traffic_ops_api/v12/user.html ---------------------------------------------------------------------- diff --git a/docs/master/development/traffic_ops_api/v12/user.html b/docs/master/development/traffic_ops_api/v12/user.html index da02078..be89bb1 100644 --- a/docs/master/development/traffic_ops_api/v12/user.html +++ b/docs/master/development/traffic_ops_api/v12/user.html @@ -796,6 +796,72 @@ <div class="line-block"> <div class="line"><br /></div> </div> +<p><strong>POST /api/1.2/users/register</strong></p> +<blockquote> +<div><p>Register a user and send registration email.</p> +<p>Authentication Required: Yes</p> +<p>Role(s) Required: Admin or Operations</p> +<p><strong>Request Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="27%" /> +<col width="9%" /> +<col width="11%" /> +<col width="53%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Parameter</th> +<th class="head">Type</th> +<th class="head">Required</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">email</span></code></td> +<td>string</td> +<td>yes</td> +<td>Email address of the new user.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">role</span></code></td> +<td>int</td> +<td>yes</td> +<td>Role ID of the new user.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">tenantId</span></code></td> +<td>int</td> +<td>yes</td> +<td>Tenant ID of the new user.</td> +</tr> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"f...@bar.com"</span> + <span class="s2">"role"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> + <span class="s2">"tenantId"</span><span class="p">:</span> <span class="s2">"1"</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<blockquote> +<div><p><strong>Response Example</strong></p> +<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span> + <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span> + <span class="p">{</span> + <span class="s2">"level"</span><span class="p">:</span><span class="s2">"success"</span><span class="p">,</span> + <span class="s2">"text"</span><span class="p">:</span><span class="s2">"Sent user registration to f...@bar.com with the following permissions [ role: admin | tenant: root ]"</span> + <span class="p">}</span> + <span class="p">]</span> + <span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> <p><strong>GET /api/1.2/users/:id/deliveryservices</strong></p> <blockquote> <div><p>Retrieves all delivery services assigned to the user. See also <a class="reference external" href="http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service";>Using Traffic Ops - Delivery Service</a>.</p>
