You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by pv...@apache.org on 2020/10/19 10:30:15 UTC
svn commit: r1882650 [4/4] - in /nifi/site/trunk/docs/nifi-registry-docs:
html/administration-guide.html html/getting-started.html html/rest-api.html
html/user-guide.html rest-api/rest-api.html
Modified: nifi/site/trunk/docs/nifi-registry-docs/rest-api/rest-api.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-registry-docs/rest-api/rest-api.html?rev=1882650&r1=1882649&r2=1882650&view=diff
==============================================================================
--- nifi/site/trunk/docs/nifi-registry-docs/rest-api/rest-api.html (original)
+++ nifi/site/trunk/docs/nifi-registry-docs/rest-api/rest-api.html Mon Oct 19 10:30:15 2020
@@ -434,7 +434,7 @@ body.book #toc,body.book #preamble,body.
<div id="header">
<h1>Apache NiFi Registry REST API</h1>
<div class="details">
-<span id="revnumber">version 0.7.0</span>
+<span id="revnumber">version 0.8.0</span>
</div>
<div id="toc" class="toc">
<div id="toctitle">Table of Contents</div>
@@ -460,12 +460,16 @@ body.book #toc,body.book #preamble,body.
<ul class="sectlevel3">
<li><a href="rest-api.html#_getaccessstatus">3.1.1. Get access status</a></li>
<li><a href="rest-api.html#_logout">3.1.2. Performs a logout for other providers that have been issued a JWT.</a></li>
-<li><a href="rest-api.html#_createaccesstokenbytryingallproviders">3.1.3. Create token trying all providers</a></li>
-<li><a href="rest-api.html#_createaccesstokenusingidentityprovidercredentials">3.1.4. Create token using identity provider</a></li>
-<li><a href="rest-api.html#_testidentityproviderrecognizescredentialsformat">3.1.5. Test identity provider</a></li>
-<li><a href="rest-api.html#_getidentityproviderusageinstructions">3.1.6. Get identity provider usage</a></li>
-<li><a href="rest-api.html#_createaccesstokenusingkerberosticket">3.1.7. Create token using kerberos</a></li>
-<li><a href="rest-api.html#_createaccesstokenusingbasicauthcredentials">3.1.8. Create token using basic auth</a></li>
+<li><a href="rest-api.html#_oidccallback">3.1.3. Redirect/callback URI for processing the result of the OpenId Connect login sequence.</a></li>
+<li><a href="rest-api.html#_oidcexchange">3.1.4. Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.</a></li>
+<li><a href="rest-api.html#_oidclogout">3.1.5. Performs a logout in the OpenId Provider.</a></li>
+<li><a href="rest-api.html#_oidcrequest">3.1.6. Initiates a request to authenticate through the configured OpenId Connect provider.</a></li>
+<li><a href="rest-api.html#_createaccesstokenbytryingallproviders">3.1.7. Create token trying all providers</a></li>
+<li><a href="rest-api.html#_createaccesstokenusingidentityprovidercredentials">3.1.8. Create token using identity provider</a></li>
+<li><a href="rest-api.html#_testidentityproviderrecognizescredentialsformat">3.1.9. Test identity provider</a></li>
+<li><a href="rest-api.html#_getidentityproviderusageinstructions">3.1.10. Get identity provider usage</a></li>
+<li><a href="rest-api.html#_createaccesstokenusingkerberosticket">3.1.11. Create token using kerberos</a></li>
+<li><a href="rest-api.html#_createaccesstokenusingbasicauthcredentials">3.1.12. Create token using basic auth</a></li>
</ul>
</li>
<li><a href="rest-api.html#_bucket_bundles_resource">3.2. Bucket Bundles</a>
@@ -673,7 +677,7 @@ body.book #toc,body.book #preamble,body.
<div class="sect2">
<h3 id="_version_information"><a class="anchor" href="rest-api.html#_version_information"></a><a class="link" href="rest-api.html#_version_information">1.1. Version information</a></h3>
<div class="paragraph">
-<p><em>Version</em> : 0.7.0</p>
+<p><em>Version</em> : 0.8.0</p>
</div>
</div>
<div class="sect2">
@@ -903,7 +907,8 @@ body.book #toc,body.book #preamble,body.
"canWrite" : true,
"canDelete" : true
}
- }
+ },
+ "oidcloginSupported" : true
}</code></pre>
</div>
</div>
@@ -999,20 +1004,343 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect3">
-<h4 id="_createaccesstokenbytryingallproviders"><a class="anchor" href="rest-api.html#_createaccesstokenbytryingallproviders"></a><a class="link" href="rest-api.html#_createaccesstokenbytryingallproviders">3.1.3. Create token trying all providers</a></h4>
+<h4 id="_oidccallback"><a class="anchor" href="rest-api.html#_oidccallback"></a><a class="link" href="rest-api.html#_oidccallback">3.1.3. Redirect/callback URI for processing the result of the OpenId Connect login sequence.</a></h4>
<div class="literalblock">
<div class="content">
-<pre>POST /access/token</pre>
+<pre>GET /access/oidc/callback</pre>
</div>
</div>
<div class="sect4">
<h5 id="_description_3"><a class="anchor" href="rest-api.html#_description_3"></a><a class="link" href="rest-api.html#_description_3">Description</a></h5>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">
+This endpoint is subject to change as NiFi Registry and its REST API evolve.
+</td>
+</tr>
+</table>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_responses_3"><a class="anchor" href="rest-api.html#_responses_3"></a><a class="link" href="rest-api.html#_responses_3">Responses</a></h5>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 10%;">
+<col style="width: 70%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-middle">HTTP Code</th>
+<th class="tableblock halign-left valign-middle">Description</th>
+<th class="tableblock halign-left valign-middle">Schema</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>default</strong></p></td>
+<td class="tableblock halign-left valign-middle"><p class="tableblock">successful operation</p></td>
+<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="sect4">
+<h5 id="_consumes_3"><a class="anchor" href="rest-api.html#_consumes_3"></a><a class="link" href="rest-api.html#_consumes_3">Consumes</a></h5>
+<div class="ulist">
+<ul>
+<li>
+<p><code><strong>/</strong></code></p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_produces_3"><a class="anchor" href="rest-api.html#_produces_3"></a><a class="link" href="rest-api.html#_produces_3">Produces</a></h5>
+<div class="ulist">
+<ul>
+<li>
+<p><code><strong>/</strong></code></p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_example_http_request_3"><a class="anchor" href="rest-api.html#_example_http_request_3"></a><a class="link" href="rest-api.html#_example_http_request_3">Example HTTP request</a></h5>
+<div class="sect5">
+<h6 id="_request_path_3"><a class="anchor" href="rest-api.html#_request_path_3"></a><a class="link" href="rest-api.html#_request_path_3">Request path</a></h6>
+<div class="listingblock">
+<div class="content">
+<pre>/access/oidc/callback</pre>
+</div>
+</div>
+</div>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_oidcexchange"><a class="anchor" href="rest-api.html#_oidcexchange"></a><a class="link" href="rest-api.html#_oidcexchange">3.1.4. Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.</a></h4>
+<div class="literalblock">
+<div class="content">
+<pre>POST /access/oidc/exchange</pre>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_description_4"><a class="anchor" href="rest-api.html#_description_4"></a><a class="link" href="rest-api.html#_description_4">Description</a></h5>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">
+This endpoint is subject to change as NiFi Registry and its REST API evolve.
+</td>
+</tr>
+</table>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_responses_4"><a class="anchor" href="rest-api.html#_responses_4"></a><a class="link" href="rest-api.html#_responses_4">Responses</a></h5>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 10%;">
+<col style="width: 70%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-middle">HTTP Code</th>
+<th class="tableblock halign-left valign-middle">Description</th>
+<th class="tableblock halign-left valign-middle">Schema</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
+<td class="tableblock halign-left valign-middle"><p class="tableblock">successful operation</p></td>
+<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="sect4">
+<h5 id="_consumes_4"><a class="anchor" href="rest-api.html#_consumes_4"></a><a class="link" href="rest-api.html#_consumes_4">Consumes</a></h5>
+<div class="ulist">
+<ul>
+<li>
+<p><code><strong>/</strong></code></p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_produces_4"><a class="anchor" href="rest-api.html#_produces_4"></a><a class="link" href="rest-api.html#_produces_4">Produces</a></h5>
+<div class="ulist">
+<ul>
+<li>
+<p><code>text/plain</code></p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_example_http_request_4"><a class="anchor" href="rest-api.html#_example_http_request_4"></a><a class="link" href="rest-api.html#_example_http_request_4">Example HTTP request</a></h5>
+<div class="sect5">
+<h6 id="_request_path_4"><a class="anchor" href="rest-api.html#_request_path_4"></a><a class="link" href="rest-api.html#_request_path_4">Request path</a></h6>
+<div class="listingblock">
+<div class="content">
+<pre>/access/oidc/exchange</pre>
+</div>
+</div>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_example_http_response_2"><a class="anchor" href="rest-api.html#_example_http_response_2"></a><a class="link" href="rest-api.html#_example_http_response_2">Example HTTP response</a></h5>
+<div class="sect5">
+<h6 id="_response_200_2"><a class="anchor" href="rest-api.html#_response_200_2"></a><a class="link" href="rest-api.html#_response_200_2">Response 200</a></h6>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-json" data-lang="json">"string"</code></pre>
+</div>
+</div>
+</div>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_oidclogout"><a class="anchor" href="rest-api.html#_oidclogout"></a><a class="link" href="rest-api.html#_oidclogout">3.1.5. Performs a logout in the OpenId Provider.</a></h4>
+<div class="literalblock">
+<div class="content">
+<pre>DELETE /access/oidc/logout</pre>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_description_5"><a class="anchor" href="rest-api.html#_description_5"></a><a class="link" href="rest-api.html#_description_5">Description</a></h5>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">
+This endpoint is subject to change as NiFi Registry and its REST API evolve.
+</td>
+</tr>
+</table>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_responses_5"><a class="anchor" href="rest-api.html#_responses_5"></a><a class="link" href="rest-api.html#_responses_5">Responses</a></h5>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 10%;">
+<col style="width: 70%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-middle">HTTP Code</th>
+<th class="tableblock halign-left valign-middle">Description</th>
+<th class="tableblock halign-left valign-middle">Schema</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>default</strong></p></td>
+<td class="tableblock halign-left valign-middle"><p class="tableblock">successful operation</p></td>
+<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="sect4">
+<h5 id="_consumes_5"><a class="anchor" href="rest-api.html#_consumes_5"></a><a class="link" href="rest-api.html#_consumes_5">Consumes</a></h5>
+<div class="ulist">
+<ul>
+<li>
+<p><code><strong>/</strong></code></p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_produces_5"><a class="anchor" href="rest-api.html#_produces_5"></a><a class="link" href="rest-api.html#_produces_5">Produces</a></h5>
+<div class="ulist">
+<ul>
+<li>
+<p><code><strong>/</strong></code></p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_example_http_request_5"><a class="anchor" href="rest-api.html#_example_http_request_5"></a><a class="link" href="rest-api.html#_example_http_request_5">Example HTTP request</a></h5>
+<div class="sect5">
+<h6 id="_request_path_5"><a class="anchor" href="rest-api.html#_request_path_5"></a><a class="link" href="rest-api.html#_request_path_5">Request path</a></h6>
+<div class="listingblock">
+<div class="content">
+<pre>/access/oidc/logout</pre>
+</div>
+</div>
+</div>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_oidcrequest"><a class="anchor" href="rest-api.html#_oidcrequest"></a><a class="link" href="rest-api.html#_oidcrequest">3.1.6. Initiates a request to authenticate through the configured OpenId Connect provider.</a></h4>
+<div class="literalblock">
+<div class="content">
+<pre>GET /access/oidc/request</pre>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_description_6"><a class="anchor" href="rest-api.html#_description_6"></a><a class="link" href="rest-api.html#_description_6">Description</a></h5>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">
+This endpoint is subject to change as NiFi Registry and its REST API evolve.
+</td>
+</tr>
+</table>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_responses_6"><a class="anchor" href="rest-api.html#_responses_6"></a><a class="link" href="rest-api.html#_responses_6">Responses</a></h5>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 10%;">
+<col style="width: 70%;">
+<col style="width: 20%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-middle">HTTP Code</th>
+<th class="tableblock halign-left valign-middle">Description</th>
+<th class="tableblock halign-left valign-middle">Schema</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>default</strong></p></td>
+<td class="tableblock halign-left valign-middle"><p class="tableblock">successful operation</p></td>
+<td class="tableblock halign-left valign-middle"><p class="tableblock">No Content</p></td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="sect4">
+<h5 id="_consumes_6"><a class="anchor" href="rest-api.html#_consumes_6"></a><a class="link" href="rest-api.html#_consumes_6">Consumes</a></h5>
+<div class="ulist">
+<ul>
+<li>
+<p><code><strong>/</strong></code></p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_produces_6"><a class="anchor" href="rest-api.html#_produces_6"></a><a class="link" href="rest-api.html#_produces_6">Produces</a></h5>
+<div class="ulist">
+<ul>
+<li>
+<p><code><strong>/</strong></code></p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_example_http_request_6"><a class="anchor" href="rest-api.html#_example_http_request_6"></a><a class="link" href="rest-api.html#_example_http_request_6">Example HTTP request</a></h5>
+<div class="sect5">
+<h6 id="_request_path_6"><a class="anchor" href="rest-api.html#_request_path_6"></a><a class="link" href="rest-api.html#_request_path_6">Request path</a></h6>
+<div class="listingblock">
+<div class="content">
+<pre>/access/oidc/request</pre>
+</div>
+</div>
+</div>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_createaccesstokenbytryingallproviders"><a class="anchor" href="rest-api.html#_createaccesstokenbytryingallproviders"></a><a class="link" href="rest-api.html#_createaccesstokenbytryingallproviders">3.1.7. Create token trying all providers</a></h4>
+<div class="literalblock">
+<div class="content">
+<pre>POST /access/token</pre>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_description_7"><a class="anchor" href="rest-api.html#_description_7"></a><a class="link" href="rest-api.html#_description_7">Description</a></h5>
<div class="paragraph">
<p>Creates a token for accessing the REST API via auto-detected method of verifying client identity claim credentials. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer <token>'.</p>
</div>
</div>
<div class="sect4">
-<h5 id="_responses_3"><a class="anchor" href="rest-api.html#_responses_3"></a><a class="link" href="rest-api.html#_responses_3">Responses</a></h5>
+<h5 id="_responses_7"><a class="anchor" href="rest-api.html#_responses_7"></a><a class="link" href="rest-api.html#_responses_7">Responses</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 10%;">
@@ -1056,7 +1384,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_consumes_3"><a class="anchor" href="rest-api.html#_consumes_3"></a><a class="link" href="rest-api.html#_consumes_3">Consumes</a></h5>
+<h5 id="_consumes_7"><a class="anchor" href="rest-api.html#_consumes_7"></a><a class="link" href="rest-api.html#_consumes_7">Consumes</a></h5>
<div class="ulist">
<ul>
<li>
@@ -1066,7 +1394,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_produces_3"><a class="anchor" href="rest-api.html#_produces_3"></a><a class="link" href="rest-api.html#_produces_3">Produces</a></h5>
+<h5 id="_produces_7"><a class="anchor" href="rest-api.html#_produces_7"></a><a class="link" href="rest-api.html#_produces_7">Produces</a></h5>
<div class="ulist">
<ul>
<li>
@@ -1076,9 +1404,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_request_3"><a class="anchor" href="rest-api.html#_example_http_request_3"></a><a class="link" href="rest-api.html#_example_http_request_3">Example HTTP request</a></h5>
+<h5 id="_example_http_request_7"><a class="anchor" href="rest-api.html#_example_http_request_7"></a><a class="link" href="rest-api.html#_example_http_request_7">Example HTTP request</a></h5>
<div class="sect5">
-<h6 id="_request_path_3"><a class="anchor" href="rest-api.html#_request_path_3"></a><a class="link" href="rest-api.html#_request_path_3">Request path</a></h6>
+<h6 id="_request_path_7"><a class="anchor" href="rest-api.html#_request_path_7"></a><a class="link" href="rest-api.html#_request_path_7">Request path</a></h6>
<div class="listingblock">
<div class="content">
<pre>/access/token</pre>
@@ -1087,9 +1415,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_response_2"><a class="anchor" href="rest-api.html#_example_http_response_2"></a><a class="link" href="rest-api.html#_example_http_response_2">Example HTTP response</a></h5>
+<h5 id="_example_http_response_3"><a class="anchor" href="rest-api.html#_example_http_response_3"></a><a class="link" href="rest-api.html#_example_http_response_3">Example HTTP response</a></h5>
<div class="sect5">
-<h6 id="_response_200_2"><a class="anchor" href="rest-api.html#_response_200_2"></a><a class="link" href="rest-api.html#_response_200_2">Response 200</a></h6>
+<h6 id="_response_200_3"><a class="anchor" href="rest-api.html#_response_200_3"></a><a class="link" href="rest-api.html#_response_200_3">Response 200</a></h6>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-json" data-lang="json">"string"</code></pre>
@@ -1099,20 +1427,20 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect3">
-<h4 id="_createaccesstokenusingidentityprovidercredentials"><a class="anchor" href="rest-api.html#_createaccesstokenusingidentityprovidercredentials"></a><a class="link" href="rest-api.html#_createaccesstokenusingidentityprovidercredentials">3.1.4. Create token using identity provider</a></h4>
+<h4 id="_createaccesstokenusingidentityprovidercredentials"><a class="anchor" href="rest-api.html#_createaccesstokenusingidentityprovidercredentials"></a><a class="link" href="rest-api.html#_createaccesstokenusingidentityprovidercredentials">3.1.8. Create token using identity provider</a></h4>
<div class="literalblock">
<div class="content">
<pre>POST /access/token/identity-provider</pre>
</div>
</div>
<div class="sect4">
-<h5 id="_description_4"><a class="anchor" href="rest-api.html#_description_4"></a><a class="link" href="rest-api.html#_description_4">Description</a></h5>
+<h5 id="_description_8"><a class="anchor" href="rest-api.html#_description_8"></a><a class="link" href="rest-api.html#_description_8">Description</a></h5>
<div class="paragraph">
<p>Creates a token for accessing the REST API via a custom identity provider. The user credentials must be passed in a format understood by the custom identity provider, e.g., a third-party auth token in an HTTP header. The exact format of the user credentials expected by the custom identity provider can be discovered by 'GET /access/token/identity-provider/usage'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer <token>'.</p>
</div>
</div>
<div class="sect4">
-<h5 id="_responses_4"><a class="anchor" href="rest-api.html#_responses_4"></a><a class="link" href="rest-api.html#_responses_4">Responses</a></h5>
+<h5 id="_responses_8"><a class="anchor" href="rest-api.html#_responses_8"></a><a class="link" href="rest-api.html#_responses_8">Responses</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 10%;">
@@ -1156,7 +1484,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_consumes_4"><a class="anchor" href="rest-api.html#_consumes_4"></a><a class="link" href="rest-api.html#_consumes_4">Consumes</a></h5>
+<h5 id="_consumes_8"><a class="anchor" href="rest-api.html#_consumes_8"></a><a class="link" href="rest-api.html#_consumes_8">Consumes</a></h5>
<div class="ulist">
<ul>
<li>
@@ -1166,7 +1494,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_produces_4"><a class="anchor" href="rest-api.html#_produces_4"></a><a class="link" href="rest-api.html#_produces_4">Produces</a></h5>
+<h5 id="_produces_8"><a class="anchor" href="rest-api.html#_produces_8"></a><a class="link" href="rest-api.html#_produces_8">Produces</a></h5>
<div class="ulist">
<ul>
<li>
@@ -1176,9 +1504,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_request_4"><a class="anchor" href="rest-api.html#_example_http_request_4"></a><a class="link" href="rest-api.html#_example_http_request_4">Example HTTP request</a></h5>
+<h5 id="_example_http_request_8"><a class="anchor" href="rest-api.html#_example_http_request_8"></a><a class="link" href="rest-api.html#_example_http_request_8">Example HTTP request</a></h5>
<div class="sect5">
-<h6 id="_request_path_4"><a class="anchor" href="rest-api.html#_request_path_4"></a><a class="link" href="rest-api.html#_request_path_4">Request path</a></h6>
+<h6 id="_request_path_8"><a class="anchor" href="rest-api.html#_request_path_8"></a><a class="link" href="rest-api.html#_request_path_8">Request path</a></h6>
<div class="listingblock">
<div class="content">
<pre>/access/token/identity-provider</pre>
@@ -1187,9 +1515,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_response_3"><a class="anchor" href="rest-api.html#_example_http_response_3"></a><a class="link" href="rest-api.html#_example_http_response_3">Example HTTP response</a></h5>
+<h5 id="_example_http_response_4"><a class="anchor" href="rest-api.html#_example_http_response_4"></a><a class="link" href="rest-api.html#_example_http_response_4">Example HTTP response</a></h5>
<div class="sect5">
-<h6 id="_response_200_3"><a class="anchor" href="rest-api.html#_response_200_3"></a><a class="link" href="rest-api.html#_response_200_3">Response 200</a></h6>
+<h6 id="_response_200_4"><a class="anchor" href="rest-api.html#_response_200_4"></a><a class="link" href="rest-api.html#_response_200_4">Response 200</a></h6>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-json" data-lang="json">"string"</code></pre>
@@ -1199,20 +1527,20 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect3">
-<h4 id="_testidentityproviderrecognizescredentialsformat"><a class="anchor" href="rest-api.html#_testidentityproviderrecognizescredentialsformat"></a><a class="link" href="rest-api.html#_testidentityproviderrecognizescredentialsformat">3.1.5. Test identity provider</a></h4>
+<h4 id="_testidentityproviderrecognizescredentialsformat"><a class="anchor" href="rest-api.html#_testidentityproviderrecognizescredentialsformat"></a><a class="link" href="rest-api.html#_testidentityproviderrecognizescredentialsformat">3.1.9. Test identity provider</a></h4>
<div class="literalblock">
<div class="content">
<pre>POST /access/token/identity-provider/test</pre>
</div>
</div>
<div class="sect4">
-<h5 id="_description_5"><a class="anchor" href="rest-api.html#_description_5"></a><a class="link" href="rest-api.html#_description_5">Description</a></h5>
+<h5 id="_description_9"><a class="anchor" href="rest-api.html#_description_9"></a><a class="link" href="rest-api.html#_description_9">Description</a></h5>
<div class="paragraph">
<p>Tests the format of the credentials against this identity provider without preforming authentication on the credentials to validate them. The user credentials should be passed in a format understood by the custom identity provider as defined by 'GET /access/token/identity-provider/usage'.</p>
</div>
</div>
<div class="sect4">
-<h5 id="_responses_5"><a class="anchor" href="rest-api.html#_responses_5"></a><a class="link" href="rest-api.html#_responses_5">Responses</a></h5>
+<h5 id="_responses_9"><a class="anchor" href="rest-api.html#_responses_9"></a><a class="link" href="rest-api.html#_responses_9">Responses</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 10%;">
@@ -1256,7 +1584,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_consumes_5"><a class="anchor" href="rest-api.html#_consumes_5"></a><a class="link" href="rest-api.html#_consumes_5">Consumes</a></h5>
+<h5 id="_consumes_9"><a class="anchor" href="rest-api.html#_consumes_9"></a><a class="link" href="rest-api.html#_consumes_9">Consumes</a></h5>
<div class="ulist">
<ul>
<li>
@@ -1266,7 +1594,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_produces_5"><a class="anchor" href="rest-api.html#_produces_5"></a><a class="link" href="rest-api.html#_produces_5">Produces</a></h5>
+<h5 id="_produces_9"><a class="anchor" href="rest-api.html#_produces_9"></a><a class="link" href="rest-api.html#_produces_9">Produces</a></h5>
<div class="ulist">
<ul>
<li>
@@ -1276,9 +1604,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_request_5"><a class="anchor" href="rest-api.html#_example_http_request_5"></a><a class="link" href="rest-api.html#_example_http_request_5">Example HTTP request</a></h5>
+<h5 id="_example_http_request_9"><a class="anchor" href="rest-api.html#_example_http_request_9"></a><a class="link" href="rest-api.html#_example_http_request_9">Example HTTP request</a></h5>
<div class="sect5">
-<h6 id="_request_path_5"><a class="anchor" href="rest-api.html#_request_path_5"></a><a class="link" href="rest-api.html#_request_path_5">Request path</a></h6>
+<h6 id="_request_path_9"><a class="anchor" href="rest-api.html#_request_path_9"></a><a class="link" href="rest-api.html#_request_path_9">Request path</a></h6>
<div class="listingblock">
<div class="content">
<pre>/access/token/identity-provider/test</pre>
@@ -1287,9 +1615,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_response_4"><a class="anchor" href="rest-api.html#_example_http_response_4"></a><a class="link" href="rest-api.html#_example_http_response_4">Example HTTP response</a></h5>
+<h5 id="_example_http_response_5"><a class="anchor" href="rest-api.html#_example_http_response_5"></a><a class="link" href="rest-api.html#_example_http_response_5">Example HTTP response</a></h5>
<div class="sect5">
-<h6 id="_response_200_4"><a class="anchor" href="rest-api.html#_response_200_4"></a><a class="link" href="rest-api.html#_response_200_4">Response 200</a></h6>
+<h6 id="_response_200_5"><a class="anchor" href="rest-api.html#_response_200_5"></a><a class="link" href="rest-api.html#_response_200_5">Response 200</a></h6>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-json" data-lang="json">"string"</code></pre>
@@ -1299,20 +1627,20 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect3">
-<h4 id="_getidentityproviderusageinstructions"><a class="anchor" href="rest-api.html#_getidentityproviderusageinstructions"></a><a class="link" href="rest-api.html#_getidentityproviderusageinstructions">3.1.6. Get identity provider usage</a></h4>
+<h4 id="_getidentityproviderusageinstructions"><a class="anchor" href="rest-api.html#_getidentityproviderusageinstructions"></a><a class="link" href="rest-api.html#_getidentityproviderusageinstructions">3.1.10. Get identity provider usage</a></h4>
<div class="literalblock">
<div class="content">
<pre>GET /access/token/identity-provider/usage</pre>
</div>
</div>
<div class="sect4">
-<h5 id="_description_6"><a class="anchor" href="rest-api.html#_description_6"></a><a class="link" href="rest-api.html#_description_6">Description</a></h5>
+<h5 id="_description_10"><a class="anchor" href="rest-api.html#_description_10"></a><a class="link" href="rest-api.html#_description_10">Description</a></h5>
<div class="paragraph">
<p>Provides a description of how the currently configured identity provider expects credentials to be passed to POST /access/token/identity-provider</p>
</div>
</div>
<div class="sect4">
-<h5 id="_responses_6"><a class="anchor" href="rest-api.html#_responses_6"></a><a class="link" href="rest-api.html#_responses_6">Responses</a></h5>
+<h5 id="_responses_10"><a class="anchor" href="rest-api.html#_responses_10"></a><a class="link" href="rest-api.html#_responses_10">Responses</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 10%;">
@@ -1351,7 +1679,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_consumes_6"><a class="anchor" href="rest-api.html#_consumes_6"></a><a class="link" href="rest-api.html#_consumes_6">Consumes</a></h5>
+<h5 id="_consumes_10"><a class="anchor" href="rest-api.html#_consumes_10"></a><a class="link" href="rest-api.html#_consumes_10">Consumes</a></h5>
<div class="ulist">
<ul>
<li>
@@ -1361,7 +1689,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_produces_6"><a class="anchor" href="rest-api.html#_produces_6"></a><a class="link" href="rest-api.html#_produces_6">Produces</a></h5>
+<h5 id="_produces_10"><a class="anchor" href="rest-api.html#_produces_10"></a><a class="link" href="rest-api.html#_produces_10">Produces</a></h5>
<div class="ulist">
<ul>
<li>
@@ -1371,9 +1699,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_request_6"><a class="anchor" href="rest-api.html#_example_http_request_6"></a><a class="link" href="rest-api.html#_example_http_request_6">Example HTTP request</a></h5>
+<h5 id="_example_http_request_10"><a class="anchor" href="rest-api.html#_example_http_request_10"></a><a class="link" href="rest-api.html#_example_http_request_10">Example HTTP request</a></h5>
<div class="sect5">
-<h6 id="_request_path_6"><a class="anchor" href="rest-api.html#_request_path_6"></a><a class="link" href="rest-api.html#_request_path_6">Request path</a></h6>
+<h6 id="_request_path_10"><a class="anchor" href="rest-api.html#_request_path_10"></a><a class="link" href="rest-api.html#_request_path_10">Request path</a></h6>
<div class="listingblock">
<div class="content">
<pre>/access/token/identity-provider/usage</pre>
@@ -1382,9 +1710,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_response_5"><a class="anchor" href="rest-api.html#_example_http_response_5"></a><a class="link" href="rest-api.html#_example_http_response_5">Example HTTP response</a></h5>
+<h5 id="_example_http_response_6"><a class="anchor" href="rest-api.html#_example_http_response_6"></a><a class="link" href="rest-api.html#_example_http_response_6">Example HTTP response</a></h5>
<div class="sect5">
-<h6 id="_response_200_5"><a class="anchor" href="rest-api.html#_response_200_5"></a><a class="link" href="rest-api.html#_response_200_5">Response 200</a></h6>
+<h6 id="_response_200_6"><a class="anchor" href="rest-api.html#_response_200_6"></a><a class="link" href="rest-api.html#_response_200_6">Response 200</a></h6>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-json" data-lang="json">"string"</code></pre>
@@ -1394,20 +1722,20 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect3">
-<h4 id="_createaccesstokenusingkerberosticket"><a class="anchor" href="rest-api.html#_createaccesstokenusingkerberosticket"></a><a class="link" href="rest-api.html#_createaccesstokenusingkerberosticket">3.1.7. Create token using kerberos</a></h4>
+<h4 id="_createaccesstokenusingkerberosticket"><a class="anchor" href="rest-api.html#_createaccesstokenusingkerberosticket"></a><a class="link" href="rest-api.html#_createaccesstokenusingkerberosticket">3.1.11. Create token using kerberos</a></h4>
<div class="literalblock">
<div class="content">
<pre>POST /access/token/kerberos</pre>
</div>
</div>
<div class="sect4">
-<h5 id="_description_7"><a class="anchor" href="rest-api.html#_description_7"></a><a class="link" href="rest-api.html#_description_7">Description</a></h5>
+<h5 id="_description_11"><a class="anchor" href="rest-api.html#_description_11"></a><a class="link" href="rest-api.html#_description_11">Description</a></h5>
<div class="paragraph">
<p>Creates a token for accessing the REST API via Kerberos Service Tickets or SPNEGO Tokens (which includes Kerberos Service Tickets). The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer <token>'.</p>
</div>
</div>
<div class="sect4">
-<h5 id="_responses_7"><a class="anchor" href="rest-api.html#_responses_7"></a><a class="link" href="rest-api.html#_responses_7">Responses</a></h5>
+<h5 id="_responses_11"><a class="anchor" href="rest-api.html#_responses_11"></a><a class="link" href="rest-api.html#_responses_11">Responses</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 10%;">
@@ -1451,7 +1779,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_consumes_7"><a class="anchor" href="rest-api.html#_consumes_7"></a><a class="link" href="rest-api.html#_consumes_7">Consumes</a></h5>
+<h5 id="_consumes_11"><a class="anchor" href="rest-api.html#_consumes_11"></a><a class="link" href="rest-api.html#_consumes_11">Consumes</a></h5>
<div class="ulist">
<ul>
<li>
@@ -1461,7 +1789,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_produces_7"><a class="anchor" href="rest-api.html#_produces_7"></a><a class="link" href="rest-api.html#_produces_7">Produces</a></h5>
+<h5 id="_produces_11"><a class="anchor" href="rest-api.html#_produces_11"></a><a class="link" href="rest-api.html#_produces_11">Produces</a></h5>
<div class="ulist">
<ul>
<li>
@@ -1471,9 +1799,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_request_7"><a class="anchor" href="rest-api.html#_example_http_request_7"></a><a class="link" href="rest-api.html#_example_http_request_7">Example HTTP request</a></h5>
+<h5 id="_example_http_request_11"><a class="anchor" href="rest-api.html#_example_http_request_11"></a><a class="link" href="rest-api.html#_example_http_request_11">Example HTTP request</a></h5>
<div class="sect5">
-<h6 id="_request_path_7"><a class="anchor" href="rest-api.html#_request_path_7"></a><a class="link" href="rest-api.html#_request_path_7">Request path</a></h6>
+<h6 id="_request_path_11"><a class="anchor" href="rest-api.html#_request_path_11"></a><a class="link" href="rest-api.html#_request_path_11">Request path</a></h6>
<div class="listingblock">
<div class="content">
<pre>/access/token/kerberos</pre>
@@ -1482,9 +1810,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_response_6"><a class="anchor" href="rest-api.html#_example_http_response_6"></a><a class="link" href="rest-api.html#_example_http_response_6">Example HTTP response</a></h5>
+<h5 id="_example_http_response_7"><a class="anchor" href="rest-api.html#_example_http_response_7"></a><a class="link" href="rest-api.html#_example_http_response_7">Example HTTP response</a></h5>
<div class="sect5">
-<h6 id="_response_200_6"><a class="anchor" href="rest-api.html#_response_200_6"></a><a class="link" href="rest-api.html#_response_200_6">Response 200</a></h6>
+<h6 id="_response_200_7"><a class="anchor" href="rest-api.html#_response_200_7"></a><a class="link" href="rest-api.html#_response_200_7">Response 200</a></h6>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-json" data-lang="json">"string"</code></pre>
@@ -1494,20 +1822,20 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect3">
-<h4 id="_createaccesstokenusingbasicauthcredentials"><a class="anchor" href="rest-api.html#_createaccesstokenusingbasicauthcredentials"></a><a class="link" href="rest-api.html#_createaccesstokenusingbasicauthcredentials">3.1.8. Create token using basic auth</a></h4>
+<h4 id="_createaccesstokenusingbasicauthcredentials"><a class="anchor" href="rest-api.html#_createaccesstokenusingbasicauthcredentials"></a><a class="link" href="rest-api.html#_createaccesstokenusingbasicauthcredentials">3.1.12. Create token using basic auth</a></h4>
<div class="literalblock">
<div class="content">
<pre>POST /access/token/login</pre>
</div>
</div>
<div class="sect4">
-<h5 id="_description_8"><a class="anchor" href="rest-api.html#_description_8"></a><a class="link" href="rest-api.html#_description_8">Description</a></h5>
+<h5 id="_description_12"><a class="anchor" href="rest-api.html#_description_12"></a><a class="link" href="rest-api.html#_description_12">Description</a></h5>
<div class="paragraph">
<p>Creates a token for accessing the REST API via username/password. The user credentials must be passed in standard HTTP Basic Auth format. That is: 'Authorization: Basic <credentials>', where <credentials> is the base64 encoded value of '<username>:<password>'. The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer <token>'.</p>
</div>
</div>
<div class="sect4">
-<h5 id="_responses_8"><a class="anchor" href="rest-api.html#_responses_8"></a><a class="link" href="rest-api.html#_responses_8">Responses</a></h5>
+<h5 id="_responses_12"><a class="anchor" href="rest-api.html#_responses_12"></a><a class="link" href="rest-api.html#_responses_12">Responses</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 10%;">
@@ -1551,7 +1879,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_consumes_8"><a class="anchor" href="rest-api.html#_consumes_8"></a><a class="link" href="rest-api.html#_consumes_8">Consumes</a></h5>
+<h5 id="_consumes_12"><a class="anchor" href="rest-api.html#_consumes_12"></a><a class="link" href="rest-api.html#_consumes_12">Consumes</a></h5>
<div class="ulist">
<ul>
<li>
@@ -1561,7 +1889,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_produces_8"><a class="anchor" href="rest-api.html#_produces_8"></a><a class="link" href="rest-api.html#_produces_8">Produces</a></h5>
+<h5 id="_produces_12"><a class="anchor" href="rest-api.html#_produces_12"></a><a class="link" href="rest-api.html#_produces_12">Produces</a></h5>
<div class="ulist">
<ul>
<li>
@@ -1592,9 +1920,9 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_example_http_request_8"><a class="anchor" href="rest-api.html#_example_http_request_8"></a><a class="link" href="rest-api.html#_example_http_request_8">Example HTTP request</a></h5>
+<h5 id="_example_http_request_12"><a class="anchor" href="rest-api.html#_example_http_request_12"></a><a class="link" href="rest-api.html#_example_http_request_12">Example HTTP request</a></h5>
<div class="sect5">
-<h6 id="_request_path_8"><a class="anchor" href="rest-api.html#_request_path_8"></a><a class="link" href="rest-api.html#_request_path_8">Request path</a></h6>
+<h6 id="_request_path_12"><a class="anchor" href="rest-api.html#_request_path_12"></a><a class="link" href="rest-api.html#_request_path_12">Request path</a></h6>
<div class="listingblock">
<div class="content">
<pre>/access/token/login</pre>
@@ -1603,9 +1931,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_response_7"><a class="anchor" href="rest-api.html#_example_http_response_7"></a><a class="link" href="rest-api.html#_example_http_response_7">Example HTTP response</a></h5>
+<h5 id="_example_http_response_8"><a class="anchor" href="rest-api.html#_example_http_response_8"></a><a class="link" href="rest-api.html#_example_http_response_8">Example HTTP response</a></h5>
<div class="sect5">
-<h6 id="_response_200_7"><a class="anchor" href="rest-api.html#_response_200_7"></a><a class="link" href="rest-api.html#_response_200_7">Response 200</a></h6>
+<h6 id="_response_200_8"><a class="anchor" href="rest-api.html#_response_200_8"></a><a class="link" href="rest-api.html#_response_200_8">Response 200</a></h6>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-json" data-lang="json">"string"</code></pre>
@@ -1628,7 +1956,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_description_9"><a class="anchor" href="rest-api.html#_description_9"></a><a class="link" href="rest-api.html#_description_9">Description</a></h5>
+<h5 id="_description_13"><a class="anchor" href="rest-api.html#_description_13"></a><a class="link" href="rest-api.html#_description_13">Description</a></h5>
<div class="admonitionblock note">
<table>
<tr>
@@ -1671,7 +1999,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_responses_9"><a class="anchor" href="rest-api.html#_responses_9"></a><a class="link" href="rest-api.html#_responses_9">Responses</a></h5>
+<h5 id="_responses_13"><a class="anchor" href="rest-api.html#_responses_13"></a><a class="link" href="rest-api.html#_responses_13">Responses</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 10%;">
@@ -1720,7 +2048,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_consumes_9"><a class="anchor" href="rest-api.html#_consumes_9"></a><a class="link" href="rest-api.html#_consumes_9">Consumes</a></h5>
+<h5 id="_consumes_13"><a class="anchor" href="rest-api.html#_consumes_13"></a><a class="link" href="rest-api.html#_consumes_13">Consumes</a></h5>
<div class="ulist">
<ul>
<li>
@@ -1730,7 +2058,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_produces_9"><a class="anchor" href="rest-api.html#_produces_9"></a><a class="link" href="rest-api.html#_produces_9">Produces</a></h5>
+<h5 id="_produces_13"><a class="anchor" href="rest-api.html#_produces_13"></a><a class="link" href="rest-api.html#_produces_13">Produces</a></h5>
<div class="ulist">
<ul>
<li>
@@ -1761,9 +2089,9 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_example_http_request_9"><a class="anchor" href="rest-api.html#_example_http_request_9"></a><a class="link" href="rest-api.html#_example_http_request_9">Example HTTP request</a></h5>
+<h5 id="_example_http_request_13"><a class="anchor" href="rest-api.html#_example_http_request_13"></a><a class="link" href="rest-api.html#_example_http_request_13">Example HTTP request</a></h5>
<div class="sect5">
-<h6 id="_request_path_9"><a class="anchor" href="rest-api.html#_request_path_9"></a><a class="link" href="rest-api.html#_request_path_9">Request path</a></h6>
+<h6 id="_request_path_13"><a class="anchor" href="rest-api.html#_request_path_13"></a><a class="link" href="rest-api.html#_request_path_13">Request path</a></h6>
<div class="listingblock">
<div class="content">
<pre>/buckets/string/bundles</pre>
@@ -1772,9 +2100,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_response_8"><a class="anchor" href="rest-api.html#_example_http_response_8"></a><a class="link" href="rest-api.html#_example_http_response_8">Example HTTP response</a></h5>
+<h5 id="_example_http_response_9"><a class="anchor" href="rest-api.html#_example_http_response_9"></a><a class="link" href="rest-api.html#_example_http_response_9">Example HTTP response</a></h5>
<div class="sect5">
-<h6 id="_response_200_8"><a class="anchor" href="rest-api.html#_response_200_8"></a><a class="link" href="rest-api.html#_response_200_8">Response 200</a></h6>
+<h6 id="_response_200_9"><a class="anchor" href="rest-api.html#_response_200_9"></a><a class="link" href="rest-api.html#_response_200_9">Response 200</a></h6>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-json" data-lang="json">[ {
@@ -1815,7 +2143,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_description_10"><a class="anchor" href="rest-api.html#_description_10"></a><a class="link" href="rest-api.html#_description_10">Description</a></h5>
+<h5 id="_description_14"><a class="anchor" href="rest-api.html#_description_14"></a><a class="link" href="rest-api.html#_description_14">Description</a></h5>
<div class="paragraph">
<p>Creates a version of an extension bundle by uploading a binary artifact. If an extension bundle already exists in the given bucket with the same group id and artifact id as that of the bundle being uploaded, then it will be added as a new version to the existing bundle. If an extension bundle does not already exist in the given bucket with the same group id and artifact id, then a new extension bundle will be created and this version will be added to the new bundle. Client’s may optionally supply a SHA-256 in hex format through the multi-part form field 'sha256'. If supplied, then this value will be compared against the SHA-256 computed by the server, and the bundle will be rejected if the values do not match. If not supplied, the bundle will be accepted, but will be marked to indicate that the client did not supply a SHA-256 during creation.</p>
</div>
@@ -1868,7 +2196,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_responses_10"><a class="anchor" href="rest-api.html#_responses_10"></a><a class="link" href="rest-api.html#_responses_10">Responses</a></h5>
+<h5 id="_responses_14"><a class="anchor" href="rest-api.html#_responses_14"></a><a class="link" href="rest-api.html#_responses_14">Responses</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 10%;">
@@ -1917,7 +2245,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_consumes_10"><a class="anchor" href="rest-api.html#_consumes_10"></a><a class="link" href="rest-api.html#_consumes_10">Consumes</a></h5>
+<h5 id="_consumes_14"><a class="anchor" href="rest-api.html#_consumes_14"></a><a class="link" href="rest-api.html#_consumes_14">Consumes</a></h5>
<div class="ulist">
<ul>
<li>
@@ -1927,7 +2255,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_produces_10"><a class="anchor" href="rest-api.html#_produces_10"></a><a class="link" href="rest-api.html#_produces_10">Produces</a></h5>
+<h5 id="_produces_14"><a class="anchor" href="rest-api.html#_produces_14"></a><a class="link" href="rest-api.html#_produces_14">Produces</a></h5>
<div class="ulist">
<ul>
<li>
@@ -1958,9 +2286,9 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_example_http_request_10"><a class="anchor" href="rest-api.html#_example_http_request_10"></a><a class="link" href="rest-api.html#_example_http_request_10">Example HTTP request</a></h5>
+<h5 id="_example_http_request_14"><a class="anchor" href="rest-api.html#_example_http_request_14"></a><a class="link" href="rest-api.html#_example_http_request_14">Example HTTP request</a></h5>
<div class="sect5">
-<h6 id="_request_path_10"><a class="anchor" href="rest-api.html#_request_path_10"></a><a class="link" href="rest-api.html#_request_path_10">Request path</a></h6>
+<h6 id="_request_path_14"><a class="anchor" href="rest-api.html#_request_path_14"></a><a class="link" href="rest-api.html#_request_path_14">Request path</a></h6>
<div class="listingblock">
<div class="content">
<pre>/buckets/string/bundles/string</pre>
@@ -1969,9 +2297,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_response_9"><a class="anchor" href="rest-api.html#_example_http_response_9"></a><a class="link" href="rest-api.html#_example_http_response_9">Example HTTP response</a></h5>
+<h5 id="_example_http_response_10"><a class="anchor" href="rest-api.html#_example_http_response_10"></a><a class="link" href="rest-api.html#_example_http_response_10">Example HTTP response</a></h5>
<div class="sect5">
-<h6 id="_response_200_9"><a class="anchor" href="rest-api.html#_response_200_9"></a><a class="link" href="rest-api.html#_response_200_9">Response 200</a></h6>
+<h6 id="_response_200_10"><a class="anchor" href="rest-api.html#_response_200_10"></a><a class="link" href="rest-api.html#_response_200_10">Response 200</a></h6>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-json" data-lang="json">{
@@ -1991,6 +2319,8 @@ This endpoint is subject to change as Ni
"id" : "string",
"bundleId" : "string",
"bucketId" : "string",
+ "groupId" : "string",
+ "artifactId" : "string",
"version" : "string",
"timestamp" : 0,
"author" : "string",
@@ -2084,7 +2414,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_description_11"><a class="anchor" href="rest-api.html#_description_11"></a><a class="link" href="rest-api.html#_description_11">Description</a></h5>
+<h5 id="_description_15"><a class="anchor" href="rest-api.html#_description_15"></a><a class="link" href="rest-api.html#_description_15">Description</a></h5>
<div class="paragraph">
<p>Creates a flow in the given bucket. The flow id is created by the server and populated in the returned entity.</p>
</div>
@@ -2125,7 +2455,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_responses_11"><a class="anchor" href="rest-api.html#_responses_11"></a><a class="link" href="rest-api.html#_responses_11">Responses</a></h5>
+<h5 id="_responses_15"><a class="anchor" href="rest-api.html#_responses_15"></a><a class="link" href="rest-api.html#_responses_15">Responses</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 10%;">
@@ -2174,7 +2504,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_consumes_11"><a class="anchor" href="rest-api.html#_consumes_11"></a><a class="link" href="rest-api.html#_consumes_11">Consumes</a></h5>
+<h5 id="_consumes_15"><a class="anchor" href="rest-api.html#_consumes_15"></a><a class="link" href="rest-api.html#_consumes_15">Consumes</a></h5>
<div class="ulist">
<ul>
<li>
@@ -2184,7 +2514,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_produces_11"><a class="anchor" href="rest-api.html#_produces_11"></a><a class="link" href="rest-api.html#_produces_11">Produces</a></h5>
+<h5 id="_produces_15"><a class="anchor" href="rest-api.html#_produces_15"></a><a class="link" href="rest-api.html#_produces_15">Produces</a></h5>
<div class="ulist">
<ul>
<li>
@@ -2215,9 +2545,9 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_example_http_request_11"><a class="anchor" href="rest-api.html#_example_http_request_11"></a><a class="link" href="rest-api.html#_example_http_request_11">Example HTTP request</a></h5>
+<h5 id="_example_http_request_15"><a class="anchor" href="rest-api.html#_example_http_request_15"></a><a class="link" href="rest-api.html#_example_http_request_15">Example HTTP request</a></h5>
<div class="sect5">
-<h6 id="_request_path_11"><a class="anchor" href="rest-api.html#_request_path_11"></a><a class="link" href="rest-api.html#_request_path_11">Request path</a></h6>
+<h6 id="_request_path_15"><a class="anchor" href="rest-api.html#_request_path_15"></a><a class="link" href="rest-api.html#_request_path_15">Request path</a></h6>
<div class="listingblock">
<div class="content">
<pre>/buckets/string/flows</pre>
@@ -2260,9 +2590,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_response_10"><a class="anchor" href="rest-api.html#_example_http_response_10"></a><a class="link" href="rest-api.html#_example_http_response_10">Example HTTP response</a></h5>
+<h5 id="_example_http_response_11"><a class="anchor" href="rest-api.html#_example_http_response_11"></a><a class="link" href="rest-api.html#_example_http_response_11">Example HTTP response</a></h5>
<div class="sect5">
-<h6 id="_response_200_10"><a class="anchor" href="rest-api.html#_response_200_10"></a><a class="link" href="rest-api.html#_response_200_10">Response 200</a></h6>
+<h6 id="_response_200_11"><a class="anchor" href="rest-api.html#_response_200_11"></a><a class="link" href="rest-api.html#_response_200_11">Response 200</a></h6>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-json" data-lang="json">{
@@ -2305,7 +2635,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_description_12"><a class="anchor" href="rest-api.html#_description_12"></a><a class="link" href="rest-api.html#_description_12">Description</a></h5>
+<h5 id="_description_16"><a class="anchor" href="rest-api.html#_description_16"></a><a class="link" href="rest-api.html#_description_16">Description</a></h5>
<div class="paragraph">
<p>Retrieves all flows in the given bucket.</p>
</div>
@@ -2339,7 +2669,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_responses_12"><a class="anchor" href="rest-api.html#_responses_12"></a><a class="link" href="rest-api.html#_responses_12">Responses</a></h5>
+<h5 id="_responses_16"><a class="anchor" href="rest-api.html#_responses_16"></a><a class="link" href="rest-api.html#_responses_16">Responses</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 10%;">
@@ -2388,7 +2718,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_consumes_12"><a class="anchor" href="rest-api.html#_consumes_12"></a><a class="link" href="rest-api.html#_consumes_12">Consumes</a></h5>
+<h5 id="_consumes_16"><a class="anchor" href="rest-api.html#_consumes_16"></a><a class="link" href="rest-api.html#_consumes_16">Consumes</a></h5>
<div class="ulist">
<ul>
<li>
@@ -2398,7 +2728,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_produces_12"><a class="anchor" href="rest-api.html#_produces_12"></a><a class="link" href="rest-api.html#_produces_12">Produces</a></h5>
+<h5 id="_produces_16"><a class="anchor" href="rest-api.html#_produces_16"></a><a class="link" href="rest-api.html#_produces_16">Produces</a></h5>
<div class="ulist">
<ul>
<li>
@@ -2429,9 +2759,9 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_example_http_request_12"><a class="anchor" href="rest-api.html#_example_http_request_12"></a><a class="link" href="rest-api.html#_example_http_request_12">Example HTTP request</a></h5>
+<h5 id="_example_http_request_16"><a class="anchor" href="rest-api.html#_example_http_request_16"></a><a class="link" href="rest-api.html#_example_http_request_16">Example HTTP request</a></h5>
<div class="sect5">
-<h6 id="_request_path_12"><a class="anchor" href="rest-api.html#_request_path_12"></a><a class="link" href="rest-api.html#_request_path_12">Request path</a></h6>
+<h6 id="_request_path_16"><a class="anchor" href="rest-api.html#_request_path_16"></a><a class="link" href="rest-api.html#_request_path_16">Request path</a></h6>
<div class="listingblock">
<div class="content">
<pre>/buckets/string/flows</pre>
@@ -2440,9 +2770,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_response_11"><a class="anchor" href="rest-api.html#_example_http_response_11"></a><a class="link" href="rest-api.html#_example_http_response_11">Example HTTP response</a></h5>
+<h5 id="_example_http_response_12"><a class="anchor" href="rest-api.html#_example_http_response_12"></a><a class="link" href="rest-api.html#_example_http_response_12">Example HTTP response</a></h5>
<div class="sect5">
-<h6 id="_response_200_11"><a class="anchor" href="rest-api.html#_response_200_11"></a><a class="link" href="rest-api.html#_response_200_11">Response 200</a></h6>
+<h6 id="_response_200_12"><a class="anchor" href="rest-api.html#_response_200_12"></a><a class="link" href="rest-api.html#_response_200_12">Response 200</a></h6>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-json" data-lang="json">[ {
@@ -2485,7 +2815,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_description_13"><a class="anchor" href="rest-api.html#_description_13"></a><a class="link" href="rest-api.html#_description_13">Description</a></h5>
+<h5 id="_description_17"><a class="anchor" href="rest-api.html#_description_17"></a><a class="link" href="rest-api.html#_description_17">Description</a></h5>
<div class="paragraph">
<p>Retrieves the flow with the given id in the given bucket.</p>
</div>
@@ -2526,7 +2856,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_responses_13"><a class="anchor" href="rest-api.html#_responses_13"></a><a class="link" href="rest-api.html#_responses_13">Responses</a></h5>
+<h5 id="_responses_17"><a class="anchor" href="rest-api.html#_responses_17"></a><a class="link" href="rest-api.html#_responses_17">Responses</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 10%;">
@@ -2575,7 +2905,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_consumes_13"><a class="anchor" href="rest-api.html#_consumes_13"></a><a class="link" href="rest-api.html#_consumes_13">Consumes</a></h5>
+<h5 id="_consumes_17"><a class="anchor" href="rest-api.html#_consumes_17"></a><a class="link" href="rest-api.html#_consumes_17">Consumes</a></h5>
<div class="ulist">
<ul>
<li>
@@ -2585,7 +2915,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_produces_13"><a class="anchor" href="rest-api.html#_produces_13"></a><a class="link" href="rest-api.html#_produces_13">Produces</a></h5>
+<h5 id="_produces_17"><a class="anchor" href="rest-api.html#_produces_17"></a><a class="link" href="rest-api.html#_produces_17">Produces</a></h5>
<div class="ulist">
<ul>
<li>
@@ -2616,9 +2946,9 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_example_http_request_13"><a class="anchor" href="rest-api.html#_example_http_request_13"></a><a class="link" href="rest-api.html#_example_http_request_13">Example HTTP request</a></h5>
+<h5 id="_example_http_request_17"><a class="anchor" href="rest-api.html#_example_http_request_17"></a><a class="link" href="rest-api.html#_example_http_request_17">Example HTTP request</a></h5>
<div class="sect5">
-<h6 id="_request_path_13"><a class="anchor" href="rest-api.html#_request_path_13"></a><a class="link" href="rest-api.html#_request_path_13">Request path</a></h6>
+<h6 id="_request_path_17"><a class="anchor" href="rest-api.html#_request_path_17"></a><a class="link" href="rest-api.html#_request_path_17">Request path</a></h6>
<div class="listingblock">
<div class="content">
<pre>/buckets/string/flows/string</pre>
@@ -2627,9 +2957,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_response_12"><a class="anchor" href="rest-api.html#_example_http_response_12"></a><a class="link" href="rest-api.html#_example_http_response_12">Example HTTP response</a></h5>
+<h5 id="_example_http_response_13"><a class="anchor" href="rest-api.html#_example_http_response_13"></a><a class="link" href="rest-api.html#_example_http_response_13">Example HTTP response</a></h5>
<div class="sect5">
-<h6 id="_response_200_12"><a class="anchor" href="rest-api.html#_response_200_12"></a><a class="link" href="rest-api.html#_response_200_12">Response 200</a></h6>
+<h6 id="_response_200_13"><a class="anchor" href="rest-api.html#_response_200_13"></a><a class="link" href="rest-api.html#_response_200_13">Response 200</a></h6>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-json" data-lang="json">{
@@ -2672,7 +3002,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_description_14"><a class="anchor" href="rest-api.html#_description_14"></a><a class="link" href="rest-api.html#_description_14">Description</a></h5>
+<h5 id="_description_18"><a class="anchor" href="rest-api.html#_description_18"></a><a class="link" href="rest-api.html#_description_18">Description</a></h5>
<div class="paragraph">
<p>Updates the flow with the given id in the given bucket.</p>
</div>
@@ -2720,7 +3050,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_responses_14"><a class="anchor" href="rest-api.html#_responses_14"></a><a class="link" href="rest-api.html#_responses_14">Responses</a></h5>
+<h5 id="_responses_18"><a class="anchor" href="rest-api.html#_responses_18"></a><a class="link" href="rest-api.html#_responses_18">Responses</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 10%;">
@@ -2769,7 +3099,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_consumes_14"><a class="anchor" href="rest-api.html#_consumes_14"></a><a class="link" href="rest-api.html#_consumes_14">Consumes</a></h5>
+<h5 id="_consumes_18"><a class="anchor" href="rest-api.html#_consumes_18"></a><a class="link" href="rest-api.html#_consumes_18">Consumes</a></h5>
<div class="ulist">
<ul>
<li>
@@ -2779,7 +3109,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_produces_14"><a class="anchor" href="rest-api.html#_produces_14"></a><a class="link" href="rest-api.html#_produces_14">Produces</a></h5>
+<h5 id="_produces_18"><a class="anchor" href="rest-api.html#_produces_18"></a><a class="link" href="rest-api.html#_produces_18">Produces</a></h5>
<div class="ulist">
<ul>
<li>
@@ -2810,9 +3140,9 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_example_http_request_14"><a class="anchor" href="rest-api.html#_example_http_request_14"></a><a class="link" href="rest-api.html#_example_http_request_14">Example HTTP request</a></h5>
+<h5 id="_example_http_request_18"><a class="anchor" href="rest-api.html#_example_http_request_18"></a><a class="link" href="rest-api.html#_example_http_request_18">Example HTTP request</a></h5>
<div class="sect5">
-<h6 id="_request_path_14"><a class="anchor" href="rest-api.html#_request_path_14"></a><a class="link" href="rest-api.html#_request_path_14">Request path</a></h6>
+<h6 id="_request_path_18"><a class="anchor" href="rest-api.html#_request_path_18"></a><a class="link" href="rest-api.html#_request_path_18">Request path</a></h6>
<div class="listingblock">
<div class="content">
<pre>/buckets/string/flows/string</pre>
@@ -2855,9 +3185,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_response_13"><a class="anchor" href="rest-api.html#_example_http_response_13"></a><a class="link" href="rest-api.html#_example_http_response_13">Example HTTP response</a></h5>
+<h5 id="_example_http_response_14"><a class="anchor" href="rest-api.html#_example_http_response_14"></a><a class="link" href="rest-api.html#_example_http_response_14">Example HTTP response</a></h5>
<div class="sect5">
-<h6 id="_response_200_13"><a class="anchor" href="rest-api.html#_response_200_13"></a><a class="link" href="rest-api.html#_response_200_13">Response 200</a></h6>
+<h6 id="_response_200_14"><a class="anchor" href="rest-api.html#_response_200_14"></a><a class="link" href="rest-api.html#_response_200_14">Response 200</a></h6>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-json" data-lang="json">{
@@ -2900,7 +3230,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_description_15"><a class="anchor" href="rest-api.html#_description_15"></a><a class="link" href="rest-api.html#_description_15">Description</a></h5>
+<h5 id="_description_19"><a class="anchor" href="rest-api.html#_description_19"></a><a class="link" href="rest-api.html#_description_19">Description</a></h5>
<div class="paragraph">
<p>Deletes a flow, including all saved versions of that flow.</p>
</div>
@@ -2955,7 +3285,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_responses_15"><a class="anchor" href="rest-api.html#_responses_15"></a><a class="link" href="rest-api.html#_responses_15">Responses</a></h5>
+<h5 id="_responses_19"><a class="anchor" href="rest-api.html#_responses_19"></a><a class="link" href="rest-api.html#_responses_19">Responses</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 10%;">
@@ -2999,7 +3329,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_consumes_15"><a class="anchor" href="rest-api.html#_consumes_15"></a><a class="link" href="rest-api.html#_consumes_15">Consumes</a></h5>
+<h5 id="_consumes_19"><a class="anchor" href="rest-api.html#_consumes_19"></a><a class="link" href="rest-api.html#_consumes_19">Consumes</a></h5>
<div class="ulist">
<ul>
<li>
@@ -3009,7 +3339,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_produces_15"><a class="anchor" href="rest-api.html#_produces_15"></a><a class="link" href="rest-api.html#_produces_15">Produces</a></h5>
+<h5 id="_produces_19"><a class="anchor" href="rest-api.html#_produces_19"></a><a class="link" href="rest-api.html#_produces_19">Produces</a></h5>
<div class="ulist">
<ul>
<li>
@@ -3040,9 +3370,9 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_example_http_request_15"><a class="anchor" href="rest-api.html#_example_http_request_15"></a><a class="link" href="rest-api.html#_example_http_request_15">Example HTTP request</a></h5>
+<h5 id="_example_http_request_19"><a class="anchor" href="rest-api.html#_example_http_request_19"></a><a class="link" href="rest-api.html#_example_http_request_19">Example HTTP request</a></h5>
<div class="sect5">
-<h6 id="_request_path_15"><a class="anchor" href="rest-api.html#_request_path_15"></a><a class="link" href="rest-api.html#_request_path_15">Request path</a></h6>
+<h6 id="_request_path_19"><a class="anchor" href="rest-api.html#_request_path_19"></a><a class="link" href="rest-api.html#_request_path_19">Request path</a></h6>
<div class="listingblock">
<div class="content">
<pre>/buckets/string/flows/string</pre>
@@ -3062,9 +3392,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_response_14"><a class="anchor" href="rest-api.html#_example_http_response_14"></a><a class="link" href="rest-api.html#_example_http_response_14">Example HTTP response</a></h5>
+<h5 id="_example_http_response_15"><a class="anchor" href="rest-api.html#_example_http_response_15"></a><a class="link" href="rest-api.html#_example_http_response_15">Example HTTP response</a></h5>
<div class="sect5">
-<h6 id="_response_200_14"><a class="anchor" href="rest-api.html#_response_200_14"></a><a class="link" href="rest-api.html#_response_200_14">Response 200</a></h6>
+<h6 id="_response_200_15"><a class="anchor" href="rest-api.html#_response_200_15"></a><a class="link" href="rest-api.html#_response_200_15">Response 200</a></h6>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-json" data-lang="json">{
@@ -3107,7 +3437,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_description_16"><a class="anchor" href="rest-api.html#_description_16"></a><a class="link" href="rest-api.html#_description_16">Description</a></h5>
+<h5 id="_description_20"><a class="anchor" href="rest-api.html#_description_20"></a><a class="link" href="rest-api.html#_description_20">Description</a></h5>
<div class="paragraph">
<p>Computes the differences between two given versions of a flow.</p>
</div>
@@ -3162,7 +3492,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_responses_16"><a class="anchor" href="rest-api.html#_responses_16"></a><a class="link" href="rest-api.html#_responses_16">Responses</a></h5>
+<h5 id="_responses_20"><a class="anchor" href="rest-api.html#_responses_20"></a><a class="link" href="rest-api.html#_responses_20">Responses</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 10%;">
@@ -3211,7 +3541,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_consumes_16"><a class="anchor" href="rest-api.html#_consumes_16"></a><a class="link" href="rest-api.html#_consumes_16">Consumes</a></h5>
+<h5 id="_consumes_20"><a class="anchor" href="rest-api.html#_consumes_20"></a><a class="link" href="rest-api.html#_consumes_20">Consumes</a></h5>
<div class="ulist">
<ul>
<li>
@@ -3221,7 +3551,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_produces_16"><a class="anchor" href="rest-api.html#_produces_16"></a><a class="link" href="rest-api.html#_produces_16">Produces</a></h5>
+<h5 id="_produces_20"><a class="anchor" href="rest-api.html#_produces_20"></a><a class="link" href="rest-api.html#_produces_20">Produces</a></h5>
<div class="ulist">
<ul>
<li>
@@ -3252,9 +3582,9 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_example_http_request_16"><a class="anchor" href="rest-api.html#_example_http_request_16"></a><a class="link" href="rest-api.html#_example_http_request_16">Example HTTP request</a></h5>
+<h5 id="_example_http_request_20"><a class="anchor" href="rest-api.html#_example_http_request_20"></a><a class="link" href="rest-api.html#_example_http_request_20">Example HTTP request</a></h5>
<div class="sect5">
-<h6 id="_request_path_16"><a class="anchor" href="rest-api.html#_request_path_16"></a><a class="link" href="rest-api.html#_request_path_16">Request path</a></h6>
+<h6 id="_request_path_20"><a class="anchor" href="rest-api.html#_request_path_20"></a><a class="link" href="rest-api.html#_request_path_20">Request path</a></h6>
<div class="listingblock">
<div class="content">
<pre>/buckets/string/flows/string/diff/0/0</pre>
@@ -3263,9 +3593,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_response_15"><a class="anchor" href="rest-api.html#_example_http_response_15"></a><a class="link" href="rest-api.html#_example_http_response_15">Example HTTP response</a></h5>
+<h5 id="_example_http_response_16"><a class="anchor" href="rest-api.html#_example_http_response_16"></a><a class="link" href="rest-api.html#_example_http_response_16">Example HTTP response</a></h5>
<div class="sect5">
-<h6 id="_response_200_15"><a class="anchor" href="rest-api.html#_response_200_15"></a><a class="link" href="rest-api.html#_response_200_15">Response 200</a></h6>
+<h6 id="_response_200_16"><a class="anchor" href="rest-api.html#_response_200_16"></a><a class="link" href="rest-api.html#_response_200_16">Response 200</a></h6>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-json" data-lang="json">{
@@ -3300,7 +3630,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_description_17"><a class="anchor" href="rest-api.html#_description_17"></a><a class="link" href="rest-api.html#_description_17">Description</a></h5>
+<h5 id="_description_21"><a class="anchor" href="rest-api.html#_description_21"></a><a class="link" href="rest-api.html#_description_21">Description</a></h5>
<div class="paragraph">
<p>Creates the next version of a flow. The version number of the object being created must be the next available version integer. Flow versions are immutable after they are created.</p>
</div>
@@ -3348,7 +3678,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_responses_17"><a class="anchor" href="rest-api.html#_responses_17"></a><a class="link" href="rest-api.html#_responses_17">Responses</a></h5>
+<h5 id="_responses_21"><a class="anchor" href="rest-api.html#_responses_21"></a><a class="link" href="rest-api.html#_responses_21">Responses</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 10%;">
@@ -3397,7 +3727,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_consumes_17"><a class="anchor" href="rest-api.html#_consumes_17"></a><a class="link" href="rest-api.html#_consumes_17">Consumes</a></h5>
+<h5 id="_consumes_21"><a class="anchor" href="rest-api.html#_consumes_21"></a><a class="link" href="rest-api.html#_consumes_21">Consumes</a></h5>
<div class="ulist">
<ul>
<li>
@@ -3407,7 +3737,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_produces_17"><a class="anchor" href="rest-api.html#_produces_17"></a><a class="link" href="rest-api.html#_produces_17">Produces</a></h5>
+<h5 id="_produces_21"><a class="anchor" href="rest-api.html#_produces_21"></a><a class="link" href="rest-api.html#_produces_21">Produces</a></h5>
<div class="ulist">
<ul>
<li>
@@ -3438,9 +3768,9 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_example_http_request_17"><a class="anchor" href="rest-api.html#_example_http_request_17"></a><a class="link" href="rest-api.html#_example_http_request_17">Example HTTP request</a></h5>
+<h5 id="_example_http_request_21"><a class="anchor" href="rest-api.html#_example_http_request_21"></a><a class="link" href="rest-api.html#_example_http_request_21">Example HTTP request</a></h5>
<div class="sect5">
-<h6 id="_request_path_17"><a class="anchor" href="rest-api.html#_request_path_17"></a><a class="link" href="rest-api.html#_request_path_17">Request path</a></h6>
+<h6 id="_request_path_21"><a class="anchor" href="rest-api.html#_request_path_21"></a><a class="link" href="rest-api.html#_request_path_21">Request path</a></h6>
<div class="listingblock">
<div class="content">
<pre>/buckets/string/flows/string/versions</pre>
@@ -3723,8 +4053,8 @@ This endpoint is subject to change as Ni
},
"parameterContextName" : "string",
"componentType" : "string",
- "flowFileOutboundPolicy" : "string",
"flowFileConcurrency" : "string",
+ "flowFileOutboundPolicy" : "string",
"groupIdentifier" : "string"
} ],
"remoteProcessGroups" : [ {
@@ -3967,8 +4297,8 @@ This endpoint is subject to change as Ni
},
"parameterContextName" : "string",
"componentType" : "string",
- "flowFileOutboundPolicy" : "string",
"flowFileConcurrency" : "string",
+ "flowFileOutboundPolicy" : "string",
"groupIdentifier" : "string"
},
"externalControllerServices" : {
@@ -4036,9 +4366,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_response_16"><a class="anchor" href="rest-api.html#_example_http_response_16"></a><a class="link" href="rest-api.html#_example_http_response_16">Example HTTP response</a></h5>
+<h5 id="_example_http_response_17"><a class="anchor" href="rest-api.html#_example_http_response_17"></a><a class="link" href="rest-api.html#_example_http_response_17">Example HTTP response</a></h5>
<div class="sect5">
-<h6 id="_response_200_16"><a class="anchor" href="rest-api.html#_response_200_16"></a><a class="link" href="rest-api.html#_response_200_16">Response 200</a></h6>
+<h6 id="_response_200_17"><a class="anchor" href="rest-api.html#_response_200_17"></a><a class="link" href="rest-api.html#_response_200_17">Response 200</a></h6>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-json" data-lang="json">{
@@ -4313,8 +4643,8 @@ This endpoint is subject to change as Ni
},
"parameterContextName" : "string",
"componentType" : "string",
- "flowFileOutboundPolicy" : "string",
"flowFileConcurrency" : "string",
+ "flowFileOutboundPolicy" : "string",
"groupIdentifier" : "string"
} ],
"remoteProcessGroups" : [ {
@@ -4557,8 +4887,8 @@ This endpoint is subject to change as Ni
},
"parameterContextName" : "string",
"componentType" : "string",
- "flowFileOutboundPolicy" : "string",
"flowFileConcurrency" : "string",
+ "flowFileOutboundPolicy" : "string",
"groupIdentifier" : "string"
},
"externalControllerServices" : {
@@ -4634,7 +4964,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_description_18"><a class="anchor" href="rest-api.html#_description_18"></a><a class="link" href="rest-api.html#_description_18">Description</a></h5>
+<h5 id="_description_22"><a class="anchor" href="rest-api.html#_description_22"></a><a class="link" href="rest-api.html#_description_22">Description</a></h5>
<div class="paragraph">
<p>Gets summary information for all versions of a flow. Versions are ordered newest->oldest.</p>
</div>
@@ -4675,7 +5005,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_responses_18"><a class="anchor" href="rest-api.html#_responses_18"></a><a class="link" href="rest-api.html#_responses_18">Responses</a></h5>
+<h5 id="_responses_22"><a class="anchor" href="rest-api.html#_responses_22"></a><a class="link" href="rest-api.html#_responses_22">Responses</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 10%;">
@@ -4719,7 +5049,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_consumes_18"><a class="anchor" href="rest-api.html#_consumes_18"></a><a class="link" href="rest-api.html#_consumes_18">Consumes</a></h5>
+<h5 id="_consumes_22"><a class="anchor" href="rest-api.html#_consumes_22"></a><a class="link" href="rest-api.html#_consumes_22">Consumes</a></h5>
<div class="ulist">
<ul>
<li>
@@ -4729,7 +5059,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_produces_18"><a class="anchor" href="rest-api.html#_produces_18"></a><a class="link" href="rest-api.html#_produces_18">Produces</a></h5>
+<h5 id="_produces_22"><a class="anchor" href="rest-api.html#_produces_22"></a><a class="link" href="rest-api.html#_produces_22">Produces</a></h5>
<div class="ulist">
<ul>
<li>
@@ -4760,9 +5090,9 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_example_http_request_18"><a class="anchor" href="rest-api.html#_example_http_request_18"></a><a class="link" href="rest-api.html#_example_http_request_18">Example HTTP request</a></h5>
+<h5 id="_example_http_request_22"><a class="anchor" href="rest-api.html#_example_http_request_22"></a><a class="link" href="rest-api.html#_example_http_request_22">Example HTTP request</a></h5>
<div class="sect5">
-<h6 id="_request_path_18"><a class="anchor" href="rest-api.html#_request_path_18"></a><a class="link" href="rest-api.html#_request_path_18">Request path</a></h6>
+<h6 id="_request_path_22"><a class="anchor" href="rest-api.html#_request_path_22"></a><a class="link" href="rest-api.html#_request_path_22">Request path</a></h6>
<div class="listingblock">
<div class="content">
<pre>/buckets/string/flows/string/versions</pre>
@@ -4771,9 +5101,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_response_17"><a class="anchor" href="rest-api.html#_example_http_response_17"></a><a class="link" href="rest-api.html#_example_http_response_17">Example HTTP response</a></h5>
+<h5 id="_example_http_response_18"><a class="anchor" href="rest-api.html#_example_http_response_18"></a><a class="link" href="rest-api.html#_example_http_response_18">Example HTTP response</a></h5>
<div class="sect5">
-<h6 id="_response_200_17"><a class="anchor" href="rest-api.html#_response_200_17"></a><a class="link" href="rest-api.html#_response_200_17">Response 200</a></h6>
+<h6 id="_response_200_18"><a class="anchor" href="rest-api.html#_response_200_18"></a><a class="link" href="rest-api.html#_response_200_18">Response 200</a></h6>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-json" data-lang="json">[ {
@@ -4803,7 +5133,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_description_19"><a class="anchor" href="rest-api.html#_description_19"></a><a class="link" href="rest-api.html#_description_19">Description</a></h5>
+<h5 id="_description_23"><a class="anchor" href="rest-api.html#_description_23"></a><a class="link" href="rest-api.html#_description_23">Description</a></h5>
<div class="paragraph">
<p>Gets the latest version of a flow, including the metadata and content of the flow.</p>
</div>
@@ -4844,7 +5174,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_responses_19"><a class="anchor" href="rest-api.html#_responses_19"></a><a class="link" href="rest-api.html#_responses_19">Responses</a></h5>
+<h5 id="_responses_23"><a class="anchor" href="rest-api.html#_responses_23"></a><a class="link" href="rest-api.html#_responses_23">Responses</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 10%;">
@@ -4888,7 +5218,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_consumes_19"><a class="anchor" href="rest-api.html#_consumes_19"></a><a class="link" href="rest-api.html#_consumes_19">Consumes</a></h5>
+<h5 id="_consumes_23"><a class="anchor" href="rest-api.html#_consumes_23"></a><a class="link" href="rest-api.html#_consumes_23">Consumes</a></h5>
<div class="ulist">
<ul>
<li>
@@ -4898,7 +5228,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_produces_19"><a class="anchor" href="rest-api.html#_produces_19"></a><a class="link" href="rest-api.html#_produces_19">Produces</a></h5>
+<h5 id="_produces_23"><a class="anchor" href="rest-api.html#_produces_23"></a><a class="link" href="rest-api.html#_produces_23">Produces</a></h5>
<div class="ulist">
<ul>
<li>
@@ -4929,9 +5259,9 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_example_http_request_19"><a class="anchor" href="rest-api.html#_example_http_request_19"></a><a class="link" href="rest-api.html#_example_http_request_19">Example HTTP request</a></h5>
+<h5 id="_example_http_request_23"><a class="anchor" href="rest-api.html#_example_http_request_23"></a><a class="link" href="rest-api.html#_example_http_request_23">Example HTTP request</a></h5>
<div class="sect5">
-<h6 id="_request_path_19"><a class="anchor" href="rest-api.html#_request_path_19"></a><a class="link" href="rest-api.html#_request_path_19">Request path</a></h6>
+<h6 id="_request_path_23"><a class="anchor" href="rest-api.html#_request_path_23"></a><a class="link" href="rest-api.html#_request_path_23">Request path</a></h6>
<div class="listingblock">
<div class="content">
<pre>/buckets/string/flows/string/versions/latest</pre>
@@ -4940,9 +5270,9 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_example_http_response_18"><a class="anchor" href="rest-api.html#_example_http_response_18"></a><a class="link" href="rest-api.html#_example_http_response_18">Example HTTP response</a></h5>
+<h5 id="_example_http_response_19"><a class="anchor" href="rest-api.html#_example_http_response_19"></a><a class="link" href="rest-api.html#_example_http_response_19">Example HTTP response</a></h5>
<div class="sect5">
-<h6 id="_response_200_18"><a class="anchor" href="rest-api.html#_response_200_18"></a><a class="link" href="rest-api.html#_response_200_18">Response 200</a></h6>
+<h6 id="_response_200_19"><a class="anchor" href="rest-api.html#_response_200_19"></a><a class="link" href="rest-api.html#_response_200_19">Response 200</a></h6>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-json" data-lang="json">{
@@ -5217,8 +5547,8 @@ This endpoint is subject to change as Ni
},
"parameterContextName" : "string",
"componentType" : "string",
- "flowFileOutboundPolicy" : "string",
"flowFileConcurrency" : "string",
+ "flowFileOutboundPolicy" : "string",
"groupIdentifier" : "string"
} ],
"remoteProcessGroups" : [ {
@@ -5461,8 +5791,8 @@ This endpoint is subject to change as Ni
},
"parameterContextName" : "string",
"componentType" : "string",
- "flowFileOutboundPolicy" : "string",
"flowFileConcurrency" : "string",
+ "flowFileOutboundPolicy" : "string",
"groupIdentifier" : "string"
},
"externalControllerServices" : {
@@ -5538,7 +5868,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_description_20"><a class="anchor" href="rest-api.html#_description_20"></a><a class="link" href="rest-api.html#_description_20">Description</a></h5>
+<h5 id="_description_24"><a class="anchor" href="rest-api.html#_description_24"></a><a class="link" href="rest-api.html#_description_24">Description</a></h5>
<div class="paragraph">
<p>Gets the metadata for the latest version of a flow.</p>
</div>
@@ -5579,7 +5909,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_responses_20"><a class="anchor" href="rest-api.html#_responses_20"></a><a class="link" href="rest-api.html#_responses_20">Responses</a></h5>
+<h5 id="_responses_24"><a class="anchor" href="rest-api.html#_responses_24"></a><a class="link" href="rest-api.html#_responses_24">Responses</a></h5>
<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 10%;">
@@ -5623,7 +5953,7 @@ This endpoint is subject to change as Ni
</table>
</div>
<div class="sect4">
-<h5 id="_consumes_20"><a class="anchor" href="rest-api.html#_consumes_20"></a><a class="link" href="rest-api.html#_consumes_20">Consumes</a></h5>
+<h5 id="_consumes_24"><a class="anchor" href="rest-api.html#_consumes_24"></a><a class="link" href="rest-api.html#_consumes_24">Consumes</a></h5>
<div class="ulist">
<ul>
<li>
@@ -5633,7 +5963,7 @@ This endpoint is subject to change as Ni
</div>
</div>
<div class="sect4">
-<h5 id="_produces_20"><a class="anchor" href="rest-api.html#_produces_20"></a><a class="link" href="rest-api.html#_produces_20">Produces</a></h5>
[... 3770 lines stripped ...]