You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ranger.apache.org by rm...@apache.org on 2021/11/05 18:32:07 UTC
svn commit: r1894763 [15/31] - in /ranger/site/trunk: ./ apidocs/
apidocs/ui/ kms/apidocs/ kms/apidocs/ui/
Modified: ranger/site/trunk/apidocs/resource_RoleREST.html
URL: http://svn.apache.org/viewvc/ranger/site/trunk/apidocs/resource_RoleREST.html?rev=1894763&r1=1894762&r2=1894763&view=diff
==============================================================================
--- ranger/site/trunk/apidocs/resource_RoleREST.html (original)
+++ ranger/site/trunk/apidocs/resource_RoleREST.html Fri Nov 5 18:32:04 2021
@@ -52,6 +52,8 @@
<ul class="nav nav-sidebar">
<li><a href="#resource_RoleREST_getAllRoles_GET"><abbr title="GET /roles/roles"><span class="sideoverflow">GET /roles/roles</span></abbr></a></li>
<li><a href="#resource_RoleREST_createRole_POST"><abbr title="POST /roles/roles"><span class="sideoverflow">POST /roles/roles</span></abbr></a></li>
+ <li><a href="#resource_RoleREST_getRangerRolesIfUpdated_GET"><abbr title="GET /roles/download/{serviceName}"><span class="sideoverflow">GET /roles/download/{serviceName}</span></abbr></a></li>
+ <li><a href="#resource_RoleREST_getAllRolesForUser_GET"><abbr title="GET /roles/lookup/roles"><span class="sideoverflow">GET /roles/lookup/roles</span></abbr></a></li>
<li><a href="#resource_RoleREST_getAllRoleNames_GET"><abbr title="GET /roles/roles/names"><span class="sideoverflow">GET /roles/roles/names</span></abbr></a></li>
<li><a href="#resource_RoleREST_deleteRole_DELETE"><abbr title="DELETE /roles/roles/{id}"><span class="sideoverflow">DELETE /roles/roles/{id}</span></abbr></a></li>
<li><a href="#resource_RoleREST_getRole_GET"><abbr title="GET /roles/roles/{id}"><span class="sideoverflow">GET /roles/roles/{id}</span></abbr></a></li>
@@ -64,6 +66,7 @@
<li><a href="#resource_RoleREST_addUsersAndGroups_PUT"><abbr title="PUT /roles/roles/{id}/addUsersAndGroups"><span class="sideoverflow">PUT /roles/roles/{id}/addUsersAndGroups</span></abbr></a></li>
<li><a href="#resource_RoleREST_removeAdminFromUsersAndGroups_PUT"><abbr title="PUT /roles/roles/{id}/removeAdminFromUsersAndGroups"><span class="sideoverflow">PUT /roles/roles/{id}/removeAdminFromUsersAndGroups</span></abbr></a></li>
<li><a href="#resource_RoleREST_removeUsersAndGroups_PUT"><abbr title="PUT /roles/roles/{id}/removeUsersAndGroups"><span class="sideoverflow">PUT /roles/roles/{id}/removeUsersAndGroups</span></abbr></a></li>
+ <li><a href="#resource_RoleREST_getSecureRangerRolesIfUpdated_GET"><abbr title="GET /roles/secure/download/{serviceName}"><span class="sideoverflow">GET /roles/secure/download/{serviceName}</span></abbr></a></li>
<li class="divider"></li>
<li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
</ul>
@@ -133,78 +136,78 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
"roles" : [ {
- "options" : {
- "property1" : { },
- "property2" : { }
- },
"createdByUser" : "...",
"groups" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
- } ],
- "description" : "...",
- "roles" : [ {
- "isAdmin" : true,
- "name" : "..."
- }, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"users" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"name" : "...",
+ "options" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "description" : "...",
+ "roles" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
"createTime" : 12345,
+ "id" : 12345,
"updatedBy" : "...",
"version" : 12345,
- "updateTime" : 12345,
- "id" : 12345,
"createdBy" : "...",
"guid" : "...",
+ "updateTime" : 12345,
"isEnabled" : true
}, {
- "options" : {
- "property1" : { },
- "property2" : { }
- },
"createdByUser" : "...",
"groups" : [ {
- "isAdmin" : true,
- "name" : "..."
- }, {
- "isAdmin" : true,
- "name" : "..."
- } ],
- "description" : "...",
- "roles" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"users" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"name" : "...",
+ "options" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "description" : "...",
+ "roles" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
"createTime" : 12345,
+ "id" : 12345,
"updatedBy" : "...",
"version" : 12345,
- "updateTime" : 12345,
- "id" : 12345,
"createdBy" : "...",
"guid" : "...",
+ "updateTime" : 12345,
"isEnabled" : true
} ],
"listSize" : 12345,
@@ -235,13 +238,24 @@ Content-Type: application/json
<th>name</th>
<th>type</th>
<th>description</th>
+ <th>default</th>
+ <th>constraints</th>
</tr>
</thead>
<tbody>
<tr>
+ <td><span class="parameter-name">createNonExistUserGroup</span></td>
+ <td>query</td>
+ <td><span class="parameter-description"></span></td>
+ <td><span class="parameter-default-value">false</span></td>
+ <td><span class="parameter-constraints">boolean</span></td>
+ </tr>
+ <tr>
<td><span class="parameter-name">serviceName</span></td>
<td>query</td>
<td><span class="parameter-description"></span></td>
+ <td><span class="parameter-default-value"> </span></td>
+ <td><span class="parameter-constraints"> </span></td>
</tr>
</tbody>
</table>
@@ -304,41 +318,41 @@ Accept: application/json
<code class="prettyprint language-js">
{
- "options" : {
- "property1" : { },
- "property2" : { }
- },
"createdByUser" : "...",
"groups" : [ {
- "isAdmin" : true,
- "name" : "..."
- }, {
- "isAdmin" : true,
- "name" : "..."
- } ],
- "description" : "...",
- "roles" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"users" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"name" : "...",
+ "options" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "description" : "...",
+ "roles" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
"createTime" : 12345,
+ "id" : 12345,
"updatedBy" : "...",
"version" : 12345,
- "updateTime" : 12345,
- "id" : 12345,
"createdBy" : "...",
"guid" : "...",
+ "updateTime" : 12345,
"isEnabled" : true
}
</code>
@@ -352,41 +366,41 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
- "options" : {
- "property1" : { },
- "property2" : { }
- },
"createdByUser" : "...",
"groups" : [ {
- "isAdmin" : true,
- "name" : "..."
- }, {
- "isAdmin" : true,
- "name" : "..."
- } ],
- "description" : "...",
- "roles" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"users" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"name" : "...",
+ "options" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "description" : "...",
+ "roles" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
"createTime" : 12345,
+ "id" : 12345,
"updatedBy" : "...",
"version" : 12345,
- "updateTime" : 12345,
- "id" : 12345,
"createdBy" : "...",
"guid" : "...",
+ "updateTime" : 12345,
"isEnabled" : true
}
</code>
@@ -396,6 +410,344 @@ Content-Type: application/json
</div>
</div>
+ <div id="resource_RoleREST_getRangerRolesIfUpdated_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/roles/download/{serviceName} <a href="../roles/download/{serviceName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p></p>
+
+ <table class="table resource-parameters">
+ <caption>Request Parameters</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>type</th>
+ <th>description</th>
+ <th>default</th>
+ <th>constraints</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="parameter-name">serviceName</span></td>
+ <td>path</td>
+ <td><span class="parameter-description"></span></td>
+ <td><span class="parameter-default-value"> </span></td>
+ <td><span class="parameter-constraints"> </span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">clusterName</span></td>
+ <td>query</td>
+ <td><span class="parameter-description"></span></td>
+ <td><span class="parameter-default-value"></span></td>
+ <td><span class="parameter-constraints"> </span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">lastActivationTime</span></td>
+ <td>query</td>
+ <td><span class="parameter-description"></span></td>
+ <td><span class="parameter-default-value">0</span></td>
+ <td><span class="parameter-constraints">long</span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">lastKnownRoleVersion</span></td>
+ <td>query</td>
+ <td><span class="parameter-description"></span></td>
+ <td><span class="parameter-default-value"> </span></td>
+ <td><span class="parameter-constraints">long</span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">pluginCapabilities</span></td>
+ <td>query</td>
+ <td><span class="parameter-description"></span></td>
+ <td><span class="parameter-default-value"></span></td>
+ <td><span class="parameter-constraints"> </span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">pluginId</span></td>
+ <td>query</td>
+ <td><span class="parameter-description"></span></td>
+ <td><span class="parameter-default-value"> </span></td>
+ <td><span class="parameter-constraints"> </span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <table class="table resource-response-body">
+ <caption>Response Body</caption>
+ <thead>
+ <tr>
+ <th>media type</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference"><a href="json_RangerRoles.html">RangerRoles</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
+ </tr>
+ <tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
+ <td><span class="datatype-reference"><a href="xml_ns0_rangerRoles.html">rangerRoles</a>
+ (XML)</span></td>
+ </tr>
+ </tbody>
+ </table>
+ <h4>Example</h4>
+
+ <div class="container-fluid example panel">
+ <div class="row panel-body">
+ <div class="col-md-6">
+ <h5>Request</h5>
+ <pre>
+GET /roles/download/{serviceName}
+Content-Type: */*
+Accept: application/json
+
+ <code class="prettyprint language-txt">
+...
+ </code>
+ </pre>
+ </div>
+ <div class="col-md-6">
+ <h5>Response</h5>
+ <pre>
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+{
+ "roleVersion" : 12345,
+ "serviceName" : "...",
+ "roleUpdateTime" : 12345,
+ "rangerRoles" : [ {
+ "createdByUser" : "...",
+ "groups" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
+ "users" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
+ "name" : "...",
+ "options" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "description" : "...",
+ "roles" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
+ "createTime" : 12345,
+ "id" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "createdBy" : "...",
+ "guid" : "...",
+ "updateTime" : 12345,
+ "isEnabled" : true
+ }, {
+ "createdByUser" : "...",
+ "groups" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
+ "users" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
+ "name" : "...",
+ "options" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "description" : "...",
+ "roles" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
+ "createTime" : 12345,
+ "id" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "createdBy" : "...",
+ "guid" : "...",
+ "updateTime" : 12345,
+ "isEnabled" : true
+ } ]
+}
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_RoleREST_getAllRolesForUser_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/roles/lookup/roles <a href="../roles/lookup/roles" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p></p>
+
+ <table class="table resource-response-body">
+ <caption>Response Body</caption>
+ <thead>
+ <tr>
+ <th>media type</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference"><a href="json_RangerRoleList.html">RangerRoleList</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
+ </tr>
+ <tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
+ <td><span class="datatype-reference"><a href="xml_ns0_rangerRoleList.html">rangerRoleList</a>
+ (XML)</span></td>
+ </tr>
+ </tbody>
+ </table>
+ <h4>Example</h4>
+
+ <div class="container-fluid example panel">
+ <div class="row panel-body">
+ <div class="col-md-6">
+ <h5>Request</h5>
+ <pre>
+GET /roles/lookup/roles
+Content-Type: */*
+Accept: application/json
+
+ <code class="prettyprint language-txt">
+...
+ </code>
+ </pre>
+ </div>
+ <div class="col-md-6">
+ <h5>Response</h5>
+ <pre>
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+{
+ "roles" : [ {
+ "createdByUser" : "...",
+ "groups" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
+ "users" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
+ "name" : "...",
+ "options" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "description" : "...",
+ "roles" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
+ "createTime" : 12345,
+ "id" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "createdBy" : "...",
+ "guid" : "...",
+ "updateTime" : 12345,
+ "isEnabled" : true
+ }, {
+ "createdByUser" : "...",
+ "groups" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
+ "users" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
+ "name" : "...",
+ "options" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "description" : "...",
+ "roles" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
+ "createTime" : 12345,
+ "id" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "createdBy" : "...",
+ "guid" : "...",
+ "updateTime" : 12345,
+ "isEnabled" : true
+ } ],
+ "listSize" : 12345,
+ "list" : [ { }, { } ],
+ "startIndex" : 12345,
+ "pageSize" : 12345,
+ "totalCount" : 12345,
+ "resultSize" : 12345,
+ "sortType" : "...",
+ "sortBy" : "..."
+}
+ </code>
+ </pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
<div id="resource_RoleREST_getAllRoleNames_GET">
<h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/roles/roles/names <a href="../roles/roles/names" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
@@ -600,41 +952,41 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
- "options" : {
- "property1" : { },
- "property2" : { }
- },
"createdByUser" : "...",
"groups" : [ {
- "isAdmin" : true,
- "name" : "..."
- }, {
- "isAdmin" : true,
- "name" : "..."
- } ],
- "description" : "...",
- "roles" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"users" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"name" : "...",
+ "options" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "description" : "...",
+ "roles" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
"createTime" : 12345,
+ "id" : 12345,
"updatedBy" : "...",
"version" : 12345,
- "updateTime" : 12345,
- "id" : 12345,
"createdBy" : "...",
"guid" : "...",
+ "updateTime" : 12345,
"isEnabled" : true
}
</code>
@@ -656,6 +1008,7 @@ Content-Type: application/json
<th>name</th>
<th>type</th>
<th>description</th>
+ <th>default</th>
<th>constraints</th>
</tr>
</thead>
@@ -664,8 +1017,16 @@ Content-Type: application/json
<td><span class="parameter-name">id</span></td>
<td>path</td>
<td><span class="parameter-description"></span></td>
+ <td><span class="parameter-default-value"> </span></td>
<td><span class="parameter-constraints">long</span></td>
</tr>
+ <tr>
+ <td><span class="parameter-name">createNonExistUserGroup</span></td>
+ <td>query</td>
+ <td><span class="parameter-description"></span></td>
+ <td><span class="parameter-default-value">false</span></td>
+ <td><span class="parameter-constraints">boolean</span></td>
+ </tr>
</tbody>
</table>
@@ -727,41 +1088,41 @@ Accept: application/json
<code class="prettyprint language-js">
{
- "options" : {
- "property1" : { },
- "property2" : { }
- },
"createdByUser" : "...",
"groups" : [ {
- "isAdmin" : true,
- "name" : "..."
- }, {
- "isAdmin" : true,
- "name" : "..."
- } ],
- "description" : "...",
- "roles" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"users" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"name" : "...",
+ "options" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "description" : "...",
+ "roles" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
"createTime" : 12345,
+ "id" : 12345,
"updatedBy" : "...",
"version" : 12345,
- "updateTime" : 12345,
- "id" : 12345,
"createdBy" : "...",
"guid" : "...",
+ "updateTime" : 12345,
"isEnabled" : true
}
</code>
@@ -775,41 +1136,41 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
- "options" : {
- "property1" : { },
- "property2" : { }
- },
"createdByUser" : "...",
"groups" : [ {
- "isAdmin" : true,
- "name" : "..."
- }, {
- "isAdmin" : true,
- "name" : "..."
- } ],
- "description" : "...",
- "roles" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"users" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"name" : "...",
+ "options" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "description" : "...",
+ "roles" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
"createTime" : 12345,
+ "id" : 12345,
"updatedBy" : "...",
"version" : 12345,
- "updateTime" : 12345,
- "id" : 12345,
"createdBy" : "...",
"guid" : "...",
+ "updateTime" : 12345,
"isEnabled" : true
}
</code>
@@ -900,17 +1261,17 @@ Accept: application/json
<code class="prettyprint language-js">
{
- "clusterName" : "...",
+ "users" : [ "...", "..." ],
"requestData" : "...",
- "clientIPAddress" : "...",
"grantorGroups" : [ "...", "..." ],
+ "clientType" : "...",
+ "targetRoles" : [ "...", "..." ],
+ "clusterName" : "...",
"grantOption" : true,
- "grantor" : "...",
+ "clientIPAddress" : "...",
"sessionId" : "...",
- "targetRoles" : [ "...", "..." ],
+ "grantor" : "...",
"groups" : [ "...", "..." ],
- "users" : [ "...", "..." ],
- "clientType" : "...",
"roles" : [ "...", "..." ]
}
</code>
@@ -926,21 +1287,21 @@ Content-Type: application/json
{
"message" : "...",
"msgDesc" : "...",
- "statusCode" : 12345,
"httpStatusCode" : 12345,
"messageList" : [ {
+ "fieldName" : "...",
+ "objectId" : 12345,
"rbKey" : "...",
- "name" : "...",
"message" : "...",
- "fieldName" : "...",
- "objectId" : 12345
+ "name" : "..."
}, {
+ "fieldName" : "...",
+ "objectId" : 12345,
"rbKey" : "...",
- "name" : "...",
"message" : "...",
- "fieldName" : "...",
- "objectId" : 12345
- } ]
+ "name" : "..."
+ } ],
+ "statusCode" : 12345
}
</code>
</pre>
@@ -1087,41 +1448,41 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
- "options" : {
- "property1" : { },
- "property2" : { }
- },
"createdByUser" : "...",
"groups" : [ {
- "isAdmin" : true,
- "name" : "..."
- }, {
- "isAdmin" : true,
- "name" : "..."
- } ],
- "description" : "...",
- "roles" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"users" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"name" : "...",
+ "options" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "description" : "...",
+ "roles" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
"createTime" : 12345,
+ "id" : 12345,
"updatedBy" : "...",
"version" : 12345,
- "updateTime" : 12345,
- "id" : 12345,
"createdBy" : "...",
"guid" : "...",
+ "updateTime" : 12345,
"isEnabled" : true
}
</code>
@@ -1212,17 +1573,17 @@ Accept: application/json
<code class="prettyprint language-js">
{
- "clusterName" : "...",
+ "users" : [ "...", "..." ],
"requestData" : "...",
- "clientIPAddress" : "...",
"grantorGroups" : [ "...", "..." ],
+ "clientType" : "...",
+ "targetRoles" : [ "...", "..." ],
+ "clusterName" : "...",
"grantOption" : true,
- "grantor" : "...",
+ "clientIPAddress" : "...",
"sessionId" : "...",
- "targetRoles" : [ "...", "..." ],
+ "grantor" : "...",
"groups" : [ "...", "..." ],
- "users" : [ "...", "..." ],
- "clientType" : "...",
"roles" : [ "...", "..." ]
}
</code>
@@ -1238,21 +1599,21 @@ Content-Type: application/json
{
"message" : "...",
"msgDesc" : "...",
- "statusCode" : 12345,
"httpStatusCode" : 12345,
"messageList" : [ {
+ "fieldName" : "...",
+ "objectId" : 12345,
"rbKey" : "...",
- "name" : "...",
"message" : "...",
- "fieldName" : "...",
- "objectId" : 12345
+ "name" : "..."
}, {
+ "fieldName" : "...",
+ "objectId" : 12345,
"rbKey" : "...",
- "name" : "...",
"message" : "...",
- "fieldName" : "...",
- "objectId" : 12345
- } ]
+ "name" : "..."
+ } ],
+ "statusCode" : 12345
}
</code>
</pre>
@@ -1412,41 +1773,41 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
- "options" : {
- "property1" : { },
- "property2" : { }
- },
"createdByUser" : "...",
"groups" : [ {
- "isAdmin" : true,
- "name" : "..."
- }, {
- "isAdmin" : true,
- "name" : "..."
- } ],
- "description" : "...",
- "roles" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"users" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"name" : "...",
+ "options" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "description" : "...",
+ "roles" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
"createTime" : 12345,
+ "id" : 12345,
"updatedBy" : "...",
"version" : 12345,
- "updateTime" : 12345,
- "id" : 12345,
"createdBy" : "...",
"guid" : "...",
+ "updateTime" : 12345,
"isEnabled" : true
}
</code>
@@ -1530,41 +1891,41 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
- "options" : {
- "property1" : { },
- "property2" : { }
- },
"createdByUser" : "...",
"groups" : [ {
- "isAdmin" : true,
- "name" : "..."
- }, {
- "isAdmin" : true,
- "name" : "..."
- } ],
- "description" : "...",
- "roles" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"users" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"name" : "...",
+ "options" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "description" : "...",
+ "roles" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
"createTime" : 12345,
+ "id" : 12345,
"updatedBy" : "...",
"version" : 12345,
- "updateTime" : 12345,
- "id" : 12345,
"createdBy" : "...",
"guid" : "...",
+ "updateTime" : 12345,
"isEnabled" : true
}
</code>
@@ -1648,45 +2009,240 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
- "options" : {
- "property1" : { },
- "property2" : { }
- },
"createdByUser" : "...",
"groups" : [ {
- "isAdmin" : true,
- "name" : "..."
- }, {
- "isAdmin" : true,
- "name" : "..."
- } ],
- "description" : "...",
- "roles" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"users" : [ {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
}, {
- "isAdmin" : true,
- "name" : "..."
+ "name" : "...",
+ "isAdmin" : true
} ],
"name" : "...",
+ "options" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "description" : "...",
+ "roles" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
"createTime" : 12345,
+ "id" : 12345,
"updatedBy" : "...",
"version" : 12345,
- "updateTime" : 12345,
- "id" : 12345,
"createdBy" : "...",
"guid" : "...",
+ "updateTime" : 12345,
"isEnabled" : true
}
</code>
</pre>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ <div id="resource_RoleREST_getSecureRangerRolesIfUpdated_GET">
+ <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/roles/secure/download/{serviceName} <a href="../roles/secure/download/{serviceName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3>
+
+ <p></p>
+
+ <table class="table resource-parameters">
+ <caption>Request Parameters</caption>
+ <thead>
+ <tr>
+ <th>name</th>
+ <th>type</th>
+ <th>description</th>
+ <th>default</th>
+ <th>constraints</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><span class="parameter-name">serviceName</span></td>
+ <td>path</td>
+ <td><span class="parameter-description"></span></td>
+ <td><span class="parameter-default-value"> </span></td>
+ <td><span class="parameter-constraints"> </span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">clusterName</span></td>
+ <td>query</td>
+ <td><span class="parameter-description"></span></td>
+ <td><span class="parameter-default-value"></span></td>
+ <td><span class="parameter-constraints"> </span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">lastActivationTime</span></td>
+ <td>query</td>
+ <td><span class="parameter-description"></span></td>
+ <td><span class="parameter-default-value">0</span></td>
+ <td><span class="parameter-constraints">long</span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">lastKnownRoleVersion</span></td>
+ <td>query</td>
+ <td><span class="parameter-description"></span></td>
+ <td><span class="parameter-default-value"> </span></td>
+ <td><span class="parameter-constraints">long</span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">pluginCapabilities</span></td>
+ <td>query</td>
+ <td><span class="parameter-description"></span></td>
+ <td><span class="parameter-default-value"></span></td>
+ <td><span class="parameter-constraints"> </span></td>
+ </tr>
+ <tr>
+ <td><span class="parameter-name">pluginId</span></td>
+ <td>query</td>
+ <td><span class="parameter-description"></span></td>
+ <td><span class="parameter-default-value"> </span></td>
+ <td><span class="parameter-constraints"> </span></td>
+ </tr>
+ </tbody>
+ </table>
+
+ <table class="table resource-response-body">
+ <caption>Response Body</caption>
+ <thead>
+ <tr>
+ <th>media type</th>
+ <th>data type</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td>
+ <td><span class="datatype-reference"><a href="json_RangerRoles.html">RangerRoles</a>
+ (JSON)</span></td>
+ <td rowspan="2" class="multi-row-description"><span class="response-description"></span></td>
+ </tr>
+ <tr>
+ <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td>
+ <td><span class="datatype-reference"><a href="xml_ns0_rangerRoles.html">rangerRoles</a>
+ (XML)</span></td>
+ </tr>
+ </tbody>
+ </table>
+ <h4>Example</h4>
+
+ <div class="container-fluid example panel">
+ <div class="row panel-body">
+ <div class="col-md-6">
+ <h5>Request</h5>
+ <pre>
+GET /roles/secure/download/{serviceName}
+Content-Type: */*
+Accept: application/json
+
+ <code class="prettyprint language-txt">
+...
+ </code>
+ </pre>
+ </div>
+ <div class="col-md-6">
+ <h5>Response</h5>
+ <pre>
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+ <code class="prettyprint language-js">
+{
+ "roleVersion" : 12345,
+ "serviceName" : "...",
+ "roleUpdateTime" : 12345,
+ "rangerRoles" : [ {
+ "createdByUser" : "...",
+ "groups" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
+ "users" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
+ "name" : "...",
+ "options" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "description" : "...",
+ "roles" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
+ "createTime" : 12345,
+ "id" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "createdBy" : "...",
+ "guid" : "...",
+ "updateTime" : 12345,
+ "isEnabled" : true
+ }, {
+ "createdByUser" : "...",
+ "groups" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
+ "users" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
+ "name" : "...",
+ "options" : {
+ "property1" : { },
+ "property2" : { }
+ },
+ "description" : "...",
+ "roles" : [ {
+ "name" : "...",
+ "isAdmin" : true
+ }, {
+ "name" : "...",
+ "isAdmin" : true
+ } ],
+ "createTime" : 12345,
+ "id" : 12345,
+ "updatedBy" : "...",
+ "version" : 12345,
+ "createdBy" : "...",
+ "guid" : "...",
+ "updateTime" : 12345,
+ "isEnabled" : true
+ } ]
+}
+ </code>
+ </pre>
</div>
</div>
</div>
Modified: ranger/site/trunk/apidocs/resource_SecurityZoneREST.html
URL: http://svn.apache.org/viewvc/ranger/site/trunk/apidocs/resource_SecurityZoneREST.html?rev=1894763&r1=1894762&r2=1894763&view=diff
==============================================================================
--- ranger/site/trunk/apidocs/resource_SecurityZoneREST.html (original)
+++ ranger/site/trunk/apidocs/resource_SecurityZoneREST.html Fri Nov 5 18:32:04 2021
@@ -126,13 +126,12 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
"securityZones" : [ {
- "auditUserGroups" : [ "...", "..." ],
+ "tagServices" : [ "...", "..." ],
"description" : "...",
"auditUsers" : [ "...", "..." ],
"adminUserGroups" : [ "...", "..." ],
- "name" : "...",
"adminUsers" : [ "...", "..." ],
- "tagServices" : [ "...", "..." ],
+ "name" : "...",
"services" : {
"property1" : {
"resources" : [ {
@@ -153,22 +152,22 @@ Content-Type: application/json
} ]
}
},
+ "auditUserGroups" : [ "...", "..." ],
"createTime" : 12345,
+ "id" : 12345,
"updatedBy" : "...",
"version" : 12345,
- "updateTime" : 12345,
- "id" : 12345,
"createdBy" : "...",
"guid" : "...",
+ "updateTime" : 12345,
"isEnabled" : true
}, {
- "auditUserGroups" : [ "...", "..." ],
+ "tagServices" : [ "...", "..." ],
"description" : "...",
"auditUsers" : [ "...", "..." ],
"adminUserGroups" : [ "...", "..." ],
- "name" : "...",
"adminUsers" : [ "...", "..." ],
- "tagServices" : [ "...", "..." ],
+ "name" : "...",
"services" : {
"property1" : {
"resources" : [ {
@@ -189,13 +188,14 @@ Content-Type: application/json
} ]
}
},
+ "auditUserGroups" : [ "...", "..." ],
"createTime" : 12345,
+ "id" : 12345,
"updatedBy" : "...",
"version" : 12345,
- "updateTime" : 12345,
- "id" : 12345,
"createdBy" : "...",
"guid" : "...",
+ "updateTime" : 12345,
"isEnabled" : true
} ],
"listSize" : 12345,
@@ -277,13 +277,12 @@ Accept: application/json
<code class="prettyprint language-js">
{
- "auditUserGroups" : [ "...", "..." ],
+ "tagServices" : [ "...", "..." ],
"description" : "...",
"auditUsers" : [ "...", "..." ],
"adminUserGroups" : [ "...", "..." ],
- "name" : "...",
"adminUsers" : [ "...", "..." ],
- "tagServices" : [ "...", "..." ],
+ "name" : "...",
"services" : {
"property1" : {
"resources" : [ {
@@ -304,13 +303,14 @@ Accept: application/json
} ]
}
},
+ "auditUserGroups" : [ "...", "..." ],
"createTime" : 12345,
+ "id" : 12345,
"updatedBy" : "...",
"version" : 12345,
- "updateTime" : 12345,
- "id" : 12345,
"createdBy" : "...",
"guid" : "...",
+ "updateTime" : 12345,
"isEnabled" : true
}
</code>
@@ -324,13 +324,12 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
- "auditUserGroups" : [ "...", "..." ],
+ "tagServices" : [ "...", "..." ],
"description" : "...",
"auditUsers" : [ "...", "..." ],
"adminUserGroups" : [ "...", "..." ],
- "name" : "...",
"adminUsers" : [ "...", "..." ],
- "tagServices" : [ "...", "..." ],
+ "name" : "...",
"services" : {
"property1" : {
"resources" : [ {
@@ -351,13 +350,14 @@ Content-Type: application/json
} ]
}
},
+ "auditUserGroups" : [ "...", "..." ],
"createTime" : 12345,
+ "id" : 12345,
"updatedBy" : "...",
"version" : 12345,
- "updateTime" : 12345,
- "id" : 12345,
"createdBy" : "...",
"guid" : "...",
+ "updateTime" : 12345,
"isEnabled" : true
}
</code>
@@ -489,13 +489,12 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
- "auditUserGroups" : [ "...", "..." ],
+ "tagServices" : [ "...", "..." ],
"description" : "...",
"auditUsers" : [ "...", "..." ],
"adminUserGroups" : [ "...", "..." ],
- "name" : "...",
"adminUsers" : [ "...", "..." ],
- "tagServices" : [ "...", "..." ],
+ "name" : "...",
"services" : {
"property1" : {
"resources" : [ {
@@ -516,13 +515,14 @@ Content-Type: application/json
} ]
}
},
+ "auditUserGroups" : [ "...", "..." ],
"createTime" : 12345,
+ "id" : 12345,
"updatedBy" : "...",
"version" : 12345,
- "updateTime" : 12345,
- "id" : 12345,
"createdBy" : "...",
"guid" : "...",
+ "updateTime" : 12345,
"isEnabled" : true
}
</code>
@@ -615,13 +615,12 @@ Accept: application/json
<code class="prettyprint language-js">
{
- "auditUserGroups" : [ "...", "..." ],
+ "tagServices" : [ "...", "..." ],
"description" : "...",
"auditUsers" : [ "...", "..." ],
"adminUserGroups" : [ "...", "..." ],
- "name" : "...",
"adminUsers" : [ "...", "..." ],
- "tagServices" : [ "...", "..." ],
+ "name" : "...",
"services" : {
"property1" : {
"resources" : [ {
@@ -642,13 +641,14 @@ Accept: application/json
} ]
}
},
+ "auditUserGroups" : [ "...", "..." ],
"createTime" : 12345,
+ "id" : 12345,
"updatedBy" : "...",
"version" : 12345,
- "updateTime" : 12345,
- "id" : 12345,
"createdBy" : "...",
"guid" : "...",
+ "updateTime" : 12345,
"isEnabled" : true
}
</code>
@@ -662,13 +662,12 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
- "auditUserGroups" : [ "...", "..." ],
+ "tagServices" : [ "...", "..." ],
"description" : "...",
"auditUsers" : [ "...", "..." ],
"adminUserGroups" : [ "...", "..." ],
- "name" : "...",
"adminUsers" : [ "...", "..." ],
- "tagServices" : [ "...", "..." ],
+ "name" : "...",
"services" : {
"property1" : {
"resources" : [ {
@@ -689,13 +688,14 @@ Content-Type: application/json
} ]
}
},
+ "auditUserGroups" : [ "...", "..." ],
"createTime" : 12345,
+ "id" : 12345,
"updatedBy" : "...",
"version" : 12345,
- "updateTime" : 12345,
- "id" : 12345,
"createdBy" : "...",
"guid" : "...",
+ "updateTime" : 12345,
"isEnabled" : true
}
</code>
@@ -823,13 +823,12 @@ Content-Type: application/json
<code class="prettyprint language-js">
{
- "auditUserGroups" : [ "...", "..." ],
+ "tagServices" : [ "...", "..." ],
"description" : "...",
"auditUsers" : [ "...", "..." ],
"adminUserGroups" : [ "...", "..." ],
- "name" : "...",
"adminUsers" : [ "...", "..." ],
- "tagServices" : [ "...", "..." ],
+ "name" : "...",
"services" : {
"property1" : {
"resources" : [ {
@@ -850,13 +849,14 @@ Content-Type: application/json
} ]
}
},
+ "auditUserGroups" : [ "...", "..." ],
"createTime" : 12345,
+ "id" : 12345,
"updatedBy" : "...",
"version" : 12345,
- "updateTime" : 12345,
- "id" : 12345,
"createdBy" : "...",
"guid" : "...",
+ "updateTime" : 12345,
"isEnabled" : true
}
</code>