apidocs/resource_SecurityZoneREST.html

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1">  <title>Ranger REST API: SecurityZoneREST</title>  <meta name="viewport" content="width=device-width, initial-scale=1.0">  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">  <link rel="stylesheet" href="css/enunciate.css">   </head> <body data-spy="scroll" data-target="#apinav"> <nav class="navbar navbar-inverse navbar-fixed-top"> <div class="container-fluid"> <div class="navbar-header"> <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <a class="navbar-brand" href="index.html">Ranger REST API: SecurityZoneREST</a> </div> <div id="navbar" class="navbar-collapse collapse"> <ul class="nav navbar-nav navbar-right"> <li><a href="resources.html">Resources</a></li> <li><a href="data.html">Data Types</a></li> </ul> </div> </div> </nav> <div class="container-fluid"> <div class="row"> <div class="col-sm-3 col-md-2 sidebar" id="apinav"> <ul class="nav nav-sidebar"> <li><a href="#resource_SecurityZoneREST_getAllZones_GET"><abbr title="GET /zones/zones"><span class="sideoverflow">GET /zones/zones</span></abbr></a></li> <li><a href="#resource_SecurityZoneREST_createSecurityZone_POST"><abbr title="POST /zones/zones"><span class="sideoverflow">POST /zones/zones</span></abbr></a></li> <li><a href="#resource_SecurityZoneREST_deleteSecurityZone_DELETE"><abbr title="DELETE /zones/zones/{id}"><span class="sideoverflow">DELETE /zones/zones/{id}</span></abbr></a></li> <li><a href="#resource_SecurityZoneREST_getSecurityZone_GET"><abbr title="GET /zones/zones/{id}"><span class="sideoverflow">GET /zones/zones/{id}</span></abbr></a></li> <li><a href="#resource_SecurityZoneREST_updateSecurityZone_PUT"><abbr title="PUT /zones/zones/{id}"><span class="sideoverflow">PUT /zones/zones/{id}</span></abbr></a></li> <li><a href="#resource_SecurityZoneREST_deleteSecurityZone_DELETE"><abbr title="DELETE /zones/zones/name/{name}"><span class="sideoverflow">DELETE /zones/zones/name/{name}</span></abbr></a></li> <li><a href="#resource_SecurityZoneREST_getSecurityZone_GET"><abbr title="GET /zones/zones/name/{name}"><span class="sideoverflow">GET /zones/zones/name/{name}</span></abbr></a></li> <li class="divider"></li> <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> </ul> </div> <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main"> <ol class="breadcrumb" id="top"> <li class="active dropdown"><a href="index.html">Home</a></li> <li class="active dropdown"><a href="resources.html">Resources</a></li> <li class="dropdown"><a href="resource_SecurityZoneREST.html">SecurityZoneREST</a></li> </ol> <h1 class="page-header">SecurityZoneREST <small>Resource</small></h1> <p></p> <div id="resource_SecurityZoneREST_getAllZones_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/zones/zones <a href="../zones/zones" 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_RangerSecurityZoneList.html">RangerSecurityZoneList</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_rangerSecurityZoneList.html">rangerSecurityZoneList</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 /zones/zones 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"> { "securityZones" : [ { "tagServices" : [ "...", "..." ], "description" : "...", "auditUsers" : [ "...", "..." ], "adminUserGroups" : [ "...", "..." ], "adminUsers" : [ "...", "..." ], "name" : "...", "services" : { "property1" : { "resources" : [ { "property1" : [ ], "property2" : [ ] }, { "property1" : [ ], "property2" : [ ] } ] }, "property2" : { "resources" : [ { "property1" : [ ], "property2" : [ ] }, { "property1" : [ ], "property2" : [ ] } ] } }, "auditUserGroups" : [ "...", "..." ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true }, { "tagServices" : [ "...", "..." ], "description" : "...", "auditUsers" : [ "...", "..." ], "adminUserGroups" : [ "...", "..." ], "adminUsers" : [ "...", "..." ], "name" : "...", "services" : { "property1" : { "resources" : [ { "property1" : [ ], "property2" : [ ] }, { "property1" : [ ], "property2" : [ ] } ] }, "property2" : { "resources" : [ { "property1" : [ ], "property2" : [ ] }, { "property1" : [ ], "property2" : [ ] } ] } }, "auditUserGroups" : [ "...", "..." ], "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_SecurityZoneREST_createSecurityZone_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/zones/zones <a href="../zones/zones" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <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_RangerSecurityZone.html">RangerSecurityZone</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_rangerSecurityZone.html">rangerSecurityZone</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_RangerSecurityZone.html">RangerSecurityZone</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_rangerSecurityZone.html">rangerSecurityZone</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> POST /zones/zones Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "tagServices" : [ "...", "..." ], "description" : "...", "auditUsers" : [ "...", "..." ], "adminUserGroups" : [ "...", "..." ], "adminUsers" : [ "...", "..." ], "name" : "...", "services" : { "property1" : { "resources" : [ { "property1" : [ ], "property2" : [ ] }, { "property1" : [ ], "property2" : [ ] } ] }, "property2" : { "resources" : [ { "property1" : [ ], "property2" : [ ] }, { "property1" : [ ], "property2" : [ ] } ] } }, "auditUserGroups" : [ "...", "..." ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true } </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 201 Created Content-Type: application/json <code class="prettyprint language-js"> { "tagServices" : [ "...", "..." ], "description" : "...", "auditUsers" : [ "...", "..." ], "adminUserGroups" : [ "...", "..." ], "adminUsers" : [ "...", "..." ], "name" : "...", "services" : { "property1" : { "resources" : [ { "property1" : [ ], "property2" : [ ] }, { "property1" : [ ], "property2" : [ ] } ] }, "property2" : { "resources" : [ { "property1" : [ ], "property2" : [ ] }, { "property1" : [ ], "property2" : [ ] } ] } }, "auditUserGroups" : [ "...", "..." ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true } </code> </pre> </div> </div> </div> </div> <div id="resource_SecurityZoneREST_deleteSecurityZone_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/zones/zones/{id} <a href="../zones/zones/{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> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> DELETE /zones/zones/{id} 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_SecurityZoneREST_getSecurityZone_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/zones/zones/{id} <a href="../zones/zones/{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-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_RangerSecurityZone.html">RangerSecurityZone</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_rangerSecurityZone.html">rangerSecurityZone</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 /zones/zones/{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"> { "tagServices" : [ "...", "..." ], "description" : "...", "auditUsers" : [ "...", "..." ], "adminUserGroups" : [ "...", "..." ], "adminUsers" : [ "...", "..." ], "name" : "...", "services" : { "property1" : { "resources" : [ { "property1" : [ ], "property2" : [ ] }, { "property1" : [ ], "property2" : [ ] } ] }, "property2" : { "resources" : [ { "property1" : [ ], "property2" : [ ] }, { "property1" : [ ], "property2" : [ ] } ] } }, "auditUserGroups" : [ "...", "..." ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true } </code> </pre> </div> </div> </div> </div> <div id="resource_SecurityZoneREST_updateSecurityZone_PUT"> <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/zones/zones/{id} <a href="../zones/zones/{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_RangerSecurityZone.html">RangerSecurityZone</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_rangerSecurityZone.html">rangerSecurityZone</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_RangerSecurityZone.html">RangerSecurityZone</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_rangerSecurityZone.html">rangerSecurityZone</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 /zones/zones/{id} Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "tagServices" : [ "...", "..." ], "description" : "...", "auditUsers" : [ "...", "..." ], "adminUserGroups" : [ "...", "..." ], "adminUsers" : [ "...", "..." ], "name" : "...", "services" : { "property1" : { "resources" : [ { "property1" : [ ], "property2" : [ ] }, { "property1" : [ ], "property2" : [ ] } ] }, "property2" : { "resources" : [ { "property1" : [ ], "property2" : [ ] }, { "property1" : [ ], "property2" : [ ] } ] } }, "auditUserGroups" : [ "...", "..." ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true } </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"> { "tagServices" : [ "...", "..." ], "description" : "...", "auditUsers" : [ "...", "..." ], "adminUserGroups" : [ "...", "..." ], "adminUsers" : [ "...", "..." ], "name" : "...", "services" : { "property1" : { "resources" : [ { "property1" : [ ], "property2" : [ ] }, { "property1" : [ ], "property2" : [ ] } ] }, "property2" : { "resources" : [ { "property1" : [ ], "property2" : [ ] }, { "property1" : [ ], "property2" : [ ] } ] } }, "auditUserGroups" : [ "...", "..." ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true } </code> </pre> </div> </div> </div> </div> <div id="resource_SecurityZoneREST_deleteSecurityZone_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/zones/zones/name/{name} <a href="../zones/zones/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 /zones/zones/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_SecurityZoneREST_getSecurityZone_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/zones/zones/name/{name} <a href="../zones/zones/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> <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_RangerSecurityZone.html">RangerSecurityZone</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_rangerSecurityZone.html">rangerSecurityZone</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 /zones/zones/name/{name} 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"> { "tagServices" : [ "...", "..." ], "description" : "...", "auditUsers" : [ "...", "..." ], "adminUserGroups" : [ "...", "..." ], "adminUsers" : [ "...", "..." ], "name" : "...", "services" : { "property1" : { "resources" : [ { "property1" : [ ], "property2" : [ ] }, { "property1" : [ ], "property2" : [ ] } ] }, "property2" : { "resources" : [ { "property1" : [ ], "property2" : [ ] }, { "property1" : [ ], "property2" : [ ] } ] } }, "auditUserGroups" : [ "...", "..." ], "createTime" : 12345, "id" : 12345, "updatedBy" : "...", "version" : 12345, "createdBy" : "...", "guid" : "...", "updateTime" : 12345, "isEnabled" : true } </code> </pre> </div> </div> </div> </div> <footer class="footer"> <div class="container"> <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p> </div> </footer> </div> </div> </div>  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>  <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script> <script> $(function() { $(".clickable-row").click(function() { window.document.location = $(this).data("href"); }); $('[data-toggle="tooltip"]').tooltip() }); </script> </body> </html>

apidocs/resource_SecurityZoneREST.html (821 lines of code) (raw):