apidocs/xml_ns0_servicePolicies.html (544 lines of code) (raw):

<!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: servicePolicies</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: servicePolicies</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 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="syntax_xml.html">XML</a></li> <li class="dropdown"><a href="xml_ns0_servicePolicies.html">servicePolicies</a></li> </ol> <h1 class="page-header">servicePolicies <small>Data Type</small></h1> <p></p> <dl class="dl-horizontal"> <dt>Namespace</dt> <dd>(Default)</dd> <dt>Schema</dt> <dd><a href="ns0.xsd">ns0.xsd</a></dd> </dl> <table class="table datatype-properties"> <caption>Properties</caption> <thead> <tr> <th>name</th> <th>data type</th> <th>type</th> <th>namespace</th> <th>min/max occurs</th> <th>description</th> </tr> </thead> <tbody> <tr> <td> <span id="prop-auditMode" class="property-name">auditMode</span> </td> <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">&nbsp;</span> </td> </tr> <tr> <td> <span id="prop-policies" class="property-name">policies</span> </td> <td> <span class="datatype-reference">list of <a href="xml_ns0_rangerPolicy.html">rangerPolicy</a> </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/unbounded </span> </td> <td> <span class="property-description">&nbsp;</span> </td> </tr> <tr> <td> <span id="prop-policyDeltas" class="property-name">policyDeltas</span> </td> <td> <span class="datatype-reference">list of <a href="xml_ns0_rangerPolicyDelta.html">rangerPolicyDelta</a> </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/unbounded </span> </td> <td> <span class="property-description">&nbsp;</span> </td> </tr> <tr> <td> <span id="prop-policyUpdateTime" class="property-name">policyUpdateTime</span> </td> <td> <span class="datatype-reference">dateTime </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">&nbsp;</span> </td> </tr> <tr> <td> <span id="prop-policyVersion" class="property-name">policyVersion</span> </td> <td> <span class="datatype-reference">long </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">&nbsp;</span> </td> </tr> <tr> <td> <span id="prop-securityZones" class="property-name">securityZones</span> </td> <td> <span class="datatype-reference">(custom) </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">&nbsp;</span> </td> </tr> <tr> <td> <span id="prop-serviceConfig" class="property-name">serviceConfig</span> </td> <td> <span class="datatype-reference">(custom) </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">&nbsp;</span> </td> </tr> <tr> <td> <span id="prop-serviceDef" class="property-name">serviceDef</span> </td> <td> <span class="datatype-reference"><a href="xml_ns0_rangerServiceDef.html">rangerServiceDef</a> </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">&nbsp;</span> </td> </tr> <tr> <td> <span id="prop-serviceId" class="property-name">serviceId</span> </td> <td> <span class="datatype-reference">long </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">&nbsp;</span> </td> </tr> <tr> <td> <span id="prop-serviceName" class="property-name">serviceName</span> </td> <td> <span class="datatype-reference">string </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">&nbsp;</span> </td> </tr> <tr> <td> <span id="prop-tagPolicies" class="property-name">tagPolicies</span> </td> <td> <span class="datatype-reference"><a href="xml_ns0_tagPolicies.html">tagPolicies</a> </span> </td> <td> <span class="property-type">element </span> </td> <td> <span class="property-namespaceInfo"> </span> </td> <td> <span class="property-minMaxOccurs">0/1 </span> </td> <td> <span class="property-description">&nbsp;</span> </td> </tr> </tbody> </table> <p class="lead">Example</p> <pre class="prettyprint language-xml example">&lt;servicePolicies&gt; &lt;policies&gt; &lt;denyExceptions&gt; &lt;groups&gt;...&lt;/groups&gt; &lt;users&gt;...&lt;/users&gt; &lt;delegateAdmin&gt;...&lt;/delegateAdmin&gt; &lt;accesses/&gt; &lt;conditions/&gt; &lt;roles&gt;...&lt;/roles&gt; &lt;/denyExceptions&gt; &lt;service&gt;...&lt;/service&gt; &lt;dataMaskPolicyItems&gt; &lt;dataMaskInfo/&gt; &lt;/dataMaskPolicyItems&gt; &lt;rowFilterPolicyItems&gt; &lt;rowFilterInfo/&gt; &lt;/rowFilterPolicyItems&gt; &lt;zoneName&gt;...&lt;/zoneName&gt; &lt;resources&gt;...&lt;/resources&gt; &lt;denyPolicyItems&gt; &lt;groups&gt;...&lt;/groups&gt; &lt;users&gt;...&lt;/users&gt; &lt;delegateAdmin&gt;...&lt;/delegateAdmin&gt; &lt;accesses/&gt; &lt;conditions/&gt; &lt;roles&gt;...&lt;/roles&gt; &lt;/denyPolicyItems&gt; &lt;policyPriority&gt;...&lt;/policyPriority&gt; &lt;allowExceptions&gt; &lt;groups&gt;...&lt;/groups&gt; &lt;users&gt;...&lt;/users&gt; &lt;delegateAdmin&gt;...&lt;/delegateAdmin&gt; &lt;accesses/&gt; &lt;conditions/&gt; &lt;roles&gt;...&lt;/roles&gt; &lt;/allowExceptions&gt; &lt;validitySchedules&gt; &lt;startTime&gt;...&lt;/startTime&gt; &lt;recurrences/&gt; &lt;endTime&gt;...&lt;/endTime&gt; &lt;timeZone&gt;...&lt;/timeZone&gt; &lt;/validitySchedules&gt; &lt;policyLabels&gt;...&lt;/policyLabels&gt; &lt;policyType&gt;...&lt;/policyType&gt; &lt;description&gt;...&lt;/description&gt; &lt;conditions&gt; &lt;type&gt;...&lt;/type&gt; &lt;values&gt;...&lt;/values&gt; &lt;/conditions&gt; &lt;policyItems&gt; &lt;groups&gt;...&lt;/groups&gt; &lt;users&gt;...&lt;/users&gt; &lt;delegateAdmin&gt;...&lt;/delegateAdmin&gt; &lt;accesses/&gt; &lt;conditions/&gt; &lt;roles&gt;...&lt;/roles&gt; &lt;/policyItems&gt; &lt;options&gt;...&lt;/options&gt; &lt;isDenyAllElse&gt;...&lt;/isDenyAllElse&gt; &lt;isAuditEnabled&gt;...&lt;/isAuditEnabled&gt; &lt;name&gt;...&lt;/name&gt; &lt;resourceSignature&gt;...&lt;/resourceSignature&gt; &lt;serviceType&gt;...&lt;/serviceType&gt; &lt;guid&gt;...&lt;/guid&gt; &lt;updateTime&gt;...&lt;/updateTime&gt; &lt;id&gt;...&lt;/id&gt; &lt;createTime&gt;...&lt;/createTime&gt; &lt;updatedBy&gt;...&lt;/updatedBy&gt; &lt;createdBy&gt;...&lt;/createdBy&gt; &lt;isEnabled&gt;...&lt;/isEnabled&gt; &lt;version&gt;...&lt;/version&gt; &lt;/policies&gt; &lt;auditMode&gt;...&lt;/auditMode&gt; &lt;policyVersion&gt;...&lt;/policyVersion&gt; &lt;serviceDef&gt; &lt;dataMaskDef&gt; &lt;maskTypes/&gt; &lt;accessTypes/&gt; &lt;resources/&gt; &lt;/dataMaskDef&gt; &lt;configs&gt; &lt;type&gt;...&lt;/type&gt; &lt;rbKeyDescription&gt;...&lt;/rbKeyDescription&gt; &lt;rbKeyValidationMessage&gt;...&lt;/rbKeyValidationMessage&gt; &lt;subType&gt;...&lt;/subType&gt; &lt;rbKeyLabel&gt;...&lt;/rbKeyLabel&gt; &lt;itemId&gt;...&lt;/itemId&gt; &lt;validationRegEx&gt;...&lt;/validationRegEx&gt; &lt;description&gt;...&lt;/description&gt; &lt;label&gt;...&lt;/label&gt; &lt;mandatory&gt;...&lt;/mandatory&gt; &lt;name&gt;...&lt;/name&gt; &lt;validationMessage&gt;...&lt;/validationMessage&gt; &lt;defaultValue&gt;...&lt;/defaultValue&gt; &lt;uiHint&gt;...&lt;/uiHint&gt; &lt;/configs&gt; &lt;rbKeyDescription&gt;...&lt;/rbKeyDescription&gt; &lt;rbKeyLabel&gt;...&lt;/rbKeyLabel&gt; &lt;displayName&gt;...&lt;/displayName&gt; &lt;implClass&gt;...&lt;/implClass&gt; &lt;resources&gt; &lt;recursiveSupported&gt;...&lt;/recursiveSupported&gt; &lt;rbKeyDescription&gt;...&lt;/rbKeyDescription&gt; &lt;uiHint&gt;...&lt;/uiHint&gt; &lt;matcherOptions&gt;...&lt;/matcherOptions&gt; &lt;level&gt;...&lt;/level&gt; &lt;description&gt;...&lt;/description&gt; &lt;name&gt;...&lt;/name&gt; &lt;validationRegEx&gt;...&lt;/validationRegEx&gt; &lt;isValidLeaf&gt;...&lt;/isValidLeaf&gt; &lt;type&gt;...&lt;/type&gt; &lt;rbKeyLabel&gt;...&lt;/rbKeyLabel&gt; &lt;validationMessage&gt;...&lt;/validationMessage&gt; &lt;excludesSupported&gt;...&lt;/excludesSupported&gt; &lt;mandatory&gt;...&lt;/mandatory&gt; &lt;label&gt;...&lt;/label&gt; &lt;accessTypeRestrictions&gt;...&lt;/accessTypeRestrictions&gt; &lt;rbKeyValidationMessage&gt;...&lt;/rbKeyValidationMessage&gt; &lt;parent&gt;...&lt;/parent&gt; &lt;lookupSupported&gt;...&lt;/lookupSupported&gt; &lt;matcher&gt;...&lt;/matcher&gt; &lt;itemId&gt;...&lt;/itemId&gt; &lt;/resources&gt; &lt;name&gt;...&lt;/name&gt; &lt;description&gt;...&lt;/description&gt; &lt;accessTypes&gt; &lt;label&gt;...&lt;/label&gt; &lt;itemId&gt;...&lt;/itemId&gt; &lt;name&gt;...&lt;/name&gt; &lt;impliedGrants&gt;...&lt;/impliedGrants&gt; &lt;rbKeyLabel&gt;...&lt;/rbKeyLabel&gt; &lt;/accessTypes&gt; &lt;label&gt;...&lt;/label&gt; &lt;rowFilterDef&gt; &lt;resources/&gt; &lt;accessTypes/&gt; &lt;/rowFilterDef&gt; &lt;contextEnrichers&gt; &lt;name&gt;...&lt;/name&gt; &lt;itemId&gt;...&lt;/itemId&gt; &lt;enricher&gt;...&lt;/enricher&gt; &lt;enricherOptions&gt;...&lt;/enricherOptions&gt; &lt;/contextEnrichers&gt; &lt;policyConditions&gt; &lt;rbKeyDescription&gt;...&lt;/rbKeyDescription&gt; &lt;rbKeyLabel&gt;...&lt;/rbKeyLabel&gt; &lt;description&gt;...&lt;/description&gt; &lt;itemId&gt;...&lt;/itemId&gt; &lt;evaluatorOptions&gt;...&lt;/evaluatorOptions&gt; &lt;validationRegEx&gt;...&lt;/validationRegEx&gt; &lt;evaluator&gt;...&lt;/evaluator&gt; &lt;rbKeyValidationMessage&gt;...&lt;/rbKeyValidationMessage&gt; &lt;validationMessage&gt;...&lt;/validationMessage&gt; &lt;name&gt;...&lt;/name&gt; &lt;uiHint&gt;...&lt;/uiHint&gt; &lt;label&gt;...&lt;/label&gt; &lt;/policyConditions&gt; &lt;options&gt;...&lt;/options&gt; &lt;enums&gt; &lt;name&gt;...&lt;/name&gt; &lt;itemId&gt;...&lt;/itemId&gt; &lt;defaultIndex&gt;...&lt;/defaultIndex&gt; &lt;elements/&gt; &lt;/enums&gt; &lt;guid&gt;...&lt;/guid&gt; &lt;updateTime&gt;...&lt;/updateTime&gt; &lt;id&gt;...&lt;/id&gt; &lt;createTime&gt;...&lt;/createTime&gt; &lt;updatedBy&gt;...&lt;/updatedBy&gt; &lt;createdBy&gt;...&lt;/createdBy&gt; &lt;isEnabled&gt;...&lt;/isEnabled&gt; &lt;version&gt;...&lt;/version&gt; &lt;/serviceDef&gt; &lt;serviceId&gt;...&lt;/serviceId&gt; &lt;serviceConfig&gt;...&lt;/serviceConfig&gt; &lt;securityZones&gt;...&lt;/securityZones&gt; &lt;policyUpdateTime&gt;...&lt;/policyUpdateTime&gt; &lt;policyDeltas&gt; &lt;policiesVersion&gt;...&lt;/policiesVersion&gt; &lt;changeType&gt;...&lt;/changeType&gt; &lt;policy&gt; &lt;denyExceptions/&gt; &lt;service&gt;...&lt;/service&gt; &lt;dataMaskPolicyItems/&gt; &lt;rowFilterPolicyItems/&gt; &lt;zoneName&gt;...&lt;/zoneName&gt; &lt;resources&gt;...&lt;/resources&gt; &lt;denyPolicyItems/&gt; &lt;policyPriority&gt;...&lt;/policyPriority&gt; &lt;allowExceptions/&gt; &lt;validitySchedules/&gt; &lt;policyLabels&gt;...&lt;/policyLabels&gt; &lt;policyType&gt;...&lt;/policyType&gt; &lt;description&gt;...&lt;/description&gt; &lt;conditions/&gt; &lt;policyItems/&gt; &lt;options&gt;...&lt;/options&gt; &lt;isDenyAllElse&gt;...&lt;/isDenyAllElse&gt; &lt;isAuditEnabled&gt;...&lt;/isAuditEnabled&gt; &lt;name&gt;...&lt;/name&gt; &lt;resourceSignature&gt;...&lt;/resourceSignature&gt; &lt;serviceType&gt;...&lt;/serviceType&gt; &lt;/policy&gt; &lt;id&gt;...&lt;/id&gt; &lt;/policyDeltas&gt; &lt;serviceName&gt;...&lt;/serviceName&gt; &lt;tagPolicies&gt; &lt;policyUpdateTime&gt;...&lt;/policyUpdateTime&gt; &lt;serviceName&gt;...&lt;/serviceName&gt; &lt;auditMode&gt;...&lt;/auditMode&gt; &lt;policyVersion&gt;...&lt;/policyVersion&gt; &lt;serviceId&gt;...&lt;/serviceId&gt; &lt;serviceConfig&gt;...&lt;/serviceConfig&gt; &lt;serviceDef&gt; &lt;dataMaskDef/&gt; &lt;configs/&gt; &lt;rbKeyDescription&gt;...&lt;/rbKeyDescription&gt; &lt;rbKeyLabel&gt;...&lt;/rbKeyLabel&gt; &lt;displayName&gt;...&lt;/displayName&gt; &lt;implClass&gt;...&lt;/implClass&gt; &lt;resources/&gt; &lt;name&gt;...&lt;/name&gt; &lt;description&gt;...&lt;/description&gt; &lt;accessTypes/&gt; &lt;label&gt;...&lt;/label&gt; &lt;rowFilterDef/&gt; &lt;contextEnrichers/&gt; &lt;policyConditions/&gt; &lt;options&gt;...&lt;/options&gt; &lt;enums/&gt; &lt;/serviceDef&gt; &lt;policies&gt; &lt;denyExceptions/&gt; &lt;service&gt;...&lt;/service&gt; &lt;dataMaskPolicyItems/&gt; &lt;rowFilterPolicyItems/&gt; &lt;zoneName&gt;...&lt;/zoneName&gt; &lt;resources&gt;...&lt;/resources&gt; &lt;denyPolicyItems/&gt; &lt;policyPriority&gt;...&lt;/policyPriority&gt; &lt;allowExceptions/&gt; &lt;validitySchedules/&gt; &lt;policyLabels&gt;...&lt;/policyLabels&gt; &lt;policyType&gt;...&lt;/policyType&gt; &lt;description&gt;...&lt;/description&gt; &lt;conditions/&gt; &lt;policyItems/&gt; &lt;options&gt;...&lt;/options&gt; &lt;isDenyAllElse&gt;...&lt;/isDenyAllElse&gt; &lt;isAuditEnabled&gt;...&lt;/isAuditEnabled&gt; &lt;name&gt;...&lt;/name&gt; &lt;resourceSignature&gt;...&lt;/resourceSignature&gt; &lt;serviceType&gt;...&lt;/serviceType&gt; &lt;/policies&gt; &lt;/tagPolicies&gt; &lt;/servicePolicies&gt; </pre> <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>