Modified: ranger/site/trunk/apidocs/resource_RoleREST.html URL: http://svn.apache.org/viewvc/ranger/site/trunk/apidocs/resource_RoleREST.html?rev=1864664&r1=1864663&r2=1864664&view=diff ============================================================================== --- ranger/site/trunk/apidocs/resource_RoleREST.html (original) +++ ranger/site/trunk/apidocs/resource_RoleREST.html Wed Aug 7 18:15:52 2019 @@ -52,11 +52,15 @@ <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_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> <li><a href="#resource_RoleREST_updateRole_PUT"><abbr title="PUT /roles/roles/{id}"><span class="sideoverflow">PUT /roles/roles/{id}</span></abbr></a></li> + <li><a href="#resource_RoleREST_grantRole_PUT"><abbr title="PUT /roles/roles/grant/{serviceName}"><span class="sideoverflow">PUT /roles/roles/grant/{serviceName}</span></abbr></a></li> <li><a href="#resource_RoleREST_deleteRole_DELETE"><abbr title="DELETE /roles/roles/name/{name}"><span class="sideoverflow">DELETE /roles/roles/name/{name}</span></abbr></a></li> <li><a href="#resource_RoleREST_getRole_GET"><abbr title="GET /roles/roles/name/{name}"><span class="sideoverflow">GET /roles/roles/name/{name}</span></abbr></a></li> + <li><a href="#resource_RoleREST_revokeRole_PUT"><abbr title="PUT /roles/roles/revoke/{serviceName}"><span class="sideoverflow">PUT /roles/roles/revoke/{serviceName}</span></abbr></a></li> + <li><a href="#resource_RoleREST_getUserRoles_GET"><abbr title="GET /roles/roles/user/{user}"><span class="sideoverflow">GET /roles/roles/user/{user}</span></abbr></a></li> <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> @@ -129,77 +133,79 @@ Content-Type: application/json <code class="prettyprint language-js"> { "roles" : [ { - "groups" : [ { + "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], - "roles" : [ { + "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], - "options" : { - "property1" : { }, - "property2" : { } - }, "name" : "...", - "users" : [ { + "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], + "options" : { + "property1" : { }, + "property2" : { } + }, + "createdByUser" : "...", "description" : "...", "version" : 12345, + "createTime" : 12345, + "isEnabled" : true, "createdBy" : "...", - "updatedBy" : "...", - "id" : 12345, "guid" : "...", - "updateTime" : 12345, - "isEnabled" : true, - "createTime" : 12345 + "id" : 12345, + "updatedBy" : "...", + "updateTime" : 12345 }, { - "groups" : [ { + "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], - "roles" : [ { + "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], - "options" : { - "property1" : { }, - "property2" : { } - }, "name" : "...", - "users" : [ { + "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], + "options" : { + "property1" : { }, + "property2" : { } + }, + "createdByUser" : "...", "description" : "...", "version" : 12345, + "createTime" : 12345, + "isEnabled" : true, "createdBy" : "...", - "updatedBy" : "...", - "id" : 12345, "guid" : "...", - "updateTime" : 12345, - "isEnabled" : true, - "createTime" : 12345 + "id" : 12345, + "updatedBy" : "...", + "updateTime" : 12345 } ], "listSize" : 12345, "list" : [ { }, { } ], @@ -222,6 +228,24 @@ Content-Type: application/json <p></p> + <table class="table resource-parameters"> + <caption>Request Parameters</caption> + <thead> + <tr> + <th>name</th> + <th>type</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td><span class="parameter-name">serviceName</span></td> + <td>query</td> + <td><span class="parameter-description"></span></td> + </tr> + </tbody> + </table> + <table class="table resource-request-body"> <caption>Request Body</caption> <thead> @@ -280,41 +304,42 @@ Accept: application/json <code class="prettyprint language-js"> { - "groups" : [ { + "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], - "roles" : [ { + "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], - "options" : { - "property1" : { }, - "property2" : { } - }, "name" : "...", - "users" : [ { + "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], + "options" : { + "property1" : { }, + "property2" : { } + }, + "createdByUser" : "...", "description" : "...", "version" : 12345, + "createTime" : 12345, + "isEnabled" : true, "createdBy" : "...", - "updatedBy" : "...", - "id" : 12345, "guid" : "...", - "updateTime" : 12345, - "isEnabled" : true, - "createTime" : 12345 + "id" : 12345, + "updatedBy" : "...", + "updateTime" : 12345 } </code> </pre> @@ -327,41 +352,42 @@ Content-Type: application/json <code class="prettyprint language-js"> { - "groups" : [ { + "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], - "roles" : [ { + "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], - "options" : { - "property1" : { }, - "property2" : { } - }, "name" : "...", - "users" : [ { + "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], + "options" : { + "property1" : { }, + "property2" : { } + }, + "createdByUser" : "...", "description" : "...", "version" : 12345, + "createTime" : 12345, + "isEnabled" : true, "createdBy" : "...", - "updatedBy" : "...", - "id" : 12345, "guid" : "...", - "updateTime" : 12345, - "isEnabled" : true, - "createTime" : 12345 + "id" : 12345, + "updatedBy" : "...", + "updateTime" : 12345 } </code> </pre> @@ -370,6 +396,88 @@ Content-Type: application/json </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> + + <p></p> + + <table class="table resource-parameters"> + <caption>Request Parameters</caption> + <thead> + <tr> + <th>name</th> + <th>type</th> + <th>description</th> + </tr> + </thead> + <tbody> + <tr> + <td><span class="parameter-name">execUser</span></td> + <td>query</td> + <td><span class="parameter-description"></span></td> + </tr> + <tr> + <td><span class="parameter-name">serviceName</span></td> + <td>query</td> + <td><span class="parameter-description"></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">array of string + (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">list of string + (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/roles/names +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-txt"> +... + </code> + </pre> + </div> + </div> + </div> + </div> + <div id="resource_RoleREST_deleteRole_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/roles/roles/{id} <a href="../roles/roles/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> @@ -437,10 +545,497 @@ HTTP/1.1 204 No Content </thead> <tbody> <tr> - <td><span class="parameter-name">id</span></td> - <td>path</td> + <td><span class="parameter-name">id</span></td> + <td>path</td> + <td><span class="parameter-description"></span></td> + <td><span class="parameter-constraints">long</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_RangerRole.html">RangerRole</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_rangerRole.html">rangerRole</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/roles/{id} +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" : [ { + "name" : "...", + "isAdmin" : true + }, { + "name" : "...", + "isAdmin" : true + } ], + "users" : [ { + "name" : "...", + "isAdmin" : true + }, { + "name" : "...", + "isAdmin" : true + } ], + "name" : "...", + "groups" : [ { + "name" : "...", + "isAdmin" : true + }, { + "name" : "...", + "isAdmin" : true + } ], + "options" : { + "property1" : { }, + "property2" : { } + }, + "createdByUser" : "...", + "description" : "...", + "version" : 12345, + "createTime" : 12345, + "isEnabled" : true, + "createdBy" : "...", + "guid" : "...", + "id" : 12345, + "updatedBy" : "...", + "updateTime" : 12345 +} + </code> + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_RoleREST_updateRole_PUT"> + <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/roles/roles/{id} <a href="../roles/roles/{id}" 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>constraints</th> + </tr> + </thead> + <tbody> + <tr> + <td><span class="parameter-name">id</span></td> + <td>path</td> + <td><span class="parameter-description"></span></td> + <td><span class="parameter-constraints">long</span></td> + </tr> + </tbody> + </table> + + <table class="table resource-request-body"> + <caption>Request Body</caption> + <thead> + <tr> + <th>media type</th> + <th>data type</th> + </tr> + </thead> + <tbody> + <tr> + <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> + <td><span class="datatype-reference"><a href="json_RangerRole.html">RangerRole</a> + (JSON)</span></td> + </tr> + <tr> + <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> + <td><span class="datatype-reference"><a href="xml_ns0_rangerRole.html">rangerRole</a> + (XML)</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_RangerRole.html">RangerRole</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_rangerRole.html">rangerRole</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> +PUT /roles/roles/{id} +Content-Type: application/json +Accept: application/json + + <code class="prettyprint language-js"> +{ + "roles" : [ { + "name" : "...", + "isAdmin" : true + }, { + "name" : "...", + "isAdmin" : true + } ], + "users" : [ { + "name" : "...", + "isAdmin" : true + }, { + "name" : "...", + "isAdmin" : true + } ], + "name" : "...", + "groups" : [ { + "name" : "...", + "isAdmin" : true + }, { + "name" : "...", + "isAdmin" : true + } ], + "options" : { + "property1" : { }, + "property2" : { } + }, + "createdByUser" : "...", + "description" : "...", + "version" : 12345, + "createTime" : 12345, + "isEnabled" : true, + "createdBy" : "...", + "guid" : "...", + "id" : 12345, + "updatedBy" : "...", + "updateTime" : 12345 +} + </code> + </pre> + </div> + <div class="col-md-6"> + <h5>Response</h5> + <pre> +HTTP/1.1 204 No Content +Content-Type: application/json + + <code class="prettyprint language-js"> +{ + "roles" : [ { + "name" : "...", + "isAdmin" : true + }, { + "name" : "...", + "isAdmin" : true + } ], + "users" : [ { + "name" : "...", + "isAdmin" : true + }, { + "name" : "...", + "isAdmin" : true + } ], + "name" : "...", + "groups" : [ { + "name" : "...", + "isAdmin" : true + }, { + "name" : "...", + "isAdmin" : true + } ], + "options" : { + "property1" : { }, + "property2" : { } + }, + "createdByUser" : "...", + "description" : "...", + "version" : 12345, + "createTime" : 12345, + "isEnabled" : true, + "createdBy" : "...", + "guid" : "...", + "id" : 12345, + "updatedBy" : "...", + "updateTime" : 12345 +} + </code> + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_RoleREST_grantRole_PUT"> + <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/roles/roles/grant/{serviceName} <a href="../roles/roles/grant/{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> + </tr> + </thead> + <tbody> + <tr> + <td><span class="parameter-name">serviceName</span></td> + <td>path</td> + <td><span class="parameter-description"></span></td> + </tr> + </tbody> + </table> + + <table class="table resource-request-body"> + <caption>Request Body</caption> + <thead> + <tr> + <th>media type</th> + <th>data type</th> + </tr> + </thead> + <tbody> + <tr> + <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> + <td><span class="datatype-reference"><a href="json_GrantRevokeRoleRequest.html">GrantRevokeRoleRequest</a> + (JSON)</span></td> + </tr> + <tr> + <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> + <td><span class="datatype-reference"><a href="xml_ns0_grantRevokeRoleRequest.html">grantRevokeRoleRequest</a> + (XML)</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_RESTResponse.html">RESTResponse</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_RESTResponse.html">RESTResponse</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> +PUT /roles/roles/grant/{serviceName} +Content-Type: application/json +Accept: application/json + + <code class="prettyprint language-js"> +{ + "requestData" : "...", + "clusterName" : "...", + "roles" : [ "...", "..." ], + "targetRoles" : [ "...", "..." ], + "users" : [ "...", "..." ], + "grantorGroups" : [ "...", "..." ], + "clientIPAddress" : "...", + "sessionId" : "...", + "clientType" : "...", + "grantor" : "...", + "grantOption" : true, + "groups" : [ "...", "..." ] +} + </code> + </pre> + </div> + <div class="col-md-6"> + <h5>Response</h5> + <pre> +HTTP/1.1 204 No Content +Content-Type: application/json + + <code class="prettyprint language-js"> +{ + "statusCode" : 12345, + "httpStatusCode" : 12345, + "message" : "...", + "msgDesc" : "...", + "messageList" : [ { + "fieldName" : "...", + "objectId" : 12345, + "rbKey" : "...", + "message" : "...", + "name" : "..." + }, { + "fieldName" : "...", + "objectId" : 12345, + "rbKey" : "...", + "message" : "...", + "name" : "..." + } ] +} + </code> + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_RoleREST_deleteRole_DELETE"> + <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/roles/roles/name/{name} <a href="../roles/roles/name/{name}" 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> + </tr> + </thead> + <tbody> + <tr> + <td><span class="parameter-name">name</span></td> + <td>path</td> + <td><span class="parameter-description"></span></td> + </tr> + <tr> + <td><span class="parameter-name">execUser</span></td> + <td>query</td> + <td><span class="parameter-description"></span></td> + </tr> + <tr> + <td><span class="parameter-name">serviceName</span></td> + <td>query</td> + <td><span class="parameter-description"></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> +DELETE /roles/roles/name/{name} +Content-Type: */* + + <code class="prettyprint language-txt"> +... + </code> + </pre> + </div> + <div class="col-md-6"> + <h5>Response</h5> + <pre> +HTTP/1.1 204 No Content + + </pre> + </div> + </div> + </div> + </div> + + <div id="resource_RoleREST_getRole_GET"> + <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/roles/roles/name/{name} <a href="../roles/roles/name/{name}" 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> + </tr> + </thead> + <tbody> + <tr> + <td><span class="parameter-name">name</span></td> + <td>path</td> + <td><span class="parameter-description"></span></td> + </tr> + <tr> + <td><span class="parameter-name">execUser</span></td> + <td>query</td> + <td><span class="parameter-description"></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-constraints">long</span></td> </tr> </tbody> </table> @@ -475,7 +1070,7 @@ HTTP/1.1 204 No Content <div class="col-md-6"> <h5>Request</h5> <pre> -GET /roles/roles/{id} +GET /roles/roles/name/{name} Content-Type: */* Accept: application/json @@ -492,41 +1087,42 @@ Content-Type: application/json <code class="prettyprint language-js"> { - "groups" : [ { + "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], - "roles" : [ { + "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], - "options" : { - "property1" : { }, - "property2" : { } - }, "name" : "...", - "users" : [ { + "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], + "options" : { + "property1" : { }, + "property2" : { } + }, + "createdByUser" : "...", "description" : "...", "version" : 12345, + "createTime" : 12345, + "isEnabled" : true, "createdBy" : "...", - "updatedBy" : "...", - "id" : 12345, "guid" : "...", - "updateTime" : 12345, - "isEnabled" : true, - "createTime" : 12345 + "id" : 12345, + "updatedBy" : "...", + "updateTime" : 12345 } </code> </pre> @@ -535,8 +1131,8 @@ Content-Type: application/json </div> </div> - <div id="resource_RoleREST_updateRole_PUT"> - <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/roles/roles/{id} <a href="../roles/roles/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + <div id="resource_RoleREST_revokeRole_PUT"> + <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/roles/roles/revoke/{serviceName} <a href="../roles/roles/revoke/{serviceName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> @@ -547,15 +1143,13 @@ Content-Type: application/json <th>name</th> <th>type</th> <th>description</th> - <th>constraints</th> </tr> </thead> <tbody> <tr> - <td><span class="parameter-name">id</span></td> + <td><span class="parameter-name">serviceName</span></td> <td>path</td> <td><span class="parameter-description"></span></td> - <td><span class="parameter-constraints">long</span></td> </tr> </tbody> </table> @@ -571,12 +1165,12 @@ Content-Type: application/json <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> - <td><span class="datatype-reference"><a href="json_RangerRole.html">RangerRole</a> + <td><span class="datatype-reference"><a href="json_GrantRevokeRoleRequest.html">GrantRevokeRoleRequest</a> (JSON)</span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> - <td><span class="datatype-reference"><a href="xml_ns0_rangerRole.html">rangerRole</a> + <td><span class="datatype-reference"><a href="xml_ns0_grantRevokeRoleRequest.html">grantRevokeRoleRequest</a> (XML)</span></td> </tr> </tbody> @@ -594,13 +1188,13 @@ Content-Type: application/json <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_RangerRole.html">RangerRole</a> + <td><span class="datatype-reference"><a href="json_RESTResponse.html">RESTResponse</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_rangerRole.html">rangerRole</a> + <td><span class="datatype-reference"><a href="xml_ns0_RESTResponse.html">RESTResponse</a> (XML)</span></td> </tr> </tbody> @@ -612,47 +1206,24 @@ Content-Type: application/json <div class="col-md-6"> <h5>Request</h5> <pre> -PUT /roles/roles/{id} +PUT /roles/roles/revoke/{serviceName} Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { - "groups" : [ { - "name" : "...", - "isAdmin" : true - }, { - "name" : "...", - "isAdmin" : true - } ], - "roles" : [ { - "name" : "...", - "isAdmin" : true - }, { - "name" : "...", - "isAdmin" : true - } ], - "options" : { - "property1" : { }, - "property2" : { } - }, - "name" : "...", - "users" : [ { - "name" : "...", - "isAdmin" : true - }, { - "name" : "...", - "isAdmin" : true - } ], - "description" : "...", - "version" : 12345, - "createdBy" : "...", - "updatedBy" : "...", - "id" : 12345, - "guid" : "...", - "updateTime" : 12345, - "isEnabled" : true, - "createTime" : 12345 + "requestData" : "...", + "clusterName" : "...", + "roles" : [ "...", "..." ], + "targetRoles" : [ "...", "..." ], + "users" : [ "...", "..." ], + "grantorGroups" : [ "...", "..." ], + "clientIPAddress" : "...", + "sessionId" : "...", + "clientType" : "...", + "grantor" : "...", + "grantOption" : true, + "groups" : [ "...", "..." ] } </code> </pre> @@ -665,41 +1236,23 @@ Content-Type: application/json <code class="prettyprint language-js"> { - "groups" : [ { - "name" : "...", - "isAdmin" : true - }, { - "name" : "...", - "isAdmin" : true - } ], - "roles" : [ { - "name" : "...", - "isAdmin" : true - }, { - "name" : "...", - "isAdmin" : true - } ], - "options" : { - "property1" : { }, - "property2" : { } - }, - "name" : "...", - "users" : [ { - "name" : "...", - "isAdmin" : true - }, { - "name" : "...", - "isAdmin" : true - } ], - "description" : "...", - "version" : 12345, - "createdBy" : "...", - "updatedBy" : "...", - "id" : 12345, - "guid" : "...", - "updateTime" : 12345, - "isEnabled" : true, - "createTime" : 12345 + "statusCode" : 12345, + "httpStatusCode" : 12345, + "message" : "...", + "msgDesc" : "...", + "messageList" : [ { + "fieldName" : "...", + "objectId" : 12345, + "rbKey" : "...", + "message" : "...", + "name" : "..." + }, { + "fieldName" : "...", + "objectId" : 12345, + "rbKey" : "...", + "message" : "...", + "name" : "..." + } ] } </code> </pre> @@ -708,56 +1261,8 @@ Content-Type: application/json </div> </div> - <div id="resource_RoleREST_deleteRole_DELETE"> - <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/roles/roles/name/{name} <a href="../roles/roles/name/{name}" 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> - </tr> - </thead> - <tbody> - <tr> - <td><span class="parameter-name">name</span></td> - <td>path</td> - <td><span class="parameter-description"></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> -DELETE /roles/roles/name/{name} -Content-Type: */* - - <code class="prettyprint language-txt"> -... - </code> - </pre> - </div> - <div class="col-md-6"> - <h5>Response</h5> - <pre> -HTTP/1.1 204 No Content - - </pre> - </div> - </div> - </div> - </div> - - <div id="resource_RoleREST_getRole_GET"> - <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/roles/roles/name/{name} <a href="../roles/roles/name/{name}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> + <div id="resource_RoleREST_getUserRoles_GET"> + <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/roles/roles/user/{user} <a href="../roles/roles/user/{user}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> @@ -772,7 +1277,7 @@ HTTP/1.1 204 No Content </thead> <tbody> <tr> - <td><span class="parameter-name">name</span></td> + <td><span class="parameter-name">user</span></td> <td>path</td> <td><span class="parameter-description"></span></td> </tr> @@ -791,13 +1296,13 @@ HTTP/1.1 204 No Content <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_RangerRole.html">RangerRole</a> + <td><span class="datatype-reference">array of string (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_rangerRole.html">rangerRole</a> + <td><span class="datatype-reference">list of string (XML)</span></td> </tr> </tbody> @@ -809,7 +1314,7 @@ HTTP/1.1 204 No Content <div class="col-md-6"> <h5>Request</h5> <pre> -GET /roles/roles/name/{name} +GET /roles/roles/user/{user} Content-Type: */* Accept: application/json @@ -824,44 +1329,8 @@ Accept: application/json HTTP/1.1 200 OK Content-Type: application/json - <code class="prettyprint language-js"> -{ - "groups" : [ { - "name" : "...", - "isAdmin" : true - }, { - "name" : "...", - "isAdmin" : true - } ], - "roles" : [ { - "name" : "...", - "isAdmin" : true - }, { - "name" : "...", - "isAdmin" : true - } ], - "options" : { - "property1" : { }, - "property2" : { } - }, - "name" : "...", - "users" : [ { - "name" : "...", - "isAdmin" : true - }, { - "name" : "...", - "isAdmin" : true - } ], - "description" : "...", - "version" : 12345, - "createdBy" : "...", - "updatedBy" : "...", - "id" : 12345, - "guid" : "...", - "updateTime" : 12345, - "isEnabled" : true, - "createTime" : 12345 -} + <code class="prettyprint language-txt"> +... </code> </pre> </div> @@ -943,41 +1412,42 @@ Content-Type: application/json <code class="prettyprint language-js"> { - "groups" : [ { + "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], - "roles" : [ { + "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], - "options" : { - "property1" : { }, - "property2" : { } - }, "name" : "...", - "users" : [ { + "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], + "options" : { + "property1" : { }, + "property2" : { } + }, + "createdByUser" : "...", "description" : "...", "version" : 12345, + "createTime" : 12345, + "isEnabled" : true, "createdBy" : "...", - "updatedBy" : "...", - "id" : 12345, "guid" : "...", - "updateTime" : 12345, - "isEnabled" : true, - "createTime" : 12345 + "id" : 12345, + "updatedBy" : "...", + "updateTime" : 12345 } </code> </pre> @@ -1060,41 +1530,42 @@ Content-Type: application/json <code class="prettyprint language-js"> { - "groups" : [ { + "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], - "roles" : [ { + "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], - "options" : { - "property1" : { }, - "property2" : { } - }, "name" : "...", - "users" : [ { + "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], + "options" : { + "property1" : { }, + "property2" : { } + }, + "createdByUser" : "...", "description" : "...", "version" : 12345, + "createTime" : 12345, + "isEnabled" : true, "createdBy" : "...", - "updatedBy" : "...", - "id" : 12345, "guid" : "...", - "updateTime" : 12345, - "isEnabled" : true, - "createTime" : 12345 + "id" : 12345, + "updatedBy" : "...", + "updateTime" : 12345 } </code> </pre> @@ -1177,41 +1648,42 @@ Content-Type: application/json <code class="prettyprint language-js"> { - "groups" : [ { + "roles" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], - "roles" : [ { + "users" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], - "options" : { - "property1" : { }, - "property2" : { } - }, "name" : "...", - "users" : [ { + "groups" : [ { "name" : "...", "isAdmin" : true }, { "name" : "...", "isAdmin" : true } ], + "options" : { + "property1" : { }, + "property2" : { } + }, + "createdByUser" : "...", "description" : "...", "version" : 12345, + "createTime" : 12345, + "isEnabled" : true, "createdBy" : "...", - "updatedBy" : "...", - "id" : 12345, "guid" : "...", - "updateTime" : 12345, - "isEnabled" : true, - "createTime" : 12345 + "id" : 12345, + "updatedBy" : "...", + "updateTime" : 12345 } </code> </pre>
Modified: ranger/site/trunk/apidocs/resource_SecurityZoneREST.html URL: http://svn.apache.org/viewvc/ranger/site/trunk/apidocs/resource_SecurityZoneREST.html?rev=1864664&r1=1864663&r2=1864664&view=diff ============================================================================== --- ranger/site/trunk/apidocs/resource_SecurityZoneREST.html (original) +++ ranger/site/trunk/apidocs/resource_SecurityZoneREST.html Wed Aug 7 18:15:52 2019 @@ -126,7 +126,7 @@ Content-Type: application/json <code class="prettyprint language-js"> { "securityZones" : [ { - "adminUserGroups" : [ "...", "..." ], + "auditUserGroups" : [ "...", "..." ], "services" : { "property1" : { "resources" : [ { @@ -147,22 +147,22 @@ Content-Type: application/json } ] } }, - "auditUserGroups" : [ "...", "..." ], - "adminUsers" : [ "...", "..." ], + "adminUserGroups" : [ "...", "..." ], "auditUsers" : [ "...", "..." ], - "name" : "...", - "tagServices" : [ "...", "..." ], "description" : "...", + "tagServices" : [ "...", "..." ], + "name" : "...", + "adminUsers" : [ "...", "..." ], "version" : 12345, + "createTime" : 12345, + "isEnabled" : true, "createdBy" : "...", - "updatedBy" : "...", - "id" : 12345, "guid" : "...", - "updateTime" : 12345, - "isEnabled" : true, - "createTime" : 12345 + "id" : 12345, + "updatedBy" : "...", + "updateTime" : 12345 }, { - "adminUserGroups" : [ "...", "..." ], + "auditUserGroups" : [ "...", "..." ], "services" : { "property1" : { "resources" : [ { @@ -183,20 +183,20 @@ Content-Type: application/json } ] } }, - "auditUserGroups" : [ "...", "..." ], - "adminUsers" : [ "...", "..." ], + "adminUserGroups" : [ "...", "..." ], "auditUsers" : [ "...", "..." ], - "name" : "...", - "tagServices" : [ "...", "..." ], "description" : "...", + "tagServices" : [ "...", "..." ], + "name" : "...", + "adminUsers" : [ "...", "..." ], "version" : 12345, + "createTime" : 12345, + "isEnabled" : true, "createdBy" : "...", - "updatedBy" : "...", - "id" : 12345, "guid" : "...", - "updateTime" : 12345, - "isEnabled" : true, - "createTime" : 12345 + "id" : 12345, + "updatedBy" : "...", + "updateTime" : 12345 } ], "listSize" : 12345, "list" : [ { }, { } ], @@ -277,7 +277,7 @@ Accept: application/json <code class="prettyprint language-js"> { - "adminUserGroups" : [ "...", "..." ], + "auditUserGroups" : [ "...", "..." ], "services" : { "property1" : { "resources" : [ { @@ -298,20 +298,20 @@ Accept: application/json } ] } }, - "auditUserGroups" : [ "...", "..." ], - "adminUsers" : [ "...", "..." ], + "adminUserGroups" : [ "...", "..." ], "auditUsers" : [ "...", "..." ], - "name" : "...", - "tagServices" : [ "...", "..." ], "description" : "...", + "tagServices" : [ "...", "..." ], + "name" : "...", + "adminUsers" : [ "...", "..." ], "version" : 12345, + "createTime" : 12345, + "isEnabled" : true, "createdBy" : "...", - "updatedBy" : "...", - "id" : 12345, "guid" : "...", - "updateTime" : 12345, - "isEnabled" : true, - "createTime" : 12345 + "id" : 12345, + "updatedBy" : "...", + "updateTime" : 12345 } </code> </pre> @@ -324,7 +324,7 @@ Content-Type: application/json <code class="prettyprint language-js"> { - "adminUserGroups" : [ "...", "..." ], + "auditUserGroups" : [ "...", "..." ], "services" : { "property1" : { "resources" : [ { @@ -345,20 +345,20 @@ Content-Type: application/json } ] } }, - "auditUserGroups" : [ "...", "..." ], - "adminUsers" : [ "...", "..." ], + "adminUserGroups" : [ "...", "..." ], "auditUsers" : [ "...", "..." ], - "name" : "...", - "tagServices" : [ "...", "..." ], "description" : "...", + "tagServices" : [ "...", "..." ], + "name" : "...", + "adminUsers" : [ "...", "..." ], "version" : 12345, + "createTime" : 12345, + "isEnabled" : true, "createdBy" : "...", - "updatedBy" : "...", - "id" : 12345, "guid" : "...", - "updateTime" : 12345, - "isEnabled" : true, - "createTime" : 12345 + "id" : 12345, + "updatedBy" : "...", + "updateTime" : 12345 } </code> </pre> @@ -489,7 +489,7 @@ Content-Type: application/json <code class="prettyprint language-js"> { - "adminUserGroups" : [ "...", "..." ], + "auditUserGroups" : [ "...", "..." ], "services" : { "property1" : { "resources" : [ { @@ -510,20 +510,20 @@ Content-Type: application/json } ] } }, - "auditUserGroups" : [ "...", "..." ], - "adminUsers" : [ "...", "..." ], + "adminUserGroups" : [ "...", "..." ], "auditUsers" : [ "...", "..." ], - "name" : "...", - "tagServices" : [ "...", "..." ], "description" : "...", + "tagServices" : [ "...", "..." ], + "name" : "...", + "adminUsers" : [ "...", "..." ], "version" : 12345, + "createTime" : 12345, + "isEnabled" : true, "createdBy" : "...", - "updatedBy" : "...", - "id" : 12345, "guid" : "...", - "updateTime" : 12345, - "isEnabled" : true, - "createTime" : 12345 + "id" : 12345, + "updatedBy" : "...", + "updateTime" : 12345 } </code> </pre> @@ -615,7 +615,7 @@ Accept: application/json <code class="prettyprint language-js"> { - "adminUserGroups" : [ "...", "..." ], + "auditUserGroups" : [ "...", "..." ], "services" : { "property1" : { "resources" : [ { @@ -636,20 +636,20 @@ Accept: application/json } ] } }, - "auditUserGroups" : [ "...", "..." ], - "adminUsers" : [ "...", "..." ], + "adminUserGroups" : [ "...", "..." ], "auditUsers" : [ "...", "..." ], - "name" : "...", - "tagServices" : [ "...", "..." ], "description" : "...", + "tagServices" : [ "...", "..." ], + "name" : "...", + "adminUsers" : [ "...", "..." ], "version" : 12345, + "createTime" : 12345, + "isEnabled" : true, "createdBy" : "...", - "updatedBy" : "...", - "id" : 12345, "guid" : "...", - "updateTime" : 12345, - "isEnabled" : true, - "createTime" : 12345 + "id" : 12345, + "updatedBy" : "...", + "updateTime" : 12345 } </code> </pre> @@ -662,7 +662,7 @@ Content-Type: application/json <code class="prettyprint language-js"> { - "adminUserGroups" : [ "...", "..." ], + "auditUserGroups" : [ "...", "..." ], "services" : { "property1" : { "resources" : [ { @@ -683,20 +683,20 @@ Content-Type: application/json } ] } }, - "auditUserGroups" : [ "...", "..." ], - "adminUsers" : [ "...", "..." ], + "adminUserGroups" : [ "...", "..." ], "auditUsers" : [ "...", "..." ], - "name" : "...", - "tagServices" : [ "...", "..." ], "description" : "...", + "tagServices" : [ "...", "..." ], + "name" : "...", + "adminUsers" : [ "...", "..." ], "version" : 12345, + "createTime" : 12345, + "isEnabled" : true, "createdBy" : "...", - "updatedBy" : "...", - "id" : 12345, "guid" : "...", - "updateTime" : 12345, - "isEnabled" : true, - "createTime" : 12345 + "id" : 12345, + "updatedBy" : "...", + "updateTime" : 12345 } </code> </pre> @@ -823,7 +823,7 @@ Content-Type: application/json <code class="prettyprint language-js"> { - "adminUserGroups" : [ "...", "..." ], + "auditUserGroups" : [ "...", "..." ], "services" : { "property1" : { "resources" : [ { @@ -844,20 +844,20 @@ Content-Type: application/json } ] } }, - "auditUserGroups" : [ "...", "..." ], - "adminUsers" : [ "...", "..." ], + "adminUserGroups" : [ "...", "..." ], "auditUsers" : [ "...", "..." ], - "name" : "...", - "tagServices" : [ "...", "..." ], "description" : "...", + "tagServices" : [ "...", "..." ], + "name" : "...", + "adminUsers" : [ "...", "..." ], "version" : 12345, + "createTime" : 12345, + "isEnabled" : true, "createdBy" : "...", - "updatedBy" : "...", - "id" : 12345, "guid" : "...", - "updateTime" : 12345, - "isEnabled" : true, - "createTime" : 12345 + "id" : 12345, + "updatedBy" : "...", + "updateTime" : 12345 } </code> </pre>