kms/apidocs/index.html (560 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</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</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="#resources"><abbr title="Resources"><span class="sideoverflow">Resources</span></abbr></a></li> <li><a href="#syntax_xml"><abbr title="XML"><span class="sideoverflow">XML</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="dropdown"><a href="index.html">Home</a></li> </ol> <div class="page-header"> Apache Ranger is a framework to enable, monitor and manage comprehensive data security across the Hadoop platform. Apache Ranger currently provides a centralized security adminstration, fine grain access control and detailed auditing for user access within Apache Hadoop, Apache Hive, Apache HBase and other Apache components </div> <h1 class="page-header" id="resources">Resources</h1> <p> There is a <a href="application.wadl">WADL document</a> available that describes the resources API. </p> <p> You may also enjoy the <a href="ui/index.html">interactive interface</a> provided for this API by <a href="http://swagger.io">Swagger</a>. </p> <p> <a href="ui/index.html" class="btn btn-default">Try it out!</a> </p> <table class="table table-hover resources"> <thead> <tr> <th align="center">name</th> <th align="center">path</th> <th align="center">methods</th> <th align="center">description</th> </tr> </thead> <tbody data-link="row" class="rowlink"> <tr class="clickable-row" data-href="resource_KMS.html"> <td> <span class="resource-name">KMS</span> </td> <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/v1/keys</span> </samp></li><li><samp> <span class="resource-path">/v1/key/{name}</span> </samp></li><li><samp> <span class="resource-path">/v1/keys/metadata</span> </samp></li><li><samp> <span class="resource-path">/v1/keys/names</span> </samp></li><li><samp> <span class="resource-path">/v1/keyversion/{versionName}</span> </samp></li><li><samp> <span class="resource-path">/v1/key/{name}/_currentversion</span> </samp></li><li><samp> <span class="resource-path">/v1/key/{name}/_eek</span> </samp></li><li><samp> <span class="resource-path">/v1/key/{name}/_invalidatecache</span> </samp></li><li><samp> <span class="resource-path">/v1/key/{name}/_metadata</span> </samp></li><li><samp> <span class="resource-path">/v1/key/{name}/_reencryptbatch</span> </samp></li><li><samp> <span class="resource-path">/v1/key/{name}/_versions</span> </samp></li><li><samp> <span class="resource-path">/v1/keyversion/{versionName}/_eek</span> </samp></li></ul></td> <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">POST</span> </samp></li><li><samp> <span class="label label-default resource-method">DELETE</span> <span class="label label-default resource-method">GET</span> <span class="label label-default resource-method">POST</span> </samp></li><li><samp> <span class="label label-default resource-method">GET</span> </samp></li><li><samp> <span class="label label-default resource-method">GET</span> </samp></li><li><samp> <span class="label label-default resource-method">GET</span> </samp></li><li><samp> <span class="label label-default resource-method">GET</span> </samp></li><li><samp> <span class="label label-default resource-method">GET</span> </samp></li><li><samp> <span class="label label-default resource-method">POST</span> </samp></li><li><samp> <span class="label label-default resource-method">GET</span> </samp></li><li><samp> <span class="label label-default resource-method">POST</span> </samp></li><li><samp> <span class="label label-default resource-method">GET</span> </samp></li><li><samp> <span class="label label-default resource-method">POST</span> </samp></li></ul></td> <td> <span class="resource-description">Class providing the REST bindings, via Jersey, for the KMS.</span> </td> </tr> <tr class="clickable-row" data-href="resource_RangerKMSRestApi.html"> <td> <span class="resource-name">RangerKMSRestApi</span> </td> <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="resource-path">/api/status</span> </samp></li></ul></td> <td class="text-nowrap"><ul class="list-unstyled"><li><samp> <span class="label label-default resource-method">GET</span> </samp></li></ul></td> <td> <span class="resource-description"></span> </td> </tr> </tbody> </table> <h1 class="page-header" id="data">Data Types</h1> <h3 id="syntax_xml"><span class="syntax-name">XML</span></h3> <table class="table table-hover datatypes"> <caption>Default Namespace (<a href="ns0.xsd">schema</a>)</caption> <thead> <tr> <th align="center">type</th> <th align="center">description</th> </tr> </thead> <tbody data-link="row" class="rowlink"> <tr class="clickable-row" data-href="xml_ns0_XXDBBase.html"> <td> <span class="datatype-name">XXDBBase</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_XXRangerKeyStore.html"> <td> <span class="datatype-name">XXRangerKeyStore</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_XXRangerMasterKey.html"> <td> <span class="datatype-name">XXRangerMasterKey</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerTagForEval.html"> <td> <span class="datatype-name">rangerTagForEval</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_auditFilter.html"> <td> <span class="datatype-name">auditFilter</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_accessResult.html"> <td> <span class="datatype-name">accessResult</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_groupInfo.html"> <td> <span class="datatype-name">groupInfo</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerBaseModelObject.html"> <td> <span class="datatype-name">rangerBaseModelObject</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerMetrics.html"> <td> <span class="datatype-name">rangerMetrics</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerPluginInfo.html"> <td> <span class="datatype-name">rangerPluginInfo</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerPolicy.html"> <td> <span class="datatype-name">rangerPolicy</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerDataMaskPolicyItem.html"> <td> <span class="datatype-name">rangerDataMaskPolicyItem</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerPolicyItem.html"> <td> <span class="datatype-name">rangerPolicyItem</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerPolicyItemAccess.html"> <td> <span class="datatype-name">rangerPolicyItemAccess</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerPolicyItemCondition.html"> <td> <span class="datatype-name">rangerPolicyItemCondition</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerPolicyItemDataMaskInfo.html"> <td> <span class="datatype-name">rangerPolicyItemDataMaskInfo</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerPolicyItemRowFilterInfo.html"> <td> <span class="datatype-name">rangerPolicyItemRowFilterInfo</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerPolicyResource.html"> <td> <span class="datatype-name">rangerPolicyResource</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerRowFilterPolicyItem.html"> <td> <span class="datatype-name">rangerRowFilterPolicyItem</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerPolicyDelta.html"> <td> <span class="datatype-name">rangerPolicyDelta</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerRole.html"> <td> <span class="datatype-name">rangerRole</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_roleMember.html"> <td> <span class="datatype-name">roleMember</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerSecurityZone.html"> <td> <span class="datatype-name">rangerSecurityZone</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerSecurityZoneService.html"> <td> <span class="datatype-name">rangerSecurityZoneService</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerService.html"> <td> <span class="datatype-name">rangerService</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerServiceDef.html"> <td> <span class="datatype-name">rangerServiceDef</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerAccessTypeDef.html"> <td> <span class="datatype-name">rangerAccessTypeDef</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerContextEnricherDef.html"> <td> <span class="datatype-name">rangerContextEnricherDef</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerDataMaskDef.html"> <td> <span class="datatype-name">rangerDataMaskDef</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerDataMaskTypeDef.html"> <td> <span class="datatype-name">rangerDataMaskTypeDef</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerEnumDef.html"> <td> <span class="datatype-name">rangerEnumDef</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerEnumElementDef.html"> <td> <span class="datatype-name">rangerEnumElementDef</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerPolicyConditionDef.html"> <td> <span class="datatype-name">rangerPolicyConditionDef</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerResourceDef.html"> <td> <span class="datatype-name">rangerResourceDef</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerRowFilterDef.html"> <td> <span class="datatype-name">rangerRowFilterDef</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerServiceConfigDef.html"> <td> <span class="datatype-name">rangerServiceConfigDef</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerServiceResource.html"> <td> <span class="datatype-name">rangerServiceResource</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerTag.html"> <td> <span class="datatype-name">rangerTag</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerTagDef.html"> <td> <span class="datatype-name">rangerTagDef</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerTagAttributeDef.html"> <td> <span class="datatype-name">rangerTagAttributeDef</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerTagResourceMap.html"> <td> <span class="datatype-name">rangerTagResourceMap</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerValidityRecurrence.html"> <td> <span class="datatype-name">rangerValidityRecurrence</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_recurrenceSchedule.html"> <td> <span class="datatype-name">recurrenceSchedule</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_validityInterval.html"> <td> <span class="datatype-name">validityInterval</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerValiditySchedule.html"> <td> <span class="datatype-name">rangerValiditySchedule</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_serviceDeleteResponse.html"> <td> <span class="datatype-name">serviceDeleteResponse</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_userInfo.html"> <td> <span class="datatype-name">userInfo</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerAccessResource.html"> <td> <span class="datatype-name">rangerAccessResource</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerAccessResourceImpl.html"> <td> <span class="datatype-name">rangerAccessResourceImpl</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerAccessResourceReadOnly.html"> <td> <span class="datatype-name">rangerAccessResourceReadOnly</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerMutableResource.html"> <td> <span class="datatype-name">rangerMutableResource</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_dataMaskResult.html"> <td> <span class="datatype-name">dataMaskResult</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rowFilterResult.html"> <td> <span class="datatype-name">rowFilterResult</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerTagResource.html"> <td> <span class="datatype-name">rangerTagResource</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerAuditPolicy.html"> <td> <span class="datatype-name">rangerAuditPolicy</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerAuditPolicyItem.html"> <td> <span class="datatype-name">rangerAuditPolicyItem</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_matchType.html"> <td> <span class="datatype-name">matchType</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_resourceLookupContext.html"> <td> <span class="datatype-name">resourceLookupContext</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_storedServiceResource.html"> <td> <span class="datatype-name">storedServiceResource</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_grantRevokeRequest.html"> <td> <span class="datatype-name">grantRevokeRequest</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_grantRevokeRoleRequest.html"> <td> <span class="datatype-name">grantRevokeRoleRequest</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerRequestedResources.html"> <td> <span class="datatype-name">rangerRequestedResources</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerRoles.html"> <td> <span class="datatype-name">rangerRoles</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_rangerUserStore.html"> <td> <span class="datatype-name">rangerUserStore</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_servicePolicies.html"> <td> <span class="datatype-name">servicePolicies</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_securityZoneInfo.html"> <td> <span class="datatype-name">securityZoneInfo</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_tagPolicies.html"> <td> <span class="datatype-name">tagPolicies</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_serviceTags.html"> <td> <span class="datatype-name">serviceTags</span> </td> <td> <span class="datatype-description"></span> </td> </tr> <tr class="clickable-row" data-href="xml_ns0_tagsChangeExtent.html"> <td> <span class="datatype-name">tagsChangeExtent</span> </td> <td> <span class="datatype-description"></span> </td> </tr> </tbody> </table> <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>