| <!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"> |
| <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> |
| |
| <title>Ranger REST API: ServiceREST</title> |
| |
| <!-- Mobile viewport optimized: j.mp/bplateviewport --> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <!-- Bootstrap core CSS --> |
| <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css"> |
| |
| <!--custom css for these pages--> |
| <link rel="stylesheet" href="css/enunciate.css"> |
| |
| <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> |
| <!--[if lt IE 9]> |
| <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script> |
| <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> |
| <![endif]--> |
| </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: ServiceREST</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_ServiceREST_checkSSO_GET"><abbr title="GET /plugins/checksso"><span class="sideoverflow">GET /plugins/checksso</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getCSRFProperties_GET"><abbr title="GET /plugins/csrfconf"><span class="sideoverflow">GET /plugins/csrfconf</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getServiceDefs_GET"><abbr title="GET /plugins/definitions"><span class="sideoverflow">GET /plugins/definitions</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_createServiceDef_POST"><abbr title="POST /plugins/definitions"><span class="sideoverflow">POST /plugins/definitions</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getPolicies_GET"><abbr title="GET /plugins/policies"><span class="sideoverflow">GET /plugins/policies</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_createPolicy_POST"><abbr title="POST /plugins/policies"><span class="sideoverflow">POST /plugins/policies</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getPolicyLabels_GET"><abbr title="GET /plugins/policyLabels"><span class="sideoverflow">GET /plugins/policyLabels</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getServices_GET"><abbr title="GET /plugins/services"><span class="sideoverflow">GET /plugins/services</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_createService_POST"><abbr title="POST /plugins/services"><span class="sideoverflow">POST /plugins/services</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_deleteClusterServices_DELETE"><abbr title="DELETE /plugins/cluster-services/{clusterName}"><span class="sideoverflow">DELETE /plugins/cluster-services/{clusterName}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_deleteServiceDef_DELETE"><abbr title="DELETE /plugins/definitions/{id}"><span class="sideoverflow">DELETE /plugins/definitions/{id}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getServiceDef_GET"><abbr title="GET /plugins/definitions/{id}"><span class="sideoverflow">GET /plugins/definitions/{id}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_updateServiceDef_PUT"><abbr title="PUT /plugins/definitions/{id}"><span class="sideoverflow">PUT /plugins/definitions/{id}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getPluginsInfo_GET"><abbr title="GET /plugins/plugins/info"><span class="sideoverflow">GET /plugins/plugins/info</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_applyPolicy_POST"><abbr title="POST /plugins/policies/apply"><span class="sideoverflow">POST /plugins/policies/apply</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_countPolicies_GET"><abbr title="GET /plugins/policies/count"><span class="sideoverflow">GET /plugins/policies/count</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getPoliciesInCsv_GET"><abbr title="GET /plugins/policies/csv"><span class="sideoverflow">GET /plugins/policies/csv</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getPoliciesInExcel_GET"><abbr title="GET /plugins/policies/downloadExcel"><span class="sideoverflow">GET /plugins/policies/downloadExcel</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getPolicyFromEventTime_GET"><abbr title="GET /plugins/policies/eventTime"><span class="sideoverflow">GET /plugins/policies/eventTime</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getPoliciesInJson_GET"><abbr title="GET /plugins/policies/exportJson"><span class="sideoverflow">GET /plugins/policies/exportJson</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_importPoliciesFromFile_POST"><abbr title="POST /plugins/policies/importPoliciesFromFile"><span class="sideoverflow">POST /plugins/policies/importPoliciesFromFile</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_deletePolicy_DELETE"><abbr title="DELETE /plugins/policies/{id}"><span class="sideoverflow">DELETE /plugins/policies/{id}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getPolicy_GET"><abbr title="GET /plugins/policies/{id}"><span class="sideoverflow">GET /plugins/policies/{id}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_updatePolicy_PUT"><abbr title="PUT /plugins/policies/{id}"><span class="sideoverflow">PUT /plugins/policies/{id}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_deletePolicyDeltas_DELETE"><abbr title="DELETE /plugins/server/policydeltas"><span class="sideoverflow">DELETE /plugins/server/policydeltas</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_countServices_GET"><abbr title="GET /plugins/services/count"><span class="sideoverflow">GET /plugins/services/count</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_validateConfig_POST"><abbr title="POST /plugins/services/validateConfig"><span class="sideoverflow">POST /plugins/services/validateConfig</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_deleteService_DELETE"><abbr title="DELETE /plugins/services/{id}"><span class="sideoverflow">DELETE /plugins/services/{id}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getService_GET"><abbr title="GET /plugins/services/{id}"><span class="sideoverflow">GET /plugins/services/{id}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_updateService_PUT"><abbr title="PUT /plugins/services/{id}"><span class="sideoverflow">PUT /plugins/services/{id}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getServiceDefByName_GET"><abbr title="GET /plugins/definitions/name/{name}"><span class="sideoverflow">GET /plugins/definitions/name/{name}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getMetricByType_GET"><abbr title="GET /plugins/metrics/type/{type}"><span class="sideoverflow">GET /plugins/metrics/type/{type}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getServicePoliciesIfUpdated_GET"><abbr title="GET /plugins/policies/download/{serviceName}"><span class="sideoverflow">GET /plugins/policies/download/{serviceName}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getServicePolicies_GET"><abbr title="GET /plugins/policies/service/{id}"><span class="sideoverflow">GET /plugins/policies/service/{id}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getPoliciesForResource_GET"><abbr title="GET /plugins/policies/{serviceDefName}/for-resource"><span class="sideoverflow">GET /plugins/policies/{serviceDefName}/for-resource</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getPolicyVersionList_GET"><abbr title="GET /plugins/policy/{policyId}/versionList"><span class="sideoverflow">GET /plugins/policy/{policyId}/versionList</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_purgeEmptyPolicies_DELETE"><abbr title="DELETE /plugins/server/purgepolicies/{serviceName}"><span class="sideoverflow">DELETE /plugins/server/purgepolicies/{serviceName}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_grantAccess_POST"><abbr title="POST /plugins/services/grant/{serviceName}"><span class="sideoverflow">POST /plugins/services/grant/{serviceName}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_lookupResource_POST"><abbr title="POST /plugins/services/lookupResource/{serviceName}"><span class="sideoverflow">POST /plugins/services/lookupResource/{serviceName}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getServiceByName_GET"><abbr title="GET /plugins/services/name/{name}"><span class="sideoverflow">GET /plugins/services/name/{name}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_revokeAccess_POST"><abbr title="POST /plugins/services/revoke/{serviceName}"><span class="sideoverflow">POST /plugins/services/revoke/{serviceName}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getServicePoliciesByName_GET"><abbr title="GET /plugins/policies/service/name/{name}"><span class="sideoverflow">GET /plugins/policies/service/name/{name}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getPolicyForVersionNumber_GET"><abbr title="GET /plugins/policy/{policyId}/version/{versionNo}"><span class="sideoverflow">GET /plugins/policy/{policyId}/version/{versionNo}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_getSecureServicePoliciesIfUpdated_GET"><abbr title="GET /plugins/secure/policies/download/{serviceName}"><span class="sideoverflow">GET /plugins/secure/policies/download/{serviceName}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_secureGrantAccess_POST"><abbr title="POST /plugins/secure/services/grant/{serviceName}"><span class="sideoverflow">POST /plugins/secure/services/grant/{serviceName}</span></abbr></a></li> |
| <li><a href="#resource_ServiceREST_secureRevokeAccess_POST"><abbr title="POST /plugins/secure/services/revoke/{serviceName}"><span class="sideoverflow">POST /plugins/secure/services/revoke/{serviceName}</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_ServiceREST.html">ServiceREST</a></li> |
| </ol> |
| |
| <h1 class="page-header">ServiceREST <small>Resource</small></h1> |
| |
| <p></p> |
| |
| <div id="resource_ServiceREST_checkSSO_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/checksso <a href="../plugins/checksso" 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: text/plain" HTTP header to request that this media type be provided by the server."><span class="response-type">text/plain</span></abbr></td> |
| <td><span class="datatype-reference">(custom) |
| </span></td> |
| <td><span class="response-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> |
| GET /plugins/checksso |
| Content-Type: */* |
| Accept: text/plain |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: text/plain |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_getCSRFProperties_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/csrfconf <a href="../plugins/csrfconf" 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">map of object |
| (JSON)</span></td> |
| <td><span class="response-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> |
| GET /plugins/csrfconf |
| 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_ServiceREST_getServiceDefs_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/definitions <a href="../plugins/definitions" 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_RangerServiceDefList.html">RangerServiceDefList</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_rangerServiceDefList.html">rangerServiceDefList</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 /plugins/definitions |
| 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"> |
| { |
| "serviceDefs" : [ { |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskDef" : { |
| "maskTypes" : [ { }, { } ], |
| "accessTypes" : [ { }, { } ], |
| "resources" : [ { }, { } ] |
| }, |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ], |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "rowFilterDef" : { |
| "accessTypes" : [ { }, { } ], |
| "resources" : [ { }, { } ] |
| }, |
| "description" : "...", |
| "policyConditions" : [ { |
| "uiHint" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "name" : "...", |
| "validationRegEx" : "...", |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "evaluatorOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "validationMessage" : "...", |
| "evaluator" : "...", |
| "rbKeyValidationMessage" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "uiHint" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "name" : "...", |
| "validationRegEx" : "...", |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "evaluatorOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "validationMessage" : "...", |
| "evaluator" : "...", |
| "rbKeyValidationMessage" : "...", |
| "rbKeyDescription" : "..." |
| } ], |
| "implClass" : "...", |
| "displayName" : "...", |
| "name" : "...", |
| "contextEnrichers" : [ { |
| "name" : "...", |
| "itemId" : 12345, |
| "enricherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "enricher" : "..." |
| }, { |
| "name" : "...", |
| "itemId" : 12345, |
| "enricherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "enricher" : "..." |
| } ], |
| "enums" : [ { |
| "name" : "...", |
| "defaultIndex" : 12345, |
| "elements" : [ { }, { } ], |
| "itemId" : 12345 |
| }, { |
| "name" : "...", |
| "defaultIndex" : 12345, |
| "elements" : [ { }, { } ], |
| "itemId" : 12345 |
| } ], |
| "rbKeyDescription" : "...", |
| "configs" : [ { |
| "rbKeyDescription" : "...", |
| "subType" : "...", |
| "rbKeyLabel" : "...", |
| "defaultValue" : "...", |
| "rbKeyValidationMessage" : "...", |
| "label" : "...", |
| "name" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "mandatory" : true, |
| "validationRegEx" : "...", |
| "validationMessage" : "...", |
| "type" : "...", |
| "uiHint" : "..." |
| }, { |
| "rbKeyDescription" : "...", |
| "subType" : "...", |
| "rbKeyLabel" : "...", |
| "defaultValue" : "...", |
| "rbKeyValidationMessage" : "...", |
| "label" : "...", |
| "name" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "mandatory" : true, |
| "validationRegEx" : "...", |
| "validationMessage" : "...", |
| "type" : "...", |
| "uiHint" : "..." |
| } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, { |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskDef" : { |
| "maskTypes" : [ { }, { } ], |
| "accessTypes" : [ { }, { } ], |
| "resources" : [ { }, { } ] |
| }, |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ], |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "rowFilterDef" : { |
| "accessTypes" : [ { }, { } ], |
| "resources" : [ { }, { } ] |
| }, |
| "description" : "...", |
| "policyConditions" : [ { |
| "uiHint" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "name" : "...", |
| "validationRegEx" : "...", |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "evaluatorOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "validationMessage" : "...", |
| "evaluator" : "...", |
| "rbKeyValidationMessage" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "uiHint" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "name" : "...", |
| "validationRegEx" : "...", |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "evaluatorOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "validationMessage" : "...", |
| "evaluator" : "...", |
| "rbKeyValidationMessage" : "...", |
| "rbKeyDescription" : "..." |
| } ], |
| "implClass" : "...", |
| "displayName" : "...", |
| "name" : "...", |
| "contextEnrichers" : [ { |
| "name" : "...", |
| "itemId" : 12345, |
| "enricherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "enricher" : "..." |
| }, { |
| "name" : "...", |
| "itemId" : 12345, |
| "enricherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "enricher" : "..." |
| } ], |
| "enums" : [ { |
| "name" : "...", |
| "defaultIndex" : 12345, |
| "elements" : [ { }, { } ], |
| "itemId" : 12345 |
| }, { |
| "name" : "...", |
| "defaultIndex" : 12345, |
| "elements" : [ { }, { } ], |
| "itemId" : 12345 |
| } ], |
| "rbKeyDescription" : "...", |
| "configs" : [ { |
| "rbKeyDescription" : "...", |
| "subType" : "...", |
| "rbKeyLabel" : "...", |
| "defaultValue" : "...", |
| "rbKeyValidationMessage" : "...", |
| "label" : "...", |
| "name" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "mandatory" : true, |
| "validationRegEx" : "...", |
| "validationMessage" : "...", |
| "type" : "...", |
| "uiHint" : "..." |
| }, { |
| "rbKeyDescription" : "...", |
| "subType" : "...", |
| "rbKeyLabel" : "...", |
| "defaultValue" : "...", |
| "rbKeyValidationMessage" : "...", |
| "label" : "...", |
| "name" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "mandatory" : true, |
| "validationRegEx" : "...", |
| "validationMessage" : "...", |
| "type" : "...", |
| "uiHint" : "..." |
| } ], |
| "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_ServiceREST_createServiceDef_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/plugins/definitions <a href="../plugins/definitions" 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_RangerServiceDef.html">RangerServiceDef</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_rangerServiceDef.html">rangerServiceDef</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_RangerServiceDef.html">RangerServiceDef</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_rangerServiceDef.html">rangerServiceDef</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 /plugins/definitions |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskDef" : { |
| "maskTypes" : [ { |
| "itemId" : 12345, |
| "rbKeyDescription" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "description" : "...", |
| "transformer" : "...", |
| "name" : "...", |
| "label" : "..." |
| }, { |
| "itemId" : 12345, |
| "rbKeyDescription" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "description" : "...", |
| "transformer" : "...", |
| "name" : "...", |
| "label" : "..." |
| } ], |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ] |
| }, |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ], |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "rowFilterDef" : { |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ] |
| }, |
| "description" : "...", |
| "policyConditions" : [ { |
| "uiHint" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "name" : "...", |
| "validationRegEx" : "...", |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "evaluatorOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "validationMessage" : "...", |
| "evaluator" : "...", |
| "rbKeyValidationMessage" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "uiHint" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "name" : "...", |
| "validationRegEx" : "...", |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "evaluatorOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "validationMessage" : "...", |
| "evaluator" : "...", |
| "rbKeyValidationMessage" : "...", |
| "rbKeyDescription" : "..." |
| } ], |
| "implClass" : "...", |
| "displayName" : "...", |
| "name" : "...", |
| "contextEnrichers" : [ { |
| "name" : "...", |
| "itemId" : 12345, |
| "enricherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "enricher" : "..." |
| }, { |
| "name" : "...", |
| "itemId" : 12345, |
| "enricherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "enricher" : "..." |
| } ], |
| "enums" : [ { |
| "name" : "...", |
| "defaultIndex" : 12345, |
| "elements" : [ { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| }, { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| } ], |
| "itemId" : 12345 |
| }, { |
| "name" : "...", |
| "defaultIndex" : 12345, |
| "elements" : [ { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| }, { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| } ], |
| "itemId" : 12345 |
| } ], |
| "rbKeyDescription" : "...", |
| "configs" : [ { |
| "rbKeyDescription" : "...", |
| "subType" : "...", |
| "rbKeyLabel" : "...", |
| "defaultValue" : "...", |
| "rbKeyValidationMessage" : "...", |
| "label" : "...", |
| "name" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "mandatory" : true, |
| "validationRegEx" : "...", |
| "validationMessage" : "...", |
| "type" : "...", |
| "uiHint" : "..." |
| }, { |
| "rbKeyDescription" : "...", |
| "subType" : "...", |
| "rbKeyLabel" : "...", |
| "defaultValue" : "...", |
| "rbKeyValidationMessage" : "...", |
| "label" : "...", |
| "name" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "mandatory" : true, |
| "validationRegEx" : "...", |
| "validationMessage" : "...", |
| "type" : "...", |
| "uiHint" : "..." |
| } ], |
| "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"> |
| { |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskDef" : { |
| "maskTypes" : [ { |
| "itemId" : 12345, |
| "rbKeyDescription" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "description" : "...", |
| "transformer" : "...", |
| "name" : "...", |
| "label" : "..." |
| }, { |
| "itemId" : 12345, |
| "rbKeyDescription" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "description" : "...", |
| "transformer" : "...", |
| "name" : "...", |
| "label" : "..." |
| } ], |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ] |
| }, |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ], |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "rowFilterDef" : { |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ] |
| }, |
| "description" : "...", |
| "policyConditions" : [ { |
| "uiHint" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "name" : "...", |
| "validationRegEx" : "...", |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "evaluatorOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "validationMessage" : "...", |
| "evaluator" : "...", |
| "rbKeyValidationMessage" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "uiHint" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "name" : "...", |
| "validationRegEx" : "...", |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "evaluatorOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "validationMessage" : "...", |
| "evaluator" : "...", |
| "rbKeyValidationMessage" : "...", |
| "rbKeyDescription" : "..." |
| } ], |
| "implClass" : "...", |
| "displayName" : "...", |
| "name" : "...", |
| "contextEnrichers" : [ { |
| "name" : "...", |
| "itemId" : 12345, |
| "enricherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "enricher" : "..." |
| }, { |
| "name" : "...", |
| "itemId" : 12345, |
| "enricherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "enricher" : "..." |
| } ], |
| "enums" : [ { |
| "name" : "...", |
| "defaultIndex" : 12345, |
| "elements" : [ { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| }, { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| } ], |
| "itemId" : 12345 |
| }, { |
| "name" : "...", |
| "defaultIndex" : 12345, |
| "elements" : [ { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| }, { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| } ], |
| "itemId" : 12345 |
| } ], |
| "rbKeyDescription" : "...", |
| "configs" : [ { |
| "rbKeyDescription" : "...", |
| "subType" : "...", |
| "rbKeyLabel" : "...", |
| "defaultValue" : "...", |
| "rbKeyValidationMessage" : "...", |
| "label" : "...", |
| "name" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "mandatory" : true, |
| "validationRegEx" : "...", |
| "validationMessage" : "...", |
| "type" : "...", |
| "uiHint" : "..." |
| }, { |
| "rbKeyDescription" : "...", |
| "subType" : "...", |
| "rbKeyLabel" : "...", |
| "defaultValue" : "...", |
| "rbKeyValidationMessage" : "...", |
| "label" : "...", |
| "name" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "mandatory" : true, |
| "validationRegEx" : "...", |
| "validationMessage" : "...", |
| "type" : "...", |
| "uiHint" : "..." |
| } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_getPolicies_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/policies <a href="../plugins/policies" 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_RangerPolicyList.html">RangerPolicyList</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_rangerPolicyList.html">rangerPolicyList</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 /plugins/policies |
| 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"> |
| { |
| "policies" : [ { |
| "denyExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "allowExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "validitySchedules" : [ { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "dataMaskPolicyItems" : [ { |
| "dataMaskInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "dataMaskInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "rowFilterPolicyItems" : [ { |
| "rowFilterInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "rowFilterInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, { |
| "denyExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "allowExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "validitySchedules" : [ { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "dataMaskPolicyItems" : [ { |
| "dataMaskInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "dataMaskInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "rowFilterPolicyItems" : [ { |
| "rowFilterInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "rowFilterInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "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_ServiceREST_createPolicy_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/plugins/policies <a href="../plugins/policies" 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_RangerPolicy.html">RangerPolicy</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_rangerPolicy.html">rangerPolicy</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_RangerPolicy.html">RangerPolicy</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_rangerPolicy.html">rangerPolicy</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 /plugins/policies |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "denyExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "allowExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "validitySchedules" : [ { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "dataMaskPolicyItems" : [ { |
| "dataMaskInfo" : { |
| "dataMaskType" : "...", |
| "valueExpr" : "...", |
| "conditionExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "dataMaskInfo" : { |
| "dataMaskType" : "...", |
| "valueExpr" : "...", |
| "conditionExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "rowFilterPolicyItems" : [ { |
| "rowFilterInfo" : { |
| "filterExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "rowFilterInfo" : { |
| "filterExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "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"> |
| { |
| "denyExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "allowExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "validitySchedules" : [ { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "dataMaskPolicyItems" : [ { |
| "dataMaskInfo" : { |
| "dataMaskType" : "...", |
| "valueExpr" : "...", |
| "conditionExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "dataMaskInfo" : { |
| "dataMaskType" : "...", |
| "valueExpr" : "...", |
| "conditionExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "rowFilterPolicyItems" : [ { |
| "rowFilterInfo" : { |
| "filterExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "rowFilterInfo" : { |
| "filterExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_getPolicyLabels_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/policyLabels <a href="../plugins/policyLabels" 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">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 /plugins/policyLabels |
| 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_ServiceREST_getServices_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/services <a href="../plugins/services" 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_RangerServiceList.html">RangerServiceList</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_rangerServiceList.html">rangerServiceList</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 /plugins/services |
| 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"> |
| { |
| "services" : [ { |
| "policyUpdateTime" : 12345, |
| "description" : "...", |
| "name" : "...", |
| "type" : "...", |
| "configs" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "tagVersion" : 12345, |
| "tagUpdateTime" : 12345, |
| "displayName" : "...", |
| "policyVersion" : 12345, |
| "tagService" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, { |
| "policyUpdateTime" : 12345, |
| "description" : "...", |
| "name" : "...", |
| "type" : "...", |
| "configs" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "tagVersion" : 12345, |
| "tagUpdateTime" : 12345, |
| "displayName" : "...", |
| "policyVersion" : 12345, |
| "tagService" : "...", |
| "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_ServiceREST_createService_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/plugins/services <a href="../plugins/services" 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_RangerService.html">RangerService</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_rangerService.html">rangerService</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_RangerService.html">RangerService</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_rangerService.html">rangerService</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 /plugins/services |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "policyUpdateTime" : 12345, |
| "description" : "...", |
| "name" : "...", |
| "type" : "...", |
| "configs" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "tagVersion" : 12345, |
| "tagUpdateTime" : 12345, |
| "displayName" : "...", |
| "policyVersion" : 12345, |
| "tagService" : "...", |
| "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"> |
| { |
| "policyUpdateTime" : 12345, |
| "description" : "...", |
| "name" : "...", |
| "type" : "...", |
| "configs" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "tagVersion" : 12345, |
| "tagUpdateTime" : 12345, |
| "displayName" : "...", |
| "policyVersion" : 12345, |
| "tagService" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_deleteClusterServices_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/plugins/cluster-services/{clusterName} <a href="../plugins/cluster-services/{clusterName}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p>Delete services/ repos associated with cluster. |
| Only users with Ranger UserAdmin OR KeyAdmin are allowed to access this API.</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">clusterName</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_ResponseEntityOfList.html">ResponseEntityOfList</a> |
| (JSON)</span></td> |
| <td rowspan="2" class="multi-row-description"><span class="response-description">List of serviceDeleteResponse.</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_responseEntity.html">responseEntity</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> |
| DELETE /plugins/cluster-services/{clusterName} |
| 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 204 No Content |
| Content-Type: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "statusCodeValue" : 12345, |
| "statusCode" : "UNSUPPORTED_MEDIA_TYPE", |
| "headers" : { |
| "property1" : [ "...", "..." ], |
| "property2" : [ "...", "..." ] |
| }, |
| "body" : { } |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_deleteServiceDef_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/plugins/definitions/{id} <a href="../plugins/definitions/{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 /plugins/definitions/{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_ServiceREST_getServiceDef_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/definitions/{id} <a href="../plugins/definitions/{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_RangerServiceDef.html">RangerServiceDef</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_rangerServiceDef.html">rangerServiceDef</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 /plugins/definitions/{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"> |
| { |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskDef" : { |
| "maskTypes" : [ { |
| "itemId" : 12345, |
| "rbKeyDescription" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "description" : "...", |
| "transformer" : "...", |
| "name" : "...", |
| "label" : "..." |
| }, { |
| "itemId" : 12345, |
| "rbKeyDescription" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "description" : "...", |
| "transformer" : "...", |
| "name" : "...", |
| "label" : "..." |
| } ], |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ] |
| }, |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ], |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "rowFilterDef" : { |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ] |
| }, |
| "description" : "...", |
| "policyConditions" : [ { |
| "uiHint" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "name" : "...", |
| "validationRegEx" : "...", |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "evaluatorOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "validationMessage" : "...", |
| "evaluator" : "...", |
| "rbKeyValidationMessage" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "uiHint" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "name" : "...", |
| "validationRegEx" : "...", |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "evaluatorOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "validationMessage" : "...", |
| "evaluator" : "...", |
| "rbKeyValidationMessage" : "...", |
| "rbKeyDescription" : "..." |
| } ], |
| "implClass" : "...", |
| "displayName" : "...", |
| "name" : "...", |
| "contextEnrichers" : [ { |
| "name" : "...", |
| "itemId" : 12345, |
| "enricherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "enricher" : "..." |
| }, { |
| "name" : "...", |
| "itemId" : 12345, |
| "enricherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "enricher" : "..." |
| } ], |
| "enums" : [ { |
| "name" : "...", |
| "defaultIndex" : 12345, |
| "elements" : [ { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| }, { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| } ], |
| "itemId" : 12345 |
| }, { |
| "name" : "...", |
| "defaultIndex" : 12345, |
| "elements" : [ { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| }, { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| } ], |
| "itemId" : 12345 |
| } ], |
| "rbKeyDescription" : "...", |
| "configs" : [ { |
| "rbKeyDescription" : "...", |
| "subType" : "...", |
| "rbKeyLabel" : "...", |
| "defaultValue" : "...", |
| "rbKeyValidationMessage" : "...", |
| "label" : "...", |
| "name" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "mandatory" : true, |
| "validationRegEx" : "...", |
| "validationMessage" : "...", |
| "type" : "...", |
| "uiHint" : "..." |
| }, { |
| "rbKeyDescription" : "...", |
| "subType" : "...", |
| "rbKeyLabel" : "...", |
| "defaultValue" : "...", |
| "rbKeyValidationMessage" : "...", |
| "label" : "...", |
| "name" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "mandatory" : true, |
| "validationRegEx" : "...", |
| "validationMessage" : "...", |
| "type" : "...", |
| "uiHint" : "..." |
| } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_updateServiceDef_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/plugins/definitions/{id} <a href="../plugins/definitions/{id}" 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_RangerServiceDef.html">RangerServiceDef</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_rangerServiceDef.html">rangerServiceDef</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_RangerServiceDef.html">RangerServiceDef</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_rangerServiceDef.html">rangerServiceDef</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 /plugins/definitions/{id} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskDef" : { |
| "maskTypes" : [ { |
| "itemId" : 12345, |
| "rbKeyDescription" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "description" : "...", |
| "transformer" : "...", |
| "name" : "...", |
| "label" : "..." |
| }, { |
| "itemId" : 12345, |
| "rbKeyDescription" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "description" : "...", |
| "transformer" : "...", |
| "name" : "...", |
| "label" : "..." |
| } ], |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ] |
| }, |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ], |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "rowFilterDef" : { |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ] |
| }, |
| "description" : "...", |
| "policyConditions" : [ { |
| "uiHint" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "name" : "...", |
| "validationRegEx" : "...", |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "evaluatorOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "validationMessage" : "...", |
| "evaluator" : "...", |
| "rbKeyValidationMessage" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "uiHint" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "name" : "...", |
| "validationRegEx" : "...", |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "evaluatorOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "validationMessage" : "...", |
| "evaluator" : "...", |
| "rbKeyValidationMessage" : "...", |
| "rbKeyDescription" : "..." |
| } ], |
| "implClass" : "...", |
| "displayName" : "...", |
| "name" : "...", |
| "contextEnrichers" : [ { |
| "name" : "...", |
| "itemId" : 12345, |
| "enricherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "enricher" : "..." |
| }, { |
| "name" : "...", |
| "itemId" : 12345, |
| "enricherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "enricher" : "..." |
| } ], |
| "enums" : [ { |
| "name" : "...", |
| "defaultIndex" : 12345, |
| "elements" : [ { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| }, { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| } ], |
| "itemId" : 12345 |
| }, { |
| "name" : "...", |
| "defaultIndex" : 12345, |
| "elements" : [ { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| }, { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| } ], |
| "itemId" : 12345 |
| } ], |
| "rbKeyDescription" : "...", |
| "configs" : [ { |
| "rbKeyDescription" : "...", |
| "subType" : "...", |
| "rbKeyLabel" : "...", |
| "defaultValue" : "...", |
| "rbKeyValidationMessage" : "...", |
| "label" : "...", |
| "name" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "mandatory" : true, |
| "validationRegEx" : "...", |
| "validationMessage" : "...", |
| "type" : "...", |
| "uiHint" : "..." |
| }, { |
| "rbKeyDescription" : "...", |
| "subType" : "...", |
| "rbKeyLabel" : "...", |
| "defaultValue" : "...", |
| "rbKeyValidationMessage" : "...", |
| "label" : "...", |
| "name" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "mandatory" : true, |
| "validationRegEx" : "...", |
| "validationMessage" : "...", |
| "type" : "...", |
| "uiHint" : "..." |
| } ], |
| "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"> |
| { |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskDef" : { |
| "maskTypes" : [ { |
| "itemId" : 12345, |
| "rbKeyDescription" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "description" : "...", |
| "transformer" : "...", |
| "name" : "...", |
| "label" : "..." |
| }, { |
| "itemId" : 12345, |
| "rbKeyDescription" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "description" : "...", |
| "transformer" : "...", |
| "name" : "...", |
| "label" : "..." |
| } ], |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ] |
| }, |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ], |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "rowFilterDef" : { |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ] |
| }, |
| "description" : "...", |
| "policyConditions" : [ { |
| "uiHint" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "name" : "...", |
| "validationRegEx" : "...", |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "evaluatorOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "validationMessage" : "...", |
| "evaluator" : "...", |
| "rbKeyValidationMessage" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "uiHint" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "name" : "...", |
| "validationRegEx" : "...", |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "evaluatorOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "validationMessage" : "...", |
| "evaluator" : "...", |
| "rbKeyValidationMessage" : "...", |
| "rbKeyDescription" : "..." |
| } ], |
| "implClass" : "...", |
| "displayName" : "...", |
| "name" : "...", |
| "contextEnrichers" : [ { |
| "name" : "...", |
| "itemId" : 12345, |
| "enricherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "enricher" : "..." |
| }, { |
| "name" : "...", |
| "itemId" : 12345, |
| "enricherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "enricher" : "..." |
| } ], |
| "enums" : [ { |
| "name" : "...", |
| "defaultIndex" : 12345, |
| "elements" : [ { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| }, { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| } ], |
| "itemId" : 12345 |
| }, { |
| "name" : "...", |
| "defaultIndex" : 12345, |
| "elements" : [ { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| }, { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| } ], |
| "itemId" : 12345 |
| } ], |
| "rbKeyDescription" : "...", |
| "configs" : [ { |
| "rbKeyDescription" : "...", |
| "subType" : "...", |
| "rbKeyLabel" : "...", |
| "defaultValue" : "...", |
| "rbKeyValidationMessage" : "...", |
| "label" : "...", |
| "name" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "mandatory" : true, |
| "validationRegEx" : "...", |
| "validationMessage" : "...", |
| "type" : "...", |
| "uiHint" : "..." |
| }, { |
| "rbKeyDescription" : "...", |
| "subType" : "...", |
| "rbKeyLabel" : "...", |
| "defaultValue" : "...", |
| "rbKeyValidationMessage" : "...", |
| "label" : "...", |
| "name" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "mandatory" : true, |
| "validationRegEx" : "...", |
| "validationMessage" : "...", |
| "type" : "...", |
| "uiHint" : "..." |
| } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_getPluginsInfo_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/plugins/info <a href="../plugins/plugins/info" 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_RangerPluginInfoList.html">RangerPluginInfoList</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_rangerPluginInfoList.html">rangerPluginInfoList</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 /plugins/plugins/info |
| 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"> |
| { |
| "pluginInfoList" : [ { |
| "info" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceDisplayName" : "...", |
| "id" : 12345, |
| "serviceTypeDisplayName" : "...", |
| "appType" : "...", |
| "hostName" : "...", |
| "updateTime" : 12345, |
| "serviceName" : "...", |
| "ipAddress" : "...", |
| "serviceType" : "...", |
| "createTime" : 12345 |
| }, { |
| "info" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "serviceDisplayName" : "...", |
| "id" : 12345, |
| "serviceTypeDisplayName" : "...", |
| "appType" : "...", |
| "hostName" : "...", |
| "updateTime" : 12345, |
| "serviceName" : "...", |
| "ipAddress" : "...", |
| "serviceType" : "...", |
| "createTime" : 12345 |
| } ], |
| "listSize" : 12345, |
| "list" : [ { }, { } ], |
| "startIndex" : 12345, |
| "pageSize" : 12345, |
| "totalCount" : 12345, |
| "resultSize" : 12345, |
| "sortType" : "...", |
| "sortBy" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_applyPolicy_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/plugins/policies/apply <a href="../plugins/policies/apply" 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_RangerPolicy.html">RangerPolicy</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_rangerPolicy.html">rangerPolicy</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_RangerPolicy.html">RangerPolicy</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_rangerPolicy.html">rangerPolicy</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 /plugins/policies/apply |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "denyExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "allowExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "validitySchedules" : [ { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "dataMaskPolicyItems" : [ { |
| "dataMaskInfo" : { |
| "dataMaskType" : "...", |
| "valueExpr" : "...", |
| "conditionExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "dataMaskInfo" : { |
| "dataMaskType" : "...", |
| "valueExpr" : "...", |
| "conditionExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "rowFilterPolicyItems" : [ { |
| "rowFilterInfo" : { |
| "filterExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "rowFilterInfo" : { |
| "filterExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "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"> |
| { |
| "denyExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "allowExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "validitySchedules" : [ { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "dataMaskPolicyItems" : [ { |
| "dataMaskInfo" : { |
| "dataMaskType" : "...", |
| "valueExpr" : "...", |
| "conditionExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "dataMaskInfo" : { |
| "dataMaskType" : "...", |
| "valueExpr" : "...", |
| "conditionExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "rowFilterPolicyItems" : [ { |
| "rowFilterInfo" : { |
| "filterExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "rowFilterInfo" : { |
| "filterExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_countPolicies_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/policies/count <a href="../plugins/policies/count" 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">number |
| (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">long |
| (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 /plugins/policies/count |
| 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_ServiceREST_getPoliciesInCsv_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/policies/csv <a href="../plugins/policies/csv" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /plugins/policies/csv |
| Content-Type: */* |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_getPoliciesInExcel_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/policies/downloadExcel <a href="../plugins/policies/downloadExcel" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> |
| |
| <p></p> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| GET /plugins/policies/downloadExcel |
| Content-Type: */* |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_getPolicyFromEventTime_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/policies/eventTime <a href="../plugins/policies/eventTime" 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_RangerPolicy.html">RangerPolicy</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_rangerPolicy.html">rangerPolicy</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 /plugins/policies/eventTime |
| 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"> |
| { |
| "denyExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "allowExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "validitySchedules" : [ { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "dataMaskPolicyItems" : [ { |
| "dataMaskInfo" : { |
| "dataMaskType" : "...", |
| "valueExpr" : "...", |
| "conditionExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "dataMaskInfo" : { |
| "dataMaskType" : "...", |
| "valueExpr" : "...", |
| "conditionExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "rowFilterPolicyItems" : [ { |
| "rowFilterInfo" : { |
| "filterExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "rowFilterInfo" : { |
| "filterExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_getPoliciesInJson_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/policies/exportJson <a href="../plugins/policies/exportJson" 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">checkPoliciesExists</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints">boolean</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 /plugins/policies/exportJson |
| Content-Type: */* |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 200 OK |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_importPoliciesFromFile_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/plugins/policies/importPoliciesFromFile <a href="../plugins/policies/importPoliciesFromFile" 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">fileDetail</span></td> |
| <td>formdata</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">serviceMapStream</span></td> |
| <td>formdata</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">uploadedInputStream</span></td> |
| <td>formdata</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">zoneMapStream</span></td> |
| <td>formdata</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">importType</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints"> </span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">isOverride</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints">boolean</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">(custom) |
| </span></td> |
| </tr> |
| <tr> |
| <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: multipart/form-data" HTTP header to specify this media type to the server."><span class="request-type">multipart/form-data</span></abbr></td> |
| <td><span class="datatype-reference">(custom) |
| </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 /plugins/policies/importPoliciesFromFile |
| Content-Type: application/json |
| |
| <code class="prettyprint language-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| <div class="col-md-6"> |
| <h5>Response</h5> |
| <pre> |
| HTTP/1.1 201 Created |
| |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_deletePolicy_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/plugins/policies/{id} <a href="../plugins/policies/{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 /plugins/policies/{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_ServiceREST_getPolicy_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/policies/{id} <a href="../plugins/policies/{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_RangerPolicy.html">RangerPolicy</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_rangerPolicy.html">rangerPolicy</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 /plugins/policies/{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"> |
| { |
| "denyExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "allowExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "validitySchedules" : [ { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "dataMaskPolicyItems" : [ { |
| "dataMaskInfo" : { |
| "dataMaskType" : "...", |
| "valueExpr" : "...", |
| "conditionExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "dataMaskInfo" : { |
| "dataMaskType" : "...", |
| "valueExpr" : "...", |
| "conditionExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "rowFilterPolicyItems" : [ { |
| "rowFilterInfo" : { |
| "filterExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "rowFilterInfo" : { |
| "filterExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_updatePolicy_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/plugins/policies/{id} <a href="../plugins/policies/{id}" 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_RangerPolicy.html">RangerPolicy</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_rangerPolicy.html">rangerPolicy</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_RangerPolicy.html">RangerPolicy</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_rangerPolicy.html">rangerPolicy</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 /plugins/policies/{id} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "denyExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "allowExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "validitySchedules" : [ { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "dataMaskPolicyItems" : [ { |
| "dataMaskInfo" : { |
| "dataMaskType" : "...", |
| "valueExpr" : "...", |
| "conditionExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "dataMaskInfo" : { |
| "dataMaskType" : "...", |
| "valueExpr" : "...", |
| "conditionExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "rowFilterPolicyItems" : [ { |
| "rowFilterInfo" : { |
| "filterExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "rowFilterInfo" : { |
| "filterExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "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"> |
| { |
| "denyExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "allowExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "validitySchedules" : [ { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "dataMaskPolicyItems" : [ { |
| "dataMaskInfo" : { |
| "dataMaskType" : "...", |
| "valueExpr" : "...", |
| "conditionExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "dataMaskInfo" : { |
| "dataMaskType" : "...", |
| "valueExpr" : "...", |
| "conditionExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "rowFilterPolicyItems" : [ { |
| "rowFilterInfo" : { |
| "filterExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "rowFilterInfo" : { |
| "filterExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_deletePolicyDeltas_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/plugins/server/policydeltas <a href="../plugins/server/policydeltas" 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">days</span></td> |
| <td>query</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value">7</span></td> |
| <td><span class="parameter-constraints">int</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 /plugins/server/policydeltas |
| 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_ServiceREST_countServices_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/services/count <a href="../plugins/services/count" 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">number |
| (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">long |
| (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 /plugins/services/count |
| 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_ServiceREST_validateConfig_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/plugins/services/validateConfig <a href="../plugins/services/validateConfig" 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_RangerService.html">RangerService</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_rangerService.html">rangerService</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_VXResponse.html">VXResponse</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_VXResponse.html">VXResponse</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 /plugins/services/validateConfig |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "policyUpdateTime" : 12345, |
| "description" : "...", |
| "name" : "...", |
| "type" : "...", |
| "configs" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "tagVersion" : 12345, |
| "tagUpdateTime" : 12345, |
| "displayName" : "...", |
| "policyVersion" : 12345, |
| "tagService" : "...", |
| "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"> |
| { |
| "statusCode" : 12345, |
| "msgDesc" : "...", |
| "messageList" : [ { |
| "name" : "...", |
| "rbKey" : "...", |
| "message" : "...", |
| "objectId" : 12345, |
| "fieldName" : "...", |
| "myClassType" : 12345 |
| }, { |
| "name" : "...", |
| "rbKey" : "...", |
| "message" : "...", |
| "objectId" : 12345, |
| "fieldName" : "...", |
| "myClassType" : 12345 |
| } ], |
| "myClassType" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_deleteService_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/plugins/services/{id} <a href="../plugins/services/{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 /plugins/services/{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_ServiceREST_getService_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/services/{id} <a href="../plugins/services/{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_RangerService.html">RangerService</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_rangerService.html">rangerService</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 /plugins/services/{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"> |
| { |
| "policyUpdateTime" : 12345, |
| "description" : "...", |
| "name" : "...", |
| "type" : "...", |
| "configs" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "tagVersion" : 12345, |
| "tagUpdateTime" : 12345, |
| "displayName" : "...", |
| "policyVersion" : 12345, |
| "tagService" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_updateService_PUT"> |
| <h3><span class="label label-default resource-method">PUT</span> <span class="resource-path">/plugins/services/{id} <a href="../plugins/services/{id}" 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_RangerService.html">RangerService</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_rangerService.html">rangerService</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_RangerService.html">RangerService</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_rangerService.html">rangerService</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 /plugins/services/{id} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "policyUpdateTime" : 12345, |
| "description" : "...", |
| "name" : "...", |
| "type" : "...", |
| "configs" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "tagVersion" : 12345, |
| "tagUpdateTime" : 12345, |
| "displayName" : "...", |
| "policyVersion" : 12345, |
| "tagService" : "...", |
| "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"> |
| { |
| "policyUpdateTime" : 12345, |
| "description" : "...", |
| "name" : "...", |
| "type" : "...", |
| "configs" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "tagVersion" : 12345, |
| "tagUpdateTime" : 12345, |
| "displayName" : "...", |
| "policyVersion" : 12345, |
| "tagService" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_getServiceDefByName_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/definitions/name/{name} <a href="../plugins/definitions/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_RangerServiceDef.html">RangerServiceDef</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_rangerServiceDef.html">rangerServiceDef</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 /plugins/definitions/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"> |
| { |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskDef" : { |
| "maskTypes" : [ { |
| "itemId" : 12345, |
| "rbKeyDescription" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "description" : "...", |
| "transformer" : "...", |
| "name" : "...", |
| "label" : "..." |
| }, { |
| "itemId" : 12345, |
| "rbKeyDescription" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "description" : "...", |
| "transformer" : "...", |
| "name" : "...", |
| "label" : "..." |
| } ], |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ] |
| }, |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ], |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "rowFilterDef" : { |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ] |
| }, |
| "description" : "...", |
| "policyConditions" : [ { |
| "uiHint" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "name" : "...", |
| "validationRegEx" : "...", |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "evaluatorOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "validationMessage" : "...", |
| "evaluator" : "...", |
| "rbKeyValidationMessage" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "uiHint" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "name" : "...", |
| "validationRegEx" : "...", |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "evaluatorOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "validationMessage" : "...", |
| "evaluator" : "...", |
| "rbKeyValidationMessage" : "...", |
| "rbKeyDescription" : "..." |
| } ], |
| "implClass" : "...", |
| "displayName" : "...", |
| "name" : "...", |
| "contextEnrichers" : [ { |
| "name" : "...", |
| "itemId" : 12345, |
| "enricherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "enricher" : "..." |
| }, { |
| "name" : "...", |
| "itemId" : 12345, |
| "enricherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "enricher" : "..." |
| } ], |
| "enums" : [ { |
| "name" : "...", |
| "defaultIndex" : 12345, |
| "elements" : [ { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| }, { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| } ], |
| "itemId" : 12345 |
| }, { |
| "name" : "...", |
| "defaultIndex" : 12345, |
| "elements" : [ { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| }, { |
| "itemId" : 12345, |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "name" : "..." |
| } ], |
| "itemId" : 12345 |
| } ], |
| "rbKeyDescription" : "...", |
| "configs" : [ { |
| "rbKeyDescription" : "...", |
| "subType" : "...", |
| "rbKeyLabel" : "...", |
| "defaultValue" : "...", |
| "rbKeyValidationMessage" : "...", |
| "label" : "...", |
| "name" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "mandatory" : true, |
| "validationRegEx" : "...", |
| "validationMessage" : "...", |
| "type" : "...", |
| "uiHint" : "..." |
| }, { |
| "rbKeyDescription" : "...", |
| "subType" : "...", |
| "rbKeyLabel" : "...", |
| "defaultValue" : "...", |
| "rbKeyValidationMessage" : "...", |
| "label" : "...", |
| "name" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "mandatory" : true, |
| "validationRegEx" : "...", |
| "validationMessage" : "...", |
| "type" : "...", |
| "uiHint" : "..." |
| } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_getMetricByType_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/metrics/type/{type} <a href="../plugins/metrics/type/{type}" 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">type</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">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">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 /plugins/metrics/type/{type} |
| 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_ServiceREST_getServicePoliciesIfUpdated_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/policies/download/{serviceName} <a href="../plugins/policies/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">lastKnownVersion</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> |
| <tr> |
| <td><span class="parameter-name">supportsPolicyDeltas</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">zoneName</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_ServicePolicies.html">ServicePolicies</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_servicePolicies.html">servicePolicies</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 /plugins/policies/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"> |
| { |
| "serviceDef" : { |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskDef" : { |
| "maskTypes" : [ { }, { } ], |
| "accessTypes" : [ { }, { } ], |
| "resources" : [ { }, { } ] |
| }, |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ], |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "rowFilterDef" : { |
| "accessTypes" : [ { }, { } ], |
| "resources" : [ { }, { } ] |
| }, |
| "description" : "...", |
| "policyConditions" : [ { |
| "uiHint" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "name" : "...", |
| "validationRegEx" : "...", |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "evaluatorOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "validationMessage" : "...", |
| "evaluator" : "...", |
| "rbKeyValidationMessage" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "uiHint" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "name" : "...", |
| "validationRegEx" : "...", |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "evaluatorOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "validationMessage" : "...", |
| "evaluator" : "...", |
| "rbKeyValidationMessage" : "...", |
| "rbKeyDescription" : "..." |
| } ], |
| "implClass" : "...", |
| "displayName" : "...", |
| "name" : "...", |
| "contextEnrichers" : [ { |
| "name" : "...", |
| "itemId" : 12345, |
| "enricherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "enricher" : "..." |
| }, { |
| "name" : "...", |
| "itemId" : 12345, |
| "enricherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "enricher" : "..." |
| } ], |
| "enums" : [ { |
| "name" : "...", |
| "defaultIndex" : 12345, |
| "elements" : [ { }, { } ], |
| "itemId" : 12345 |
| }, { |
| "name" : "...", |
| "defaultIndex" : 12345, |
| "elements" : [ { }, { } ], |
| "itemId" : 12345 |
| } ], |
| "rbKeyDescription" : "...", |
| "configs" : [ { |
| "rbKeyDescription" : "...", |
| "subType" : "...", |
| "rbKeyLabel" : "...", |
| "defaultValue" : "...", |
| "rbKeyValidationMessage" : "...", |
| "label" : "...", |
| "name" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "mandatory" : true, |
| "validationRegEx" : "...", |
| "validationMessage" : "...", |
| "type" : "...", |
| "uiHint" : "..." |
| }, { |
| "rbKeyDescription" : "...", |
| "subType" : "...", |
| "rbKeyLabel" : "...", |
| "defaultValue" : "...", |
| "rbKeyValidationMessage" : "...", |
| "label" : "...", |
| "name" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "mandatory" : true, |
| "validationRegEx" : "...", |
| "validationMessage" : "...", |
| "type" : "...", |
| "uiHint" : "..." |
| } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, |
| "policyUpdateTime" : 12345, |
| "serviceId" : 12345, |
| "policyDeltas" : [ { |
| "policy" : { |
| "denyExceptions" : [ { }, { } ], |
| "allowExceptions" : [ { }, { } ], |
| "validitySchedules" : [ { }, { } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { }, { } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "dataMaskPolicyItems" : [ { }, { } ], |
| "rowFilterPolicyItems" : [ { }, { } ], |
| "policyItems" : [ { }, { } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { }, { } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, |
| "changeType" : 12345, |
| "policiesVersion" : 12345, |
| "id" : 12345 |
| }, { |
| "policy" : { |
| "denyExceptions" : [ { }, { } ], |
| "allowExceptions" : [ { }, { } ], |
| "validitySchedules" : [ { }, { } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { }, { } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "dataMaskPolicyItems" : [ { }, { } ], |
| "rowFilterPolicyItems" : [ { }, { } ], |
| "policyItems" : [ { }, { } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { }, { } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, |
| "changeType" : 12345, |
| "policiesVersion" : 12345, |
| "id" : 12345 |
| } ], |
| "auditMode" : "...", |
| "policyVersion" : 12345, |
| "tagPolicies" : { |
| "policyUpdateTime" : 12345, |
| "serviceConfig" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "policyVersion" : 12345, |
| "auditMode" : "...", |
| "serviceId" : 12345, |
| "serviceName" : "...", |
| "serviceDef" : { |
| "accessTypes" : [ { }, { } ], |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskDef" : { }, |
| "resources" : [ { }, { } ], |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "rowFilterDef" : { }, |
| "description" : "...", |
| "policyConditions" : [ { }, { } ], |
| "implClass" : "...", |
| "displayName" : "...", |
| "name" : "...", |
| "contextEnrichers" : [ { }, { } ], |
| "enums" : [ { }, { } ], |
| "rbKeyDescription" : "...", |
| "configs" : [ { }, { } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, |
| "policies" : [ { |
| "denyExceptions" : [ { }, { } ], |
| "allowExceptions" : [ { }, { } ], |
| "validitySchedules" : [ { }, { } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { }, { } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "dataMaskPolicyItems" : [ { }, { } ], |
| "rowFilterPolicyItems" : [ { }, { } ], |
| "policyItems" : [ { }, { } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { }, { } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, { |
| "denyExceptions" : [ { }, { } ], |
| "allowExceptions" : [ { }, { } ], |
| "validitySchedules" : [ { }, { } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { }, { } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "dataMaskPolicyItems" : [ { }, { } ], |
| "rowFilterPolicyItems" : [ { }, { } ], |
| "policyItems" : [ { }, { } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { }, { } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } ] |
| }, |
| "serviceConfig" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "policies" : [ { |
| "denyExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "allowExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "validitySchedules" : [ { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "dataMaskPolicyItems" : [ { |
| "dataMaskInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "dataMaskInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "rowFilterPolicyItems" : [ { |
| "rowFilterInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "rowFilterInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, { |
| "denyExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "allowExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "validitySchedules" : [ { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "dataMaskPolicyItems" : [ { |
| "dataMaskInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "dataMaskInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "rowFilterPolicyItems" : [ { |
| "rowFilterInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "rowFilterInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } ], |
| "securityZones" : { |
| "property1" : { |
| "containsAssociatedTagService" : true, |
| "policies" : [ { |
| "denyExceptions" : [ { }, { } ], |
| "allowExceptions" : [ { }, { } ], |
| "validitySchedules" : [ { }, { } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { }, { } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "dataMaskPolicyItems" : [ { }, { } ], |
| "rowFilterPolicyItems" : [ { }, { } ], |
| "policyItems" : [ { }, { } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { }, { } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, { |
| "denyExceptions" : [ { }, { } ], |
| "allowExceptions" : [ { }, { } ], |
| "validitySchedules" : [ { }, { } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { }, { } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "dataMaskPolicyItems" : [ { }, { } ], |
| "rowFilterPolicyItems" : [ { }, { } ], |
| "policyItems" : [ { }, { } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { }, { } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } ], |
| "resources" : [ { |
| "property1" : [ ], |
| "property2" : [ ] |
| }, { |
| "property1" : [ ], |
| "property2" : [ ] |
| } ], |
| "policyDeltas" : [ { |
| "policy" : { }, |
| "changeType" : 12345, |
| "policiesVersion" : 12345, |
| "id" : 12345 |
| }, { |
| "policy" : { }, |
| "changeType" : 12345, |
| "policiesVersion" : 12345, |
| "id" : 12345 |
| } ], |
| "zoneName" : "..." |
| }, |
| "property2" : { |
| "containsAssociatedTagService" : true, |
| "policies" : [ { |
| "denyExceptions" : [ { }, { } ], |
| "allowExceptions" : [ { }, { } ], |
| "validitySchedules" : [ { }, { } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { }, { } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "dataMaskPolicyItems" : [ { }, { } ], |
| "rowFilterPolicyItems" : [ { }, { } ], |
| "policyItems" : [ { }, { } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { }, { } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, { |
| "denyExceptions" : [ { }, { } ], |
| "allowExceptions" : [ { }, { } ], |
| "validitySchedules" : [ { }, { } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { }, { } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "dataMaskPolicyItems" : [ { }, { } ], |
| "rowFilterPolicyItems" : [ { }, { } ], |
| "policyItems" : [ { }, { } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { }, { } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } ], |
| "resources" : [ { |
| "property1" : [ ], |
| "property2" : [ ] |
| }, { |
| "property1" : [ ], |
| "property2" : [ ] |
| } ], |
| "policyDeltas" : [ { |
| "policy" : { }, |
| "changeType" : 12345, |
| "policiesVersion" : 12345, |
| "id" : 12345 |
| }, { |
| "policy" : { }, |
| "changeType" : 12345, |
| "policiesVersion" : 12345, |
| "id" : 12345 |
| } ], |
| "zoneName" : "..." |
| } |
| }, |
| "serviceName" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_getServicePolicies_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/policies/service/{id} <a href="../plugins/policies/service/{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_RangerPolicyList.html">RangerPolicyList</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_rangerPolicyList.html">rangerPolicyList</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 /plugins/policies/service/{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"> |
| { |
| "policies" : [ { |
| "denyExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "allowExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "validitySchedules" : [ { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "dataMaskPolicyItems" : [ { |
| "dataMaskInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "dataMaskInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "rowFilterPolicyItems" : [ { |
| "rowFilterInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "rowFilterInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, { |
| "denyExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "allowExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "validitySchedules" : [ { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "dataMaskPolicyItems" : [ { |
| "dataMaskInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "dataMaskInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "rowFilterPolicyItems" : [ { |
| "rowFilterInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "rowFilterInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "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_ServiceREST_getPoliciesForResource_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/policies/{serviceDefName}/for-resource <a href="../plugins/policies/{serviceDefName}/for-resource" 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> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parameter-name">serviceDefName</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-default-value"> </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> |
| </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 <a href="json_RangerPolicy.html">RangerPolicy</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">list of <a href="xml_ns0_rangerPolicy.html">rangerPolicy</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 /plugins/policies/{serviceDefName}/for-resource |
| 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"> |
| [ { |
| "denyExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "allowExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "validitySchedules" : [ { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "dataMaskPolicyItems" : [ { |
| "dataMaskInfo" : { |
| "dataMaskType" : "...", |
| "valueExpr" : "...", |
| "conditionExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "dataMaskInfo" : { |
| "dataMaskType" : "...", |
| "valueExpr" : "...", |
| "conditionExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "rowFilterPolicyItems" : [ { |
| "rowFilterInfo" : { |
| "filterExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "rowFilterInfo" : { |
| "filterExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } ] |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_getPolicyVersionList_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/policy/{policyId}/versionList <a href="../plugins/policy/{policyId}/versionList" 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">policyId</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_VXString.html">VXString</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_VXString.html">VXString</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 /plugins/policy/{policyId}/versionList |
| 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"> |
| { |
| "value" : "...", |
| "myClassType" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_purgeEmptyPolicies_DELETE"> |
| <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/plugins/server/purgepolicies/{serviceName} <a href="../plugins/server/purgepolicies/{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> |
| <h4>Example</h4> |
| |
| <div class="container-fluid example panel"> |
| <div class="row panel-body"> |
| <div class="col-md-6"> |
| <h5>Request</h5> |
| <pre> |
| DELETE /plugins/server/purgepolicies/{serviceName} |
| 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_ServiceREST_grantAccess_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/plugins/services/grant/{serviceName} <a href="../plugins/services/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_GrantRevokeRequest.html">GrantRevokeRequest</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_grantRevokeRequest.html">grantRevokeRequest</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> |
| POST /plugins/services/grant/{serviceName} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "roles" : [ "...", "..." ], |
| "delegateAdmin" : true, |
| "ownerUser" : "...", |
| "zoneName" : "...", |
| "replaceExistingPermissions" : true, |
| "sessionId" : "...", |
| "users" : [ "...", "..." ], |
| "clientIPAddress" : "...", |
| "grantorGroups" : [ "...", "..." ], |
| "enableAudit" : true, |
| "isRecursive" : true, |
| "remoteIPAddress" : "...", |
| "clusterName" : "...", |
| "accessTypes" : [ "...", "..." ], |
| "resource" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "grantor" : "...", |
| "requestData" : "...", |
| "clientType" : "...", |
| "forwardedAddresses" : [ "...", "..." ], |
| "groups" : [ "...", "..." ] |
| } |
| </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"> |
| { |
| "message" : "...", |
| "msgDesc" : "...", |
| "httpStatusCode" : 12345, |
| "messageList" : [ { |
| "fieldName" : "...", |
| "objectId" : 12345, |
| "rbKey" : "...", |
| "message" : "...", |
| "name" : "..." |
| }, { |
| "fieldName" : "...", |
| "objectId" : 12345, |
| "rbKey" : "...", |
| "message" : "...", |
| "name" : "..." |
| } ], |
| "statusCode" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_lookupResource_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/plugins/services/lookupResource/{serviceName} <a href="../plugins/services/lookupResource/{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_ResourceLookupContext.html">ResourceLookupContext</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_resourceLookupContext.html">resourceLookupContext</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">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> |
| POST /plugins/services/lookupResource/{serviceName} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "userInput" : "...", |
| "resources" : { |
| "property1" : [ "...", "..." ], |
| "property2" : [ "...", "..." ] |
| }, |
| "resourceName" : "..." |
| } |
| </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-txt"> |
| ... |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_getServiceByName_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/services/name/{name} <a href="../plugins/services/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_RangerService.html">RangerService</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_rangerService.html">rangerService</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 /plugins/services/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"> |
| { |
| "policyUpdateTime" : 12345, |
| "description" : "...", |
| "name" : "...", |
| "type" : "...", |
| "configs" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "tagVersion" : 12345, |
| "tagUpdateTime" : 12345, |
| "displayName" : "...", |
| "policyVersion" : 12345, |
| "tagService" : "...", |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_revokeAccess_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/plugins/services/revoke/{serviceName} <a href="../plugins/services/revoke/{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_GrantRevokeRequest.html">GrantRevokeRequest</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_grantRevokeRequest.html">grantRevokeRequest</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> |
| POST /plugins/services/revoke/{serviceName} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "roles" : [ "...", "..." ], |
| "delegateAdmin" : true, |
| "ownerUser" : "...", |
| "zoneName" : "...", |
| "replaceExistingPermissions" : true, |
| "sessionId" : "...", |
| "users" : [ "...", "..." ], |
| "clientIPAddress" : "...", |
| "grantorGroups" : [ "...", "..." ], |
| "enableAudit" : true, |
| "isRecursive" : true, |
| "remoteIPAddress" : "...", |
| "clusterName" : "...", |
| "accessTypes" : [ "...", "..." ], |
| "resource" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "grantor" : "...", |
| "requestData" : "...", |
| "clientType" : "...", |
| "forwardedAddresses" : [ "...", "..." ], |
| "groups" : [ "...", "..." ] |
| } |
| </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"> |
| { |
| "message" : "...", |
| "msgDesc" : "...", |
| "httpStatusCode" : 12345, |
| "messageList" : [ { |
| "fieldName" : "...", |
| "objectId" : 12345, |
| "rbKey" : "...", |
| "message" : "...", |
| "name" : "..." |
| }, { |
| "fieldName" : "...", |
| "objectId" : 12345, |
| "rbKey" : "...", |
| "message" : "...", |
| "name" : "..." |
| } ], |
| "statusCode" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_getServicePoliciesByName_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/policies/service/name/{name} <a href="../plugins/policies/service/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_RangerPolicyList.html">RangerPolicyList</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_rangerPolicyList.html">rangerPolicyList</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 /plugins/policies/service/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"> |
| { |
| "policies" : [ { |
| "denyExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "allowExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "validitySchedules" : [ { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "dataMaskPolicyItems" : [ { |
| "dataMaskInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "dataMaskInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "rowFilterPolicyItems" : [ { |
| "rowFilterInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "rowFilterInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, { |
| "denyExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "allowExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "validitySchedules" : [ { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "dataMaskPolicyItems" : [ { |
| "dataMaskInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "dataMaskInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "rowFilterPolicyItems" : [ { |
| "rowFilterInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "rowFilterInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "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_ServiceREST_getPolicyForVersionNumber_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/policy/{policyId}/version/{versionNo} <a href="../plugins/policy/{policyId}/version/{versionNo}" 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">policyId</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints">long</span></td> |
| </tr> |
| <tr> |
| <td><span class="parameter-name">versionNo</span></td> |
| <td>path</td> |
| <td><span class="parameter-description"></span></td> |
| <td><span class="parameter-constraints">int</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_RangerPolicy.html">RangerPolicy</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_rangerPolicy.html">rangerPolicy</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 /plugins/policy/{policyId}/version/{versionNo} |
| 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"> |
| { |
| "denyExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "allowExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "validitySchedules" : [ { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { |
| "interval" : { }, |
| "schedule" : { } |
| }, { |
| "interval" : { }, |
| "schedule" : { } |
| } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "dataMaskPolicyItems" : [ { |
| "dataMaskInfo" : { |
| "dataMaskType" : "...", |
| "valueExpr" : "...", |
| "conditionExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "dataMaskInfo" : { |
| "dataMaskType" : "...", |
| "valueExpr" : "...", |
| "conditionExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "rowFilterPolicyItems" : [ { |
| "rowFilterInfo" : { |
| "filterExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "rowFilterInfo" : { |
| "filterExpr" : "..." |
| }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { |
| "type" : "...", |
| "isAllowed" : true |
| }, { |
| "type" : "...", |
| "isAllowed" : true |
| } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_getSecureServicePoliciesIfUpdated_GET"> |
| <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/plugins/secure/policies/download/{serviceName} <a href="../plugins/secure/policies/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">lastKnownVersion</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> |
| <tr> |
| <td><span class="parameter-name">supportsPolicyDeltas</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">zoneName</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_ServicePolicies.html">ServicePolicies</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_servicePolicies.html">servicePolicies</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 /plugins/secure/policies/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"> |
| { |
| "serviceDef" : { |
| "accessTypes" : [ { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| }, { |
| "impliedGrants" : [ "...", "..." ], |
| "name" : "...", |
| "label" : "...", |
| "itemId" : 12345, |
| "rbKeyLabel" : "..." |
| } ], |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskDef" : { |
| "maskTypes" : [ { }, { } ], |
| "accessTypes" : [ { }, { } ], |
| "resources" : [ { }, { } ] |
| }, |
| "resources" : [ { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "recursiveSupported" : true, |
| "label" : "...", |
| "excludesSupported" : true, |
| "parent" : "...", |
| "matcher" : "...", |
| "type" : "...", |
| "accessTypeRestrictions" : [ "...", "..." ], |
| "lookupSupported" : true, |
| "isValidLeaf" : true, |
| "matcherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "name" : "...", |
| "rbKeyLabel" : "...", |
| "mandatory" : true, |
| "validationMessage" : "...", |
| "level" : 12345, |
| "itemId" : 12345, |
| "uiHint" : "...", |
| "rbKeyValidationMessage" : "...", |
| "description" : "...", |
| "validationRegEx" : "...", |
| "rbKeyDescription" : "..." |
| } ], |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "rowFilterDef" : { |
| "accessTypes" : [ { }, { } ], |
| "resources" : [ { }, { } ] |
| }, |
| "description" : "...", |
| "policyConditions" : [ { |
| "uiHint" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "name" : "...", |
| "validationRegEx" : "...", |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "evaluatorOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "validationMessage" : "...", |
| "evaluator" : "...", |
| "rbKeyValidationMessage" : "...", |
| "rbKeyDescription" : "..." |
| }, { |
| "uiHint" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "name" : "...", |
| "validationRegEx" : "...", |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "evaluatorOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "validationMessage" : "...", |
| "evaluator" : "...", |
| "rbKeyValidationMessage" : "...", |
| "rbKeyDescription" : "..." |
| } ], |
| "implClass" : "...", |
| "displayName" : "...", |
| "name" : "...", |
| "contextEnrichers" : [ { |
| "name" : "...", |
| "itemId" : 12345, |
| "enricherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "enricher" : "..." |
| }, { |
| "name" : "...", |
| "itemId" : 12345, |
| "enricherOptions" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "enricher" : "..." |
| } ], |
| "enums" : [ { |
| "name" : "...", |
| "defaultIndex" : 12345, |
| "elements" : [ { }, { } ], |
| "itemId" : 12345 |
| }, { |
| "name" : "...", |
| "defaultIndex" : 12345, |
| "elements" : [ { }, { } ], |
| "itemId" : 12345 |
| } ], |
| "rbKeyDescription" : "...", |
| "configs" : [ { |
| "rbKeyDescription" : "...", |
| "subType" : "...", |
| "rbKeyLabel" : "...", |
| "defaultValue" : "...", |
| "rbKeyValidationMessage" : "...", |
| "label" : "...", |
| "name" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "mandatory" : true, |
| "validationRegEx" : "...", |
| "validationMessage" : "...", |
| "type" : "...", |
| "uiHint" : "..." |
| }, { |
| "rbKeyDescription" : "...", |
| "subType" : "...", |
| "rbKeyLabel" : "...", |
| "defaultValue" : "...", |
| "rbKeyValidationMessage" : "...", |
| "label" : "...", |
| "name" : "...", |
| "description" : "...", |
| "itemId" : 12345, |
| "mandatory" : true, |
| "validationRegEx" : "...", |
| "validationMessage" : "...", |
| "type" : "...", |
| "uiHint" : "..." |
| } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, |
| "policyUpdateTime" : 12345, |
| "serviceId" : 12345, |
| "policyDeltas" : [ { |
| "policy" : { |
| "denyExceptions" : [ { }, { } ], |
| "allowExceptions" : [ { }, { } ], |
| "validitySchedules" : [ { }, { } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { }, { } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "dataMaskPolicyItems" : [ { }, { } ], |
| "rowFilterPolicyItems" : [ { }, { } ], |
| "policyItems" : [ { }, { } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { }, { } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, |
| "changeType" : 12345, |
| "policiesVersion" : 12345, |
| "id" : 12345 |
| }, { |
| "policy" : { |
| "denyExceptions" : [ { }, { } ], |
| "allowExceptions" : [ { }, { } ], |
| "validitySchedules" : [ { }, { } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { }, { } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "dataMaskPolicyItems" : [ { }, { } ], |
| "rowFilterPolicyItems" : [ { }, { } ], |
| "policyItems" : [ { }, { } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { }, { } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, |
| "changeType" : 12345, |
| "policiesVersion" : 12345, |
| "id" : 12345 |
| } ], |
| "auditMode" : "...", |
| "policyVersion" : 12345, |
| "tagPolicies" : { |
| "policyUpdateTime" : 12345, |
| "serviceConfig" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "policyVersion" : 12345, |
| "auditMode" : "...", |
| "serviceId" : 12345, |
| "serviceName" : "...", |
| "serviceDef" : { |
| "accessTypes" : [ { }, { } ], |
| "label" : "...", |
| "rbKeyLabel" : "...", |
| "dataMaskDef" : { }, |
| "resources" : [ { }, { } ], |
| "options" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "rowFilterDef" : { }, |
| "description" : "...", |
| "policyConditions" : [ { }, { } ], |
| "implClass" : "...", |
| "displayName" : "...", |
| "name" : "...", |
| "contextEnrichers" : [ { }, { } ], |
| "enums" : [ { }, { } ], |
| "rbKeyDescription" : "...", |
| "configs" : [ { }, { } ], |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, |
| "policies" : [ { |
| "denyExceptions" : [ { }, { } ], |
| "allowExceptions" : [ { }, { } ], |
| "validitySchedules" : [ { }, { } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { }, { } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "dataMaskPolicyItems" : [ { }, { } ], |
| "rowFilterPolicyItems" : [ { }, { } ], |
| "policyItems" : [ { }, { } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { }, { } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, { |
| "denyExceptions" : [ { }, { } ], |
| "allowExceptions" : [ { }, { } ], |
| "validitySchedules" : [ { }, { } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { }, { } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "dataMaskPolicyItems" : [ { }, { } ], |
| "rowFilterPolicyItems" : [ { }, { } ], |
| "policyItems" : [ { }, { } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { }, { } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } ] |
| }, |
| "serviceConfig" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "policies" : [ { |
| "denyExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "allowExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "validitySchedules" : [ { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "dataMaskPolicyItems" : [ { |
| "dataMaskInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "dataMaskInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "rowFilterPolicyItems" : [ { |
| "rowFilterInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "rowFilterInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, { |
| "denyExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "allowExceptions" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "validitySchedules" : [ { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| }, { |
| "recurrences" : [ { }, { } ], |
| "startTime" : "...", |
| "timeZone" : "...", |
| "endTime" : "..." |
| } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| }, |
| "property2" : { |
| "values" : [ "...", "..." ], |
| "isRecursive" : true, |
| "isExcludes" : true |
| } |
| }, |
| "dataMaskPolicyItems" : [ { |
| "dataMaskInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "dataMaskInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "rowFilterPolicyItems" : [ { |
| "rowFilterInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "rowFilterInfo" : { }, |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyItems" : [ { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| }, { |
| "groups" : [ "...", "..." ], |
| "accesses" : [ { }, { } ], |
| "delegateAdmin" : true, |
| "users" : [ "...", "..." ], |
| "conditions" : [ { }, { } ], |
| "roles" : [ "...", "..." ] |
| } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| }, { |
| "values" : [ "...", "..." ], |
| "type" : "..." |
| } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } ], |
| "securityZones" : { |
| "property1" : { |
| "containsAssociatedTagService" : true, |
| "policies" : [ { |
| "denyExceptions" : [ { }, { } ], |
| "allowExceptions" : [ { }, { } ], |
| "validitySchedules" : [ { }, { } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { }, { } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "dataMaskPolicyItems" : [ { }, { } ], |
| "rowFilterPolicyItems" : [ { }, { } ], |
| "policyItems" : [ { }, { } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { }, { } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, { |
| "denyExceptions" : [ { }, { } ], |
| "allowExceptions" : [ { }, { } ], |
| "validitySchedules" : [ { }, { } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { }, { } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "dataMaskPolicyItems" : [ { }, { } ], |
| "rowFilterPolicyItems" : [ { }, { } ], |
| "policyItems" : [ { }, { } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { }, { } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } ], |
| "resources" : [ { |
| "property1" : [ ], |
| "property2" : [ ] |
| }, { |
| "property1" : [ ], |
| "property2" : [ ] |
| } ], |
| "policyDeltas" : [ { |
| "policy" : { }, |
| "changeType" : 12345, |
| "policiesVersion" : 12345, |
| "id" : 12345 |
| }, { |
| "policy" : { }, |
| "changeType" : 12345, |
| "policiesVersion" : 12345, |
| "id" : 12345 |
| } ], |
| "zoneName" : "..." |
| }, |
| "property2" : { |
| "containsAssociatedTagService" : true, |
| "policies" : [ { |
| "denyExceptions" : [ { }, { } ], |
| "allowExceptions" : [ { }, { } ], |
| "validitySchedules" : [ { }, { } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { }, { } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "dataMaskPolicyItems" : [ { }, { } ], |
| "rowFilterPolicyItems" : [ { }, { } ], |
| "policyItems" : [ { }, { } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { }, { } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| }, { |
| "denyExceptions" : [ { }, { } ], |
| "allowExceptions" : [ { }, { } ], |
| "validitySchedules" : [ { }, { } ], |
| "policyPriority" : 12345, |
| "policyType" : 12345, |
| "isAuditEnabled" : true, |
| "zoneName" : "...", |
| "denyPolicyItems" : [ { }, { } ], |
| "service" : "...", |
| "resources" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "dataMaskPolicyItems" : [ { }, { } ], |
| "rowFilterPolicyItems" : [ { }, { } ], |
| "policyItems" : [ { }, { } ], |
| "policyLabels" : [ "...", "..." ], |
| "resourceSignature" : "...", |
| "isDenyAllElse" : true, |
| "name" : "...", |
| "serviceType" : "...", |
| "description" : "...", |
| "conditions" : [ { }, { } ], |
| "options" : { |
| "property1" : { }, |
| "property2" : { } |
| }, |
| "createTime" : 12345, |
| "id" : 12345, |
| "updatedBy" : "...", |
| "version" : 12345, |
| "createdBy" : "...", |
| "guid" : "...", |
| "updateTime" : 12345, |
| "isEnabled" : true |
| } ], |
| "resources" : [ { |
| "property1" : [ ], |
| "property2" : [ ] |
| }, { |
| "property1" : [ ], |
| "property2" : [ ] |
| } ], |
| "policyDeltas" : [ { |
| "policy" : { }, |
| "changeType" : 12345, |
| "policiesVersion" : 12345, |
| "id" : 12345 |
| }, { |
| "policy" : { }, |
| "changeType" : 12345, |
| "policiesVersion" : 12345, |
| "id" : 12345 |
| } ], |
| "zoneName" : "..." |
| } |
| }, |
| "serviceName" : "..." |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_secureGrantAccess_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/plugins/secure/services/grant/{serviceName} <a href="../plugins/secure/services/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_GrantRevokeRequest.html">GrantRevokeRequest</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_grantRevokeRequest.html">grantRevokeRequest</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> |
| POST /plugins/secure/services/grant/{serviceName} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "roles" : [ "...", "..." ], |
| "delegateAdmin" : true, |
| "ownerUser" : "...", |
| "zoneName" : "...", |
| "replaceExistingPermissions" : true, |
| "sessionId" : "...", |
| "users" : [ "...", "..." ], |
| "clientIPAddress" : "...", |
| "grantorGroups" : [ "...", "..." ], |
| "enableAudit" : true, |
| "isRecursive" : true, |
| "remoteIPAddress" : "...", |
| "clusterName" : "...", |
| "accessTypes" : [ "...", "..." ], |
| "resource" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "grantor" : "...", |
| "requestData" : "...", |
| "clientType" : "...", |
| "forwardedAddresses" : [ "...", "..." ], |
| "groups" : [ "...", "..." ] |
| } |
| </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"> |
| { |
| "message" : "...", |
| "msgDesc" : "...", |
| "httpStatusCode" : 12345, |
| "messageList" : [ { |
| "fieldName" : "...", |
| "objectId" : 12345, |
| "rbKey" : "...", |
| "message" : "...", |
| "name" : "..." |
| }, { |
| "fieldName" : "...", |
| "objectId" : 12345, |
| "rbKey" : "...", |
| "message" : "...", |
| "name" : "..." |
| } ], |
| "statusCode" : 12345 |
| } |
| </code> |
| </pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div id="resource_ServiceREST_secureRevokeAccess_POST"> |
| <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/plugins/secure/services/revoke/{serviceName} <a href="../plugins/secure/services/revoke/{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_GrantRevokeRequest.html">GrantRevokeRequest</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_grantRevokeRequest.html">grantRevokeRequest</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> |
| POST /plugins/secure/services/revoke/{serviceName} |
| Content-Type: application/json |
| Accept: application/json |
| |
| <code class="prettyprint language-js"> |
| { |
| "roles" : [ "...", "..." ], |
| "delegateAdmin" : true, |
| "ownerUser" : "...", |
| "zoneName" : "...", |
| "replaceExistingPermissions" : true, |
| "sessionId" : "...", |
| "users" : [ "...", "..." ], |
| "clientIPAddress" : "...", |
| "grantorGroups" : [ "...", "..." ], |
| "enableAudit" : true, |
| "isRecursive" : true, |
| "remoteIPAddress" : "...", |
| "clusterName" : "...", |
| "accessTypes" : [ "...", "..." ], |
| "resource" : { |
| "property1" : "...", |
| "property2" : "..." |
| }, |
| "grantor" : "...", |
| "requestData" : "...", |
| "clientType" : "...", |
| "forwardedAddresses" : [ "...", "..." ], |
| "groups" : [ "...", "..." ] |
| } |
| </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"> |
| { |
| "message" : "...", |
| "msgDesc" : "...", |
| "httpStatusCode" : 12345, |
| "messageList" : [ { |
| "fieldName" : "...", |
| "objectId" : 12345, |
| "rbKey" : "...", |
| "message" : "...", |
| "name" : "..." |
| }, { |
| "fieldName" : "...", |
| "objectId" : 12345, |
| "rbKey" : "...", |
| "message" : "...", |
| "name" : "..." |
| } ], |
| "statusCode" : 12345 |
| } |
| </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> |
| |
| |
| <!-- JavaScript placed at the end of the document so the pages load faster. --> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script> |
| |
| <!-- Bootstrap core JavaScript |
| ================================================== --> |
| <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script> |
| |
| <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> |
| <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> |
