Resources

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
KMS
  • /v1/keys
  • /v1/key/{name}
  • /v1/keys/metadata
  • /v1/keys/names
  • /v1/keyversion/{versionName}
  • /v1/key/{name}/_currentversion
  • /v1/key/{name}/_eek
  • /v1/key/{name}/_invalidatecache
  • /v1/key/{name}/_metadata
  • /v1/key/{name}/_reencryptbatch
  • /v1/key/{name}/_versions
  • /v1/keyversion/{versionName}/_eek
  • POST
  • DELETE GET POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • GET
  • POST
  • GET
  • POST
Class providing the REST bindings, via Jersey, for the KMS.
RangerKMSRestApi
  • /api/status
  • GET

Data Types

XML

Default Namespace (schema)
type description
XXDBBase
XXRangerKeyStore
XXRangerMasterKey
rangerTagForEval
auditFilter
accessResult
groupInfo
rangerBaseModelObject
rangerMetrics
rangerPluginInfo
rangerPolicy
rangerDataMaskPolicyItem
rangerPolicyItem
rangerPolicyItemAccess
rangerPolicyItemCondition
rangerPolicyItemDataMaskInfo
rangerPolicyItemRowFilterInfo
rangerPolicyResource
rangerRowFilterPolicyItem
rangerPolicyDelta
rangerRole
roleMember
rangerSecurityZone
rangerSecurityZoneService
rangerService
rangerServiceDef
rangerAccessTypeDef
rangerContextEnricherDef
rangerDataMaskDef
rangerDataMaskTypeDef
rangerEnumDef
rangerEnumElementDef
rangerPolicyConditionDef
rangerResourceDef
rangerRowFilterDef
rangerServiceConfigDef
rangerServiceResource
rangerTag
rangerTagDef
rangerTagAttributeDef
rangerTagResourceMap
rangerValidityRecurrence
recurrenceSchedule
validityInterval
rangerValiditySchedule
serviceDeleteResponse
userInfo
rangerAccessResource
rangerAccessResourceImpl
rangerAccessResourceReadOnly
rangerMutableResource
dataMaskResult
rowFilterResult
rangerTagResource
rangerAuditPolicy
rangerAuditPolicyItem
matchType
resourceLookupContext
storedServiceResource
grantRevokeRequest
grantRevokeRoleRequest
rangerRequestedResources
rangerRoles
rangerUserStore
servicePolicies
securityZoneInfo
tagPolicies
serviceTags
tagsChangeExtent