Ranger REST API: PublicAPIsv2

DELETE /public/v2/api/policy

Request Parameters
name	type	description
policyname	query
servicename	query
zoneName	query

Example

Request

DELETE /public/v2/api/policy
Content-Type: */*

                
...

Response

HTTP/1.1 204 No Content

GET /public/v2/api/policy

Response Body
media type	data type	description
application/json	array of RangerPolicy (JSON)

Example

Request

GET /public/v2/api/policy
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "policyType" : 12345,
  "serviceType" : "...",
  "policyLabels" : [ "...", "..." ],
  "name" : "...",
  "isAuditEnabled" : true,
  "isDenyAllElse" : true,
  "dataMaskPolicyItems" : [ {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "zoneName" : "...",
  "allowExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "conditions" : [ {
    "type" : "...",
    "values" : [ "...", "..." ]
  }, {
    "type" : "...",
    "values" : [ "...", "..." ]
  } ],
  "policyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "denyExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "policyPriority" : 12345,
  "resources" : {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  },
  "resourceSignature" : "...",
  "service" : "...",
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "rowFilterPolicyItems" : [ {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "validitySchedules" : [ {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  }, {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  } ],
  "additionalResources" : [ {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  }, {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  } ],
  "denyPolicyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
} ]

POST /public/v2/api/policy

Request Body
media type	data type
application/json	RangerPolicy (JSON)

Response Body
media type	data type	description
application/json	RangerPolicy (JSON)

Example

Request

POST /public/v2/api/policy
Content-Type: application/json
Accept: application/json

                
{
  "policyType" : 12345,
  "serviceType" : "...",
  "policyLabels" : [ "...", "..." ],
  "name" : "...",
  "isAuditEnabled" : true,
  "isDenyAllElse" : true,
  "dataMaskPolicyItems" : [ {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "zoneName" : "...",
  "allowExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "conditions" : [ {
    "type" : "...",
    "values" : [ "...", "..." ]
  }, {
    "type" : "...",
    "values" : [ "...", "..." ]
  } ],
  "policyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "denyExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "policyPriority" : 12345,
  "resources" : {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  },
  "resourceSignature" : "...",
  "service" : "...",
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "rowFilterPolicyItems" : [ {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "validitySchedules" : [ {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  }, {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  } ],
  "additionalResources" : [ {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  }, {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  } ],
  "denyPolicyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "policyType" : 12345,
  "serviceType" : "...",
  "policyLabels" : [ "...", "..." ],
  "name" : "...",
  "isAuditEnabled" : true,
  "isDenyAllElse" : true,
  "dataMaskPolicyItems" : [ {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "zoneName" : "...",
  "allowExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "conditions" : [ {
    "type" : "...",
    "values" : [ "...", "..." ]
  }, {
    "type" : "...",
    "values" : [ "...", "..." ]
  } ],
  "policyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "denyExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "policyPriority" : 12345,
  "resources" : {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  },
  "resourceSignature" : "...",
  "service" : "...",
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "rowFilterPolicyItems" : [ {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "validitySchedules" : [ {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  }, {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  } ],
  "additionalResources" : [ {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  }, {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  } ],
  "denyPolicyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

GET /public/v2/api/roles

Response Body
media type	data type	description
application/json	array of RangerRole (JSON)

Example

Request

GET /public/v2/api/roles
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "createdByUser" : "...",
  "name" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
} ]

POST /public/v2/api/roles

Request Parameters
name	type	description	default	constraints
createNonExistUserGroup	query		false	boolean
serviceName	query

Request Body
media type	data type
application/json	RangerRole (JSON)

Response Body
media type	data type	description
application/json	RangerRole (JSON)

Example

Request

POST /public/v2/api/roles
Content-Type: application/json
Accept: application/json

                
{
  "createdByUser" : "...",
  "name" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "createdByUser" : "...",
  "name" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

GET /public/v2/api/service

Response Body
media type	data type	description
application/json	array of RangerService (JSON)

Example

Request

GET /public/v2/api/service
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "tagVersion" : 12345,
  "policyUpdateTime" : 12345,
  "tagService" : "...",
  "policyVersion" : 12345,
  "type" : "...",
  "description" : "...",
  "tagUpdateTime" : 12345,
  "displayName" : "...",
  "name" : "...",
  "configs" : {
    "property1" : "...",
    "property2" : "..."
  },
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
} ]

POST /public/v2/api/service

Request Body
media type	data type
application/json	RangerService (JSON)

Response Body
media type	data type	description
application/json	RangerService (JSON)

Example

Request

POST /public/v2/api/service
Content-Type: application/json
Accept: application/json

                
{
  "tagVersion" : 12345,
  "policyUpdateTime" : 12345,
  "tagService" : "...",
  "policyVersion" : 12345,
  "type" : "...",
  "description" : "...",
  "tagUpdateTime" : 12345,
  "displayName" : "...",
  "name" : "...",
  "configs" : {
    "property1" : "...",
    "property2" : "..."
  },
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "tagVersion" : 12345,
  "policyUpdateTime" : 12345,
  "tagService" : "...",
  "policyVersion" : 12345,
  "type" : "...",
  "description" : "...",
  "tagUpdateTime" : 12345,
  "displayName" : "...",
  "name" : "...",
  "configs" : {
    "property1" : "...",
    "property2" : "..."
  },
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

GET /public/v2/api/service-headers

Response Body
media type	data type	description
application/json	array of RangerServiceHeaderInfo (JSON)

Example

Request

GET /public/v2/api/service-headers
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "isTagService" : true,
  "isGdsService" : true,
  "name" : "...",
  "type" : "...",
  "displayName" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
} ]

GET /public/v2/api/servicedef

Response Body
media type	data type	description
application/json	array of RangerServiceDef (JSON)

Example

Request

GET /public/v2/api/servicedef
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "contextEnrichers" : [ {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  }, {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  } ],
  "configs" : [ {
    "itemId" : 12345,
    "type" : "...",
    "defaultValue" : "...",
    "validationMessage" : "...",
    "description" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "rbKeyDescription" : "...",
    "subType" : "...",
    "uiHint" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "name" : "...",
    "validationRegEx" : "..."
  }, {
    "itemId" : 12345,
    "type" : "...",
    "defaultValue" : "...",
    "validationMessage" : "...",
    "description" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "rbKeyDescription" : "...",
    "subType" : "...",
    "uiHint" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "name" : "...",
    "validationRegEx" : "..."
  } ],
  "markerAccessTypes" : [ {
    "category" : "DELETE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  }, {
    "category" : "DELETE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  } ],
  "enums" : [ {
    "defaultIndex" : 12345,
    "itemId" : 12345,
    "elements" : [ {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    }, {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    } ],
    "name" : "..."
  }, {
    "defaultIndex" : 12345,
    "itemId" : 12345,
    "elements" : [ {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    }, {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    } ],
    "name" : "..."
  } ],
  "policyConditions" : [ {
    "description" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "validationMessage" : "...",
    "evaluator" : "...",
    "label" : "...",
    "uiHint" : "...",
    "rbKeyDescription" : "...",
    "itemId" : 12345,
    "rbKeyValidationMessage" : "...",
    "validationRegEx" : "..."
  }, {
    "description" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "validationMessage" : "...",
    "evaluator" : "...",
    "label" : "...",
    "uiHint" : "...",
    "rbKeyDescription" : "...",
    "itemId" : 12345,
    "rbKeyValidationMessage" : "...",
    "validationRegEx" : "..."
  } ],
  "rowFilterDef" : {
    "resources" : [ {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    }, {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    } ],
    "accessTypes" : [ {
      "category" : "CREATE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "category" : "MANAGE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ]
  },
  "rbKeyDescription" : "...",
  "implClass" : "...",
  "displayName" : "...",
  "name" : "...",
  "rbKeyLabel" : "...",
  "description" : "...",
  "dataMaskDef" : {
    "maskTypes" : [ {
      "rbKeyDescription" : "...",
      "label" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "name" : "...",
      "transformer" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "rbKeyDescription" : "...",
      "label" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "name" : "...",
      "transformer" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "accessTypes" : [ {
      "category" : "READ",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "category" : "MANAGE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "resources" : [ {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    }, {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    } ]
  },
  "accessTypes" : [ {
    "category" : "DELETE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  }, {
    "category" : "UPDATE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  } ],
  "resources" : [ {
    "mandatory" : true,
    "rbKeyDescription" : "...",
    "level" : 12345,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "itemId" : 12345,
    "label" : "...",
    "rbKeyLabel" : "...",
    "name" : "...",
    "lookupSupported" : true,
    "matcher" : "...",
    "validationRegEx" : "...",
    "parent" : "...",
    "rbKeyValidationMessage" : "...",
    "excludesSupported" : true,
    "accessTypeRestrictions" : [ "...", "..." ],
    "isValidLeaf" : true,
    "description" : "...",
    "type" : "...",
    "recursiveSupported" : true,
    "validationMessage" : "...",
    "uiHint" : "..."
  }, {
    "mandatory" : true,
    "rbKeyDescription" : "...",
    "level" : 12345,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "itemId" : 12345,
    "label" : "...",
    "rbKeyLabel" : "...",
    "name" : "...",
    "lookupSupported" : true,
    "matcher" : "...",
    "validationRegEx" : "...",
    "parent" : "...",
    "rbKeyValidationMessage" : "...",
    "excludesSupported" : true,
    "accessTypeRestrictions" : [ "...", "..." ],
    "isValidLeaf" : true,
    "description" : "...",
    "type" : "...",
    "recursiveSupported" : true,
    "validationMessage" : "...",
    "uiHint" : "..."
  } ],
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "label" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
} ]

POST /public/v2/api/servicedef

Request Body
media type	data type
application/json	RangerServiceDef (JSON)

Response Body
media type	data type	description
application/json	RangerServiceDef (JSON)

Example

Request

POST /public/v2/api/servicedef
Content-Type: application/json
Accept: application/json

                
{
  "contextEnrichers" : [ {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  }, {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  } ],
  "configs" : [ {
    "itemId" : 12345,
    "type" : "...",
    "defaultValue" : "...",
    "validationMessage" : "...",
    "description" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "rbKeyDescription" : "...",
    "subType" : "...",
    "uiHint" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "name" : "...",
    "validationRegEx" : "..."
  }, {
    "itemId" : 12345,
    "type" : "...",
    "defaultValue" : "...",
    "validationMessage" : "...",
    "description" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "rbKeyDescription" : "...",
    "subType" : "...",
    "uiHint" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "name" : "...",
    "validationRegEx" : "..."
  } ],
  "markerAccessTypes" : [ {
    "category" : "CREATE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  }, {
    "category" : "MANAGE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  } ],
  "enums" : [ {
    "defaultIndex" : 12345,
    "itemId" : 12345,
    "elements" : [ {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    }, {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    } ],
    "name" : "..."
  }, {
    "defaultIndex" : 12345,
    "itemId" : 12345,
    "elements" : [ {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    }, {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    } ],
    "name" : "..."
  } ],
  "policyConditions" : [ {
    "description" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "validationMessage" : "...",
    "evaluator" : "...",
    "label" : "...",
    "uiHint" : "...",
    "rbKeyDescription" : "...",
    "itemId" : 12345,
    "rbKeyValidationMessage" : "...",
    "validationRegEx" : "..."
  }, {
    "description" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "validationMessage" : "...",
    "evaluator" : "...",
    "label" : "...",
    "uiHint" : "...",
    "rbKeyDescription" : "...",
    "itemId" : 12345,
    "rbKeyValidationMessage" : "...",
    "validationRegEx" : "..."
  } ],
  "rowFilterDef" : {
    "resources" : [ {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    }, {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    } ],
    "accessTypes" : [ {
      "category" : "MANAGE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "category" : "UPDATE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ]
  },
  "rbKeyDescription" : "...",
  "implClass" : "...",
  "displayName" : "...",
  "name" : "...",
  "rbKeyLabel" : "...",
  "description" : "...",
  "dataMaskDef" : {
    "maskTypes" : [ {
      "rbKeyDescription" : "...",
      "label" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "name" : "...",
      "transformer" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "rbKeyDescription" : "...",
      "label" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "name" : "...",
      "transformer" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "accessTypes" : [ {
      "category" : "MANAGE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "category" : "MANAGE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "resources" : [ {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    }, {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    } ]
  },
  "accessTypes" : [ {
    "category" : "CREATE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  }, {
    "category" : "DELETE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  } ],
  "resources" : [ {
    "mandatory" : true,
    "rbKeyDescription" : "...",
    "level" : 12345,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "itemId" : 12345,
    "label" : "...",
    "rbKeyLabel" : "...",
    "name" : "...",
    "lookupSupported" : true,
    "matcher" : "...",
    "validationRegEx" : "...",
    "parent" : "...",
    "rbKeyValidationMessage" : "...",
    "excludesSupported" : true,
    "accessTypeRestrictions" : [ "...", "..." ],
    "isValidLeaf" : true,
    "description" : "...",
    "type" : "...",
    "recursiveSupported" : true,
    "validationMessage" : "...",
    "uiHint" : "..."
  }, {
    "mandatory" : true,
    "rbKeyDescription" : "...",
    "level" : 12345,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "itemId" : 12345,
    "label" : "...",
    "rbKeyLabel" : "...",
    "name" : "...",
    "lookupSupported" : true,
    "matcher" : "...",
    "validationRegEx" : "...",
    "parent" : "...",
    "rbKeyValidationMessage" : "...",
    "excludesSupported" : true,
    "accessTypeRestrictions" : [ "...", "..." ],
    "isValidLeaf" : true,
    "description" : "...",
    "type" : "...",
    "recursiveSupported" : true,
    "validationMessage" : "...",
    "uiHint" : "..."
  } ],
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "label" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "contextEnrichers" : [ {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  }, {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  } ],
  "configs" : [ {
    "itemId" : 12345,
    "type" : "...",
    "defaultValue" : "...",
    "validationMessage" : "...",
    "description" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "rbKeyDescription" : "...",
    "subType" : "...",
    "uiHint" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "name" : "...",
    "validationRegEx" : "..."
  }, {
    "itemId" : 12345,
    "type" : "...",
    "defaultValue" : "...",
    "validationMessage" : "...",
    "description" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "rbKeyDescription" : "...",
    "subType" : "...",
    "uiHint" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "name" : "...",
    "validationRegEx" : "..."
  } ],
  "markerAccessTypes" : [ {
    "category" : "DELETE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  }, {
    "category" : "CREATE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  } ],
  "enums" : [ {
    "defaultIndex" : 12345,
    "itemId" : 12345,
    "elements" : [ {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    }, {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    } ],
    "name" : "..."
  }, {
    "defaultIndex" : 12345,
    "itemId" : 12345,
    "elements" : [ {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    }, {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    } ],
    "name" : "..."
  } ],
  "policyConditions" : [ {
    "description" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "validationMessage" : "...",
    "evaluator" : "...",
    "label" : "...",
    "uiHint" : "...",
    "rbKeyDescription" : "...",
    "itemId" : 12345,
    "rbKeyValidationMessage" : "...",
    "validationRegEx" : "..."
  }, {
    "description" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "validationMessage" : "...",
    "evaluator" : "...",
    "label" : "...",
    "uiHint" : "...",
    "rbKeyDescription" : "...",
    "itemId" : 12345,
    "rbKeyValidationMessage" : "...",
    "validationRegEx" : "..."
  } ],
  "rowFilterDef" : {
    "resources" : [ {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    }, {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    } ],
    "accessTypes" : [ {
      "category" : "MANAGE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "category" : "MANAGE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ]
  },
  "rbKeyDescription" : "...",
  "implClass" : "...",
  "displayName" : "...",
  "name" : "...",
  "rbKeyLabel" : "...",
  "description" : "...",
  "dataMaskDef" : {
    "maskTypes" : [ {
      "rbKeyDescription" : "...",
      "label" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "name" : "...",
      "transformer" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "rbKeyDescription" : "...",
      "label" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "name" : "...",
      "transformer" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "accessTypes" : [ {
      "category" : "READ",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "category" : "DELETE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "resources" : [ {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    }, {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    } ]
  },
  "accessTypes" : [ {
    "category" : "UPDATE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  }, {
    "category" : "READ",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  } ],
  "resources" : [ {
    "mandatory" : true,
    "rbKeyDescription" : "...",
    "level" : 12345,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "itemId" : 12345,
    "label" : "...",
    "rbKeyLabel" : "...",
    "name" : "...",
    "lookupSupported" : true,
    "matcher" : "...",
    "validationRegEx" : "...",
    "parent" : "...",
    "rbKeyValidationMessage" : "...",
    "excludesSupported" : true,
    "accessTypeRestrictions" : [ "...", "..." ],
    "isValidLeaf" : true,
    "description" : "...",
    "type" : "...",
    "recursiveSupported" : true,
    "validationMessage" : "...",
    "uiHint" : "..."
  }, {
    "mandatory" : true,
    "rbKeyDescription" : "...",
    "level" : 12345,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "itemId" : 12345,
    "label" : "...",
    "rbKeyLabel" : "...",
    "name" : "...",
    "lookupSupported" : true,
    "matcher" : "...",
    "validationRegEx" : "...",
    "parent" : "...",
    "rbKeyValidationMessage" : "...",
    "excludesSupported" : true,
    "accessTypeRestrictions" : [ "...", "..." ],
    "isValidLeaf" : true,
    "description" : "...",
    "type" : "...",
    "recursiveSupported" : true,
    "validationMessage" : "...",
    "uiHint" : "..."
  } ],
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "label" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

GET /public/v2/api/zone-headers

Get List of security zone header info. This API is authorized to every authenticated user.

Response Body
media type	data type	description
application/json	array of RangerSecurityZoneHeaderInfo (JSON)	List of RangerSecurityZoneHeaderInfo if present.

Example

Request

GET /public/v2/api/zone-headers
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "name" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
} ]

GET /public/v2/api/zones

Response Body
media type	data type	description
application/json	array of RangerSecurityZone (JSON)

Example

Request

GET /public/v2/api/zones
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "adminUserGroups" : [ "...", "..." ],
  "auditUsers" : [ "...", "..." ],
  "adminUsers" : [ "...", "..." ],
  "name" : "...",
  "adminRoles" : [ "...", "..." ],
  "auditRoles" : [ "...", "..." ],
  "tagServices" : [ "...", "..." ],
  "services" : {
    "property1" : {
      "resourcesBaseInfo" : [ {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ],
      "resources" : [ {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      }, {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      } ]
    },
    "property2" : {
      "resourcesBaseInfo" : [ {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ],
      "resources" : [ {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      }, {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      } ]
    }
  },
  "description" : "...",
  "auditUserGroups" : [ "...", "..." ],
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
} ]

POST /public/v2/api/zones

Request Body
media type	data type
application/json	RangerSecurityZone (JSON)

Response Body
media type	data type	description
application/json	RangerSecurityZone (JSON)

Example

Request

POST /public/v2/api/zones
Content-Type: application/json
Accept: application/json

                
{
  "adminUserGroups" : [ "...", "..." ],
  "auditUsers" : [ "...", "..." ],
  "adminUsers" : [ "...", "..." ],
  "name" : "...",
  "adminRoles" : [ "...", "..." ],
  "auditRoles" : [ "...", "..." ],
  "tagServices" : [ "...", "..." ],
  "services" : {
    "property1" : {
      "resourcesBaseInfo" : [ {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ],
      "resources" : [ {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      }, {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      } ]
    },
    "property2" : {
      "resourcesBaseInfo" : [ {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ],
      "resources" : [ {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      }, {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      } ]
    }
  },
  "description" : "...",
  "auditUserGroups" : [ "...", "..." ],
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "adminUserGroups" : [ "...", "..." ],
  "auditUsers" : [ "...", "..." ],
  "adminUsers" : [ "...", "..." ],
  "name" : "...",
  "adminRoles" : [ "...", "..." ],
  "auditRoles" : [ "...", "..." ],
  "tagServices" : [ "...", "..." ],
  "services" : {
    "property1" : {
      "resourcesBaseInfo" : [ {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ],
      "resources" : [ {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      }, {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      } ]
    },
    "property2" : {
      "resourcesBaseInfo" : [ {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ],
      "resources" : [ {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      }, {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      } ]
    }
  },
  "description" : "...",
  "auditUserGroups" : [ "...", "..." ],
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

GET /public/v2/api/zones-v2

Response Body
media type	data type	description
application/json	PListOfRangerSecurityZoneV2 (JSON)

Example

Request

GET /public/v2/api/zones-v2
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "listSize" : 12345,
  "pageSize" : 12345,
  "list" : [ {
    "admins" : [ {
      "type" : "GROUP",
      "name" : "..."
    }, {
      "type" : "USER",
      "name" : "..."
    } ],
    "services" : {
      "property1" : {
        "resources" : [ { }, { } ]
      },
      "property2" : {
        "resources" : [ { }, { } ]
      }
    },
    "name" : "...",
    "auditors" : [ {
      "type" : "GROUP",
      "name" : "..."
    }, {
      "type" : "GROUP",
      "name" : "..."
    } ],
    "tagServices" : [ "...", "..." ],
    "description" : "...",
    "createdBy" : "...",
    "createTime" : 12345,
    "id" : 12345,
    "version" : 12345,
    "isEnabled" : true,
    "guid" : "...",
    "updateTime" : 12345,
    "updatedBy" : "..."
  }, {
    "admins" : [ {
      "type" : "GROUP",
      "name" : "..."
    }, {
      "type" : "ROLE",
      "name" : "..."
    } ],
    "services" : {
      "property1" : {
        "resources" : [ { }, { } ]
      },
      "property2" : {
        "resources" : [ { }, { } ]
      }
    },
    "name" : "...",
    "auditors" : [ {
      "type" : "USER",
      "name" : "..."
    }, {
      "type" : "USER",
      "name" : "..."
    } ],
    "tagServices" : [ "...", "..." ],
    "description" : "...",
    "createdBy" : "...",
    "createTime" : 12345,
    "id" : 12345,
    "version" : 12345,
    "isEnabled" : true,
    "guid" : "...",
    "updateTime" : 12345,
    "updatedBy" : "..."
  } ],
  "queryTimeMS" : 12345,
  "sortBy" : "...",
  "startIndex" : 12345,
  "resultSize" : 12345,
  "totalCount" : 12345,
  "sortType" : "..."
}

POST /public/v2/api/zones-v2

Request Body
media type	data type
application/json	RangerSecurityZoneV2 (JSON)

Response Body
media type	data type	description
application/json	RangerSecurityZoneV2 (JSON)

Example

Request

POST /public/v2/api/zones-v2
Content-Type: application/json
Accept: application/json

                
{
  "admins" : [ {
    "type" : "USER",
    "name" : "..."
  }, {
    "type" : "ROLE",
    "name" : "..."
  } ],
  "services" : {
    "property1" : {
      "resources" : [ {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ]
    },
    "property2" : {
      "resources" : [ {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ]
    }
  },
  "name" : "...",
  "auditors" : [ {
    "type" : "USER",
    "name" : "..."
  }, {
    "type" : "GROUP",
    "name" : "..."
  } ],
  "tagServices" : [ "...", "..." ],
  "description" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "admins" : [ {
    "type" : "USER",
    "name" : "..."
  }, {
    "type" : "USER",
    "name" : "..."
  } ],
  "services" : {
    "property1" : {
      "resources" : [ {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ]
    },
    "property2" : {
      "resources" : [ {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ]
    }
  },
  "name" : "...",
  "auditors" : [ {
    "type" : "GROUP",
    "name" : "..."
  }, {
    "type" : "USER",
    "name" : "..."
  } ],
  "tagServices" : [ "...", "..." ],
  "description" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

GET /public/v2/api/plugins/info

Response Body
media type	data type	description
application/json	array of RangerPluginInfo (JSON)

Example

Request

GET /public/v2/api/plugins/info
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "ipAddress" : "...",
  "hostName" : "...",
  "appType" : "...",
  "updateTime" : 12345,
  "serviceDisplayName" : "...",
  "serviceType" : "...",
  "id" : 12345,
  "serviceTypeDisplayName" : "...",
  "info" : {
    "property1" : "...",
    "property2" : "..."
  },
  "serviceName" : "...",
  "createTime" : 12345
} ]

DELETE /public/v2/api/policies/bulk

Request Parameters
name	type	description
serviceName	query

Response Body
media type	data type	description
application/json	array of number (JSON)

Example

Request

DELETE /public/v2/api/policies/bulk
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
...

POST /public/v2/api/policy/apply

Request Body
media type	data type
application/json	RangerPolicy (JSON)

Response Body
media type	data type	description
application/json	RangerPolicy (JSON)

Example

Request

POST /public/v2/api/policy/apply
Content-Type: application/json
Accept: application/json

                
{
  "policyType" : 12345,
  "serviceType" : "...",
  "policyLabels" : [ "...", "..." ],
  "name" : "...",
  "isAuditEnabled" : true,
  "isDenyAllElse" : true,
  "dataMaskPolicyItems" : [ {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "zoneName" : "...",
  "allowExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "conditions" : [ {
    "type" : "...",
    "values" : [ "...", "..." ]
  }, {
    "type" : "...",
    "values" : [ "...", "..." ]
  } ],
  "policyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "denyExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "policyPriority" : 12345,
  "resources" : {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  },
  "resourceSignature" : "...",
  "service" : "...",
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "rowFilterPolicyItems" : [ {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "validitySchedules" : [ {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  }, {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  } ],
  "additionalResources" : [ {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  }, {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  } ],
  "denyPolicyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "policyType" : 12345,
  "serviceType" : "...",
  "policyLabels" : [ "...", "..." ],
  "name" : "...",
  "isAuditEnabled" : true,
  "isDenyAllElse" : true,
  "dataMaskPolicyItems" : [ {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "zoneName" : "...",
  "allowExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "conditions" : [ {
    "type" : "...",
    "values" : [ "...", "..." ]
  }, {
    "type" : "...",
    "values" : [ "...", "..." ]
  } ],
  "policyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "denyExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "policyPriority" : 12345,
  "resources" : {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  },
  "resourceSignature" : "...",
  "service" : "...",
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "rowFilterPolicyItems" : [ {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "validitySchedules" : [ {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  }, {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  } ],
  "additionalResources" : [ {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  }, {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  } ],
  "denyPolicyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

DELETE /public/v2/api/policy/{id}

Request Parameters
name	type	description	constraints
id	path		long

Example

Request

DELETE /public/v2/api/policy/{id}
Content-Type: */*

                
...

Response

HTTP/1.1 204 No Content

GET /public/v2/api/policy/{id}

Request Parameters
name	type	description	constraints
id	path		long

Response Body
media type	data type	description
application/json	RangerPolicy (JSON)

Example

Request

GET /public/v2/api/policy/{id}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "policyType" : 12345,
  "serviceType" : "...",
  "policyLabels" : [ "...", "..." ],
  "name" : "...",
  "isAuditEnabled" : true,
  "isDenyAllElse" : true,
  "dataMaskPolicyItems" : [ {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "zoneName" : "...",
  "allowExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "conditions" : [ {
    "type" : "...",
    "values" : [ "...", "..." ]
  }, {
    "type" : "...",
    "values" : [ "...", "..." ]
  } ],
  "policyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "denyExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "policyPriority" : 12345,
  "resources" : {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  },
  "resourceSignature" : "...",
  "service" : "...",
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "rowFilterPolicyItems" : [ {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "validitySchedules" : [ {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  }, {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  } ],
  "additionalResources" : [ {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  }, {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  } ],
  "denyPolicyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

PUT /public/v2/api/policy/{id}

Request Parameters
name	type	description	constraints
id	path		long

Request Body
media type	data type
application/json	RangerPolicy (JSON)

Response Body
media type	data type	description
application/json	RangerPolicy (JSON)

Example

Request

PUT /public/v2/api/policy/{id}
Content-Type: application/json
Accept: application/json

                
{
  "policyType" : 12345,
  "serviceType" : "...",
  "policyLabels" : [ "...", "..." ],
  "name" : "...",
  "isAuditEnabled" : true,
  "isDenyAllElse" : true,
  "dataMaskPolicyItems" : [ {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "zoneName" : "...",
  "allowExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "conditions" : [ {
    "type" : "...",
    "values" : [ "...", "..." ]
  }, {
    "type" : "...",
    "values" : [ "...", "..." ]
  } ],
  "policyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "denyExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "policyPriority" : 12345,
  "resources" : {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  },
  "resourceSignature" : "...",
  "service" : "...",
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "rowFilterPolicyItems" : [ {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "validitySchedules" : [ {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  }, {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  } ],
  "additionalResources" : [ {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  }, {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  } ],
  "denyPolicyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "policyType" : 12345,
  "serviceType" : "...",
  "policyLabels" : [ "...", "..." ],
  "name" : "...",
  "isAuditEnabled" : true,
  "isDenyAllElse" : true,
  "dataMaskPolicyItems" : [ {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "zoneName" : "...",
  "allowExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "conditions" : [ {
    "type" : "...",
    "values" : [ "...", "..." ]
  }, {
    "type" : "...",
    "values" : [ "...", "..." ]
  } ],
  "policyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "denyExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "policyPriority" : 12345,
  "resources" : {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  },
  "resourceSignature" : "...",
  "service" : "...",
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "rowFilterPolicyItems" : [ {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "validitySchedules" : [ {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  }, {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  } ],
  "additionalResources" : [ {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  }, {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  } ],
  "denyPolicyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

GET /public/v2/api/roles/names

Request Parameters
name	type	description
execUser	query
serviceName	query

Response Body
media type	data type	description
application/json	array of string (JSON)

Example

Request

GET /public/v2/api/roles/names
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
...

DELETE /public/v2/api/roles/{id}

Request Parameters
name	type	description	constraints
id	path		long

Example

Request

DELETE /public/v2/api/roles/{id}
Content-Type: */*

                
...

Response

HTTP/1.1 204 No Content

GET /public/v2/api/roles/{id}

Request Parameters
name	type	description	constraints
id	path		long

Response Body
media type	data type	description
application/json	RangerRole (JSON)

Example

Request

GET /public/v2/api/roles/{id}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "createdByUser" : "...",
  "name" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

PUT /public/v2/api/roles/{id}

Request Parameters
name	type	description	default	constraints
id	path			long
createNonExistUserGroup	query		false	boolean

Request Body
media type	data type
application/json	RangerRole (JSON)

Response Body
media type	data type	description
application/json	RangerRole (JSON)

Example

Request

PUT /public/v2/api/roles/{id}
Content-Type: application/json
Accept: application/json

                
{
  "createdByUser" : "...",
  "name" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "createdByUser" : "...",
  "name" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

DELETE /public/v2/api/server/policydeltas

Request Parameters
name	type	description	default	constraints
days	query		7	int

Example

Request

DELETE /public/v2/api/server/policydeltas
Content-Type: */*

                
...

Response

HTTP/1.1 204 No Content

DELETE /public/v2/api/server/tagdeltas

Request Parameters
name	type	description	default	constraints
days	query		7	int

Example

Request

DELETE /public/v2/api/server/tagdeltas
Content-Type: */*

                
...

Response

HTTP/1.1 204 No Content

DELETE /public/v2/api/service/{id}

Request Parameters
name	type	description	constraints
id	path		long

Example

Request

DELETE /public/v2/api/service/{id}
Content-Type: */*

                
...

Response

HTTP/1.1 204 No Content

GET /public/v2/api/service/{id}

Request Parameters
name	type	description	constraints
id	path		long

Response Body
media type	data type	description
application/json	RangerService (JSON)

Example

Request

GET /public/v2/api/service/{id}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "tagVersion" : 12345,
  "policyUpdateTime" : 12345,
  "tagService" : "...",
  "policyVersion" : 12345,
  "type" : "...",
  "description" : "...",
  "tagUpdateTime" : 12345,
  "displayName" : "...",
  "name" : "...",
  "configs" : {
    "property1" : "...",
    "property2" : "..."
  },
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

PUT /public/v2/api/service/{id}

Request Parameters
name	type	description	constraints
id	path		long

Request Body
media type	data type
application/json	RangerService (JSON)

Response Body
media type	data type	description
application/json	RangerService (JSON)

Example

Request

PUT /public/v2/api/service/{id}
Content-Type: application/json
Accept: application/json

                
{
  "tagVersion" : 12345,
  "policyUpdateTime" : 12345,
  "tagService" : "...",
  "policyVersion" : 12345,
  "type" : "...",
  "description" : "...",
  "tagUpdateTime" : 12345,
  "displayName" : "...",
  "name" : "...",
  "configs" : {
    "property1" : "...",
    "property2" : "..."
  },
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "tagVersion" : 12345,
  "policyUpdateTime" : 12345,
  "tagService" : "...",
  "policyVersion" : 12345,
  "type" : "...",
  "description" : "...",
  "tagUpdateTime" : 12345,
  "displayName" : "...",
  "name" : "...",
  "configs" : {
    "property1" : "...",
    "property2" : "..."
  },
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

DELETE /public/v2/api/servicedef/{id}

Request Parameters
name	type	description	constraints
id	path		long

Example

Request

DELETE /public/v2/api/servicedef/{id}
Content-Type: */*

                
...

Response

HTTP/1.1 204 No Content

GET /public/v2/api/servicedef/{id}

Request Parameters
name	type	description	constraints
id	path		long

Response Body
media type	data type	description
application/json	RangerServiceDef (JSON)

Example

Request

GET /public/v2/api/servicedef/{id}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "contextEnrichers" : [ {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  }, {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  } ],
  "configs" : [ {
    "itemId" : 12345,
    "type" : "...",
    "defaultValue" : "...",
    "validationMessage" : "...",
    "description" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "rbKeyDescription" : "...",
    "subType" : "...",
    "uiHint" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "name" : "...",
    "validationRegEx" : "..."
  }, {
    "itemId" : 12345,
    "type" : "...",
    "defaultValue" : "...",
    "validationMessage" : "...",
    "description" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "rbKeyDescription" : "...",
    "subType" : "...",
    "uiHint" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "name" : "...",
    "validationRegEx" : "..."
  } ],
  "markerAccessTypes" : [ {
    "category" : "READ",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  }, {
    "category" : "READ",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  } ],
  "enums" : [ {
    "defaultIndex" : 12345,
    "itemId" : 12345,
    "elements" : [ {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    }, {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    } ],
    "name" : "..."
  }, {
    "defaultIndex" : 12345,
    "itemId" : 12345,
    "elements" : [ {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    }, {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    } ],
    "name" : "..."
  } ],
  "policyConditions" : [ {
    "description" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "validationMessage" : "...",
    "evaluator" : "...",
    "label" : "...",
    "uiHint" : "...",
    "rbKeyDescription" : "...",
    "itemId" : 12345,
    "rbKeyValidationMessage" : "...",
    "validationRegEx" : "..."
  }, {
    "description" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "validationMessage" : "...",
    "evaluator" : "...",
    "label" : "...",
    "uiHint" : "...",
    "rbKeyDescription" : "...",
    "itemId" : 12345,
    "rbKeyValidationMessage" : "...",
    "validationRegEx" : "..."
  } ],
  "rowFilterDef" : {
    "resources" : [ {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    }, {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    } ],
    "accessTypes" : [ {
      "category" : "MANAGE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "category" : "UPDATE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ]
  },
  "rbKeyDescription" : "...",
  "implClass" : "...",
  "displayName" : "...",
  "name" : "...",
  "rbKeyLabel" : "...",
  "description" : "...",
  "dataMaskDef" : {
    "maskTypes" : [ {
      "rbKeyDescription" : "...",
      "label" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "name" : "...",
      "transformer" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "rbKeyDescription" : "...",
      "label" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "name" : "...",
      "transformer" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "accessTypes" : [ {
      "category" : "UPDATE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "category" : "DELETE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "resources" : [ {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    }, {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    } ]
  },
  "accessTypes" : [ {
    "category" : "DELETE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  }, {
    "category" : "UPDATE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  } ],
  "resources" : [ {
    "mandatory" : true,
    "rbKeyDescription" : "...",
    "level" : 12345,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "itemId" : 12345,
    "label" : "...",
    "rbKeyLabel" : "...",
    "name" : "...",
    "lookupSupported" : true,
    "matcher" : "...",
    "validationRegEx" : "...",
    "parent" : "...",
    "rbKeyValidationMessage" : "...",
    "excludesSupported" : true,
    "accessTypeRestrictions" : [ "...", "..." ],
    "isValidLeaf" : true,
    "description" : "...",
    "type" : "...",
    "recursiveSupported" : true,
    "validationMessage" : "...",
    "uiHint" : "..."
  }, {
    "mandatory" : true,
    "rbKeyDescription" : "...",
    "level" : 12345,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "itemId" : 12345,
    "label" : "...",
    "rbKeyLabel" : "...",
    "name" : "...",
    "lookupSupported" : true,
    "matcher" : "...",
    "validationRegEx" : "...",
    "parent" : "...",
    "rbKeyValidationMessage" : "...",
    "excludesSupported" : true,
    "accessTypeRestrictions" : [ "...", "..." ],
    "isValidLeaf" : true,
    "description" : "...",
    "type" : "...",
    "recursiveSupported" : true,
    "validationMessage" : "...",
    "uiHint" : "..."
  } ],
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "label" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

PUT /public/v2/api/servicedef/{id}

Request Parameters
name	type	description	constraints
id	path		long

Request Body
media type	data type
application/json	RangerServiceDef (JSON)

Response Body
media type	data type	description
application/json	RangerServiceDef (JSON)

Example

Request

PUT /public/v2/api/servicedef/{id}
Content-Type: application/json
Accept: application/json

                
{
  "contextEnrichers" : [ {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  }, {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  } ],
  "configs" : [ {
    "itemId" : 12345,
    "type" : "...",
    "defaultValue" : "...",
    "validationMessage" : "...",
    "description" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "rbKeyDescription" : "...",
    "subType" : "...",
    "uiHint" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "name" : "...",
    "validationRegEx" : "..."
  }, {
    "itemId" : 12345,
    "type" : "...",
    "defaultValue" : "...",
    "validationMessage" : "...",
    "description" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "rbKeyDescription" : "...",
    "subType" : "...",
    "uiHint" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "name" : "...",
    "validationRegEx" : "..."
  } ],
  "markerAccessTypes" : [ {
    "category" : "CREATE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  }, {
    "category" : "MANAGE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  } ],
  "enums" : [ {
    "defaultIndex" : 12345,
    "itemId" : 12345,
    "elements" : [ {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    }, {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    } ],
    "name" : "..."
  }, {
    "defaultIndex" : 12345,
    "itemId" : 12345,
    "elements" : [ {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    }, {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    } ],
    "name" : "..."
  } ],
  "policyConditions" : [ {
    "description" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "validationMessage" : "...",
    "evaluator" : "...",
    "label" : "...",
    "uiHint" : "...",
    "rbKeyDescription" : "...",
    "itemId" : 12345,
    "rbKeyValidationMessage" : "...",
    "validationRegEx" : "..."
  }, {
    "description" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "validationMessage" : "...",
    "evaluator" : "...",
    "label" : "...",
    "uiHint" : "...",
    "rbKeyDescription" : "...",
    "itemId" : 12345,
    "rbKeyValidationMessage" : "...",
    "validationRegEx" : "..."
  } ],
  "rowFilterDef" : {
    "resources" : [ {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    }, {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    } ],
    "accessTypes" : [ {
      "category" : "UPDATE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "category" : "DELETE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ]
  },
  "rbKeyDescription" : "...",
  "implClass" : "...",
  "displayName" : "...",
  "name" : "...",
  "rbKeyLabel" : "...",
  "description" : "...",
  "dataMaskDef" : {
    "maskTypes" : [ {
      "rbKeyDescription" : "...",
      "label" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "name" : "...",
      "transformer" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "rbKeyDescription" : "...",
      "label" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "name" : "...",
      "transformer" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "accessTypes" : [ {
      "category" : "CREATE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "category" : "CREATE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "resources" : [ {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    }, {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    } ]
  },
  "accessTypes" : [ {
    "category" : "READ",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  }, {
    "category" : "MANAGE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  } ],
  "resources" : [ {
    "mandatory" : true,
    "rbKeyDescription" : "...",
    "level" : 12345,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "itemId" : 12345,
    "label" : "...",
    "rbKeyLabel" : "...",
    "name" : "...",
    "lookupSupported" : true,
    "matcher" : "...",
    "validationRegEx" : "...",
    "parent" : "...",
    "rbKeyValidationMessage" : "...",
    "excludesSupported" : true,
    "accessTypeRestrictions" : [ "...", "..." ],
    "isValidLeaf" : true,
    "description" : "...",
    "type" : "...",
    "recursiveSupported" : true,
    "validationMessage" : "...",
    "uiHint" : "..."
  }, {
    "mandatory" : true,
    "rbKeyDescription" : "...",
    "level" : 12345,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "itemId" : 12345,
    "label" : "...",
    "rbKeyLabel" : "...",
    "name" : "...",
    "lookupSupported" : true,
    "matcher" : "...",
    "validationRegEx" : "...",
    "parent" : "...",
    "rbKeyValidationMessage" : "...",
    "excludesSupported" : true,
    "accessTypeRestrictions" : [ "...", "..." ],
    "isValidLeaf" : true,
    "description" : "...",
    "type" : "...",
    "recursiveSupported" : true,
    "validationMessage" : "...",
    "uiHint" : "..."
  } ],
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "label" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "contextEnrichers" : [ {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  }, {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  } ],
  "configs" : [ {
    "itemId" : 12345,
    "type" : "...",
    "defaultValue" : "...",
    "validationMessage" : "...",
    "description" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "rbKeyDescription" : "...",
    "subType" : "...",
    "uiHint" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "name" : "...",
    "validationRegEx" : "..."
  }, {
    "itemId" : 12345,
    "type" : "...",
    "defaultValue" : "...",
    "validationMessage" : "...",
    "description" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "rbKeyDescription" : "...",
    "subType" : "...",
    "uiHint" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "name" : "...",
    "validationRegEx" : "..."
  } ],
  "markerAccessTypes" : [ {
    "category" : "DELETE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  }, {
    "category" : "DELETE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  } ],
  "enums" : [ {
    "defaultIndex" : 12345,
    "itemId" : 12345,
    "elements" : [ {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    }, {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    } ],
    "name" : "..."
  }, {
    "defaultIndex" : 12345,
    "itemId" : 12345,
    "elements" : [ {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    }, {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    } ],
    "name" : "..."
  } ],
  "policyConditions" : [ {
    "description" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "validationMessage" : "...",
    "evaluator" : "...",
    "label" : "...",
    "uiHint" : "...",
    "rbKeyDescription" : "...",
    "itemId" : 12345,
    "rbKeyValidationMessage" : "...",
    "validationRegEx" : "..."
  }, {
    "description" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "validationMessage" : "...",
    "evaluator" : "...",
    "label" : "...",
    "uiHint" : "...",
    "rbKeyDescription" : "...",
    "itemId" : 12345,
    "rbKeyValidationMessage" : "...",
    "validationRegEx" : "..."
  } ],
  "rowFilterDef" : {
    "resources" : [ {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    }, {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    } ],
    "accessTypes" : [ {
      "category" : "UPDATE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "category" : "MANAGE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ]
  },
  "rbKeyDescription" : "...",
  "implClass" : "...",
  "displayName" : "...",
  "name" : "...",
  "rbKeyLabel" : "...",
  "description" : "...",
  "dataMaskDef" : {
    "maskTypes" : [ {
      "rbKeyDescription" : "...",
      "label" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "name" : "...",
      "transformer" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "rbKeyDescription" : "...",
      "label" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "name" : "...",
      "transformer" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "accessTypes" : [ {
      "category" : "DELETE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "category" : "MANAGE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "resources" : [ {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    }, {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    } ]
  },
  "accessTypes" : [ {
    "category" : "CREATE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  }, {
    "category" : "UPDATE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  } ],
  "resources" : [ {
    "mandatory" : true,
    "rbKeyDescription" : "...",
    "level" : 12345,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "itemId" : 12345,
    "label" : "...",
    "rbKeyLabel" : "...",
    "name" : "...",
    "lookupSupported" : true,
    "matcher" : "...",
    "validationRegEx" : "...",
    "parent" : "...",
    "rbKeyValidationMessage" : "...",
    "excludesSupported" : true,
    "accessTypeRestrictions" : [ "...", "..." ],
    "isValidLeaf" : true,
    "description" : "...",
    "type" : "...",
    "recursiveSupported" : true,
    "validationMessage" : "...",
    "uiHint" : "..."
  }, {
    "mandatory" : true,
    "rbKeyDescription" : "...",
    "level" : 12345,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "itemId" : 12345,
    "label" : "...",
    "rbKeyLabel" : "...",
    "name" : "...",
    "lookupSupported" : true,
    "matcher" : "...",
    "validationRegEx" : "...",
    "parent" : "...",
    "rbKeyValidationMessage" : "...",
    "excludesSupported" : true,
    "accessTypeRestrictions" : [ "...", "..." ],
    "isValidLeaf" : true,
    "description" : "...",
    "type" : "...",
    "recursiveSupported" : true,
    "validationMessage" : "...",
    "uiHint" : "..."
  } ],
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "label" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

DELETE /public/v2/api/zones/{id}

Request Parameters
name	type	description	constraints
id	path		long

Example

Request

DELETE /public/v2/api/zones/{id}
Content-Type: */*

                
...

Response

HTTP/1.1 204 No Content

GET /public/v2/api/zones/{id}

Request Parameters
name	type	description	constraints
id	path		long

Response Body
media type	data type	description
application/json	RangerSecurityZone (JSON)

Example

Request

GET /public/v2/api/zones/{id}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "adminUserGroups" : [ "...", "..." ],
  "auditUsers" : [ "...", "..." ],
  "adminUsers" : [ "...", "..." ],
  "name" : "...",
  "adminRoles" : [ "...", "..." ],
  "auditRoles" : [ "...", "..." ],
  "tagServices" : [ "...", "..." ],
  "services" : {
    "property1" : {
      "resourcesBaseInfo" : [ {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ],
      "resources" : [ {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      }, {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      } ]
    },
    "property2" : {
      "resourcesBaseInfo" : [ {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ],
      "resources" : [ {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      }, {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      } ]
    }
  },
  "description" : "...",
  "auditUserGroups" : [ "...", "..." ],
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

PUT /public/v2/api/zones/{id}

Request Parameters
name	type	description	constraints
id	path		long

Request Body
media type	data type
application/json	RangerSecurityZone (JSON)

Response Body
media type	data type	description
application/json	RangerSecurityZone (JSON)

Example

Request

PUT /public/v2/api/zones/{id}
Content-Type: application/json
Accept: application/json

                
{
  "adminUserGroups" : [ "...", "..." ],
  "auditUsers" : [ "...", "..." ],
  "adminUsers" : [ "...", "..." ],
  "name" : "...",
  "adminRoles" : [ "...", "..." ],
  "auditRoles" : [ "...", "..." ],
  "tagServices" : [ "...", "..." ],
  "services" : {
    "property1" : {
      "resourcesBaseInfo" : [ {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ],
      "resources" : [ {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      }, {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      } ]
    },
    "property2" : {
      "resourcesBaseInfo" : [ {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ],
      "resources" : [ {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      }, {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      } ]
    }
  },
  "description" : "...",
  "auditUserGroups" : [ "...", "..." ],
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "adminUserGroups" : [ "...", "..." ],
  "auditUsers" : [ "...", "..." ],
  "adminUsers" : [ "...", "..." ],
  "name" : "...",
  "adminRoles" : [ "...", "..." ],
  "auditRoles" : [ "...", "..." ],
  "tagServices" : [ "...", "..." ],
  "services" : {
    "property1" : {
      "resourcesBaseInfo" : [ {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ],
      "resources" : [ {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      }, {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      } ]
    },
    "property2" : {
      "resourcesBaseInfo" : [ {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ],
      "resources" : [ {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      }, {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      } ]
    }
  },
  "description" : "...",
  "auditUserGroups" : [ "...", "..." ],
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

GET /public/v2/api/zones-v2/{id}

Request Parameters
name	type	description	constraints
id	path		long

Response Body
media type	data type	description
application/json	RangerSecurityZoneV2 (JSON)

Example

Request

GET /public/v2/api/zones-v2/{id}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "admins" : [ {
    "type" : "ROLE",
    "name" : "..."
  }, {
    "type" : "GROUP",
    "name" : "..."
  } ],
  "services" : {
    "property1" : {
      "resources" : [ {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ]
    },
    "property2" : {
      "resources" : [ {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ]
    }
  },
  "name" : "...",
  "auditors" : [ {
    "type" : "ROLE",
    "name" : "..."
  }, {
    "type" : "GROUP",
    "name" : "..."
  } ],
  "tagServices" : [ "...", "..." ],
  "description" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

PUT /public/v2/api/zones-v2/{id}

Request Parameters
name	type	description	constraints
id	path		long

Request Body
media type	data type
application/json	RangerSecurityZoneV2 (JSON)

Response Body
media type	data type	description
application/json	RangerSecurityZoneV2 (JSON)

Example

Request

PUT /public/v2/api/zones-v2/{id}
Content-Type: application/json
Accept: application/json

                
{
  "admins" : [ {
    "type" : "USER",
    "name" : "..."
  }, {
    "type" : "USER",
    "name" : "..."
  } ],
  "services" : {
    "property1" : {
      "resources" : [ {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ]
    },
    "property2" : {
      "resources" : [ {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ]
    }
  },
  "name" : "...",
  "auditors" : [ {
    "type" : "ROLE",
    "name" : "..."
  }, {
    "type" : "GROUP",
    "name" : "..."
  } ],
  "tagServices" : [ "...", "..." ],
  "description" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "admins" : [ {
    "type" : "GROUP",
    "name" : "..."
  }, {
    "type" : "ROLE",
    "name" : "..."
  } ],
  "services" : {
    "property1" : {
      "resources" : [ {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ]
    },
    "property2" : {
      "resources" : [ {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ]
    }
  },
  "name" : "...",
  "auditors" : [ {
    "type" : "ROLE",
    "name" : "..."
  }, {
    "type" : "ROLE",
    "name" : "..."
  } ],
  "tagServices" : [ "...", "..." ],
  "description" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

GET /public/v2/api/policies/{serviceDefName}/for-resource

Request Parameters
name	type	description	default
serviceDefName	path
serviceName	query

Response Body
media type	data type	description
application/json	array of RangerPolicy (JSON)

Example

Request

GET /public/v2/api/policies/{serviceDefName}/for-resource
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "policyType" : 12345,
  "serviceType" : "...",
  "policyLabels" : [ "...", "..." ],
  "name" : "...",
  "isAuditEnabled" : true,
  "isDenyAllElse" : true,
  "dataMaskPolicyItems" : [ {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "zoneName" : "...",
  "allowExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "conditions" : [ {
    "type" : "...",
    "values" : [ "...", "..." ]
  }, {
    "type" : "...",
    "values" : [ "...", "..." ]
  } ],
  "policyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "denyExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "policyPriority" : 12345,
  "resources" : {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  },
  "resourceSignature" : "...",
  "service" : "...",
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "rowFilterPolicyItems" : [ {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "validitySchedules" : [ {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  }, {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  } ],
  "additionalResources" : [ {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  }, {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  } ],
  "denyPolicyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
} ]

DELETE /public/v2/api/policy/guid/{guid}

Request Parameters
name	type	description	default
guid	path
serviceName	query
zoneName	query

Example

Request

DELETE /public/v2/api/policy/guid/{guid}
Content-Type: */*

                
...

Response

HTTP/1.1 204 No Content

GET /public/v2/api/policy/guid/{guid}

Request Parameters
name	type	description	default
guid	path
ZoneName	query
serviceName	query

Response Body
media type	data type	description
application/json	RangerPolicy (JSON)

Example

Request

GET /public/v2/api/policy/guid/{guid}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "policyType" : 12345,
  "serviceType" : "...",
  "policyLabels" : [ "...", "..." ],
  "name" : "...",
  "isAuditEnabled" : true,
  "isDenyAllElse" : true,
  "dataMaskPolicyItems" : [ {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "zoneName" : "...",
  "allowExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "conditions" : [ {
    "type" : "...",
    "values" : [ "...", "..." ]
  }, {
    "type" : "...",
    "values" : [ "...", "..." ]
  } ],
  "policyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "denyExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "policyPriority" : 12345,
  "resources" : {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  },
  "resourceSignature" : "...",
  "service" : "...",
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "rowFilterPolicyItems" : [ {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "validitySchedules" : [ {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  }, {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  } ],
  "additionalResources" : [ {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  }, {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  } ],
  "denyPolicyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

PUT /public/v2/api/roles/grant/{serviceName}

Request Parameters
name	type	description
serviceName	path

Request Body
media type	data type
application/json	GrantRevokeRoleRequest (JSON)

Response Body
media type	data type	description
application/json	RESTResponse (JSON)

Example

Request

PUT /public/v2/api/roles/grant/{serviceName}
Content-Type: application/json
Accept: application/json

                
{
  "roles" : [ "...", "..." ],
  "clientType" : "...",
  "clusterName" : "...",
  "grantorGroups" : [ "...", "..." ],
  "clientIPAddress" : "...",
  "grantor" : "...",
  "sessionId" : "...",
  "groups" : [ "...", "..." ],
  "requestData" : "...",
  "targetRoles" : [ "...", "..." ],
  "users" : [ "...", "..." ],
  "grantOption" : true
}

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "msgDesc" : "...",
  "messageList" : [ {
    "name" : "...",
    "message" : "...",
    "rbKey" : "...",
    "fieldName" : "...",
    "objectId" : 12345
  }, {
    "name" : "...",
    "message" : "...",
    "rbKey" : "...",
    "fieldName" : "...",
    "objectId" : 12345
  } ],
  "statusCode" : 12345,
  "httpStatusCode" : 12345
}

DELETE /public/v2/api/roles/name/{name}

Request Parameters
name	type	description
name	path
execUser	query
serviceName	query

Example

Request

DELETE /public/v2/api/roles/name/{name}
Content-Type: */*

                
...

Response

HTTP/1.1 204 No Content

GET /public/v2/api/roles/name/{name}

Request Parameters
name	type	description
name	path
execUser	query
serviceName	query

Response Body
media type	data type	description
application/json	RangerRole (JSON)

Example

Request

GET /public/v2/api/roles/name/{name}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "createdByUser" : "...",
  "name" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

PUT /public/v2/api/roles/revoke/{serviceName}

Request Parameters
name	type	description
serviceName	path

Request Body
media type	data type
application/json	GrantRevokeRoleRequest (JSON)

Response Body
media type	data type	description
application/json	RESTResponse (JSON)

Example

Request

PUT /public/v2/api/roles/revoke/{serviceName}
Content-Type: application/json
Accept: application/json

                
{
  "roles" : [ "...", "..." ],
  "clientType" : "...",
  "clusterName" : "...",
  "grantorGroups" : [ "...", "..." ],
  "clientIPAddress" : "...",
  "grantor" : "...",
  "sessionId" : "...",
  "groups" : [ "...", "..." ],
  "requestData" : "...",
  "targetRoles" : [ "...", "..." ],
  "users" : [ "...", "..." ],
  "grantOption" : true
}

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "msgDesc" : "...",
  "messageList" : [ {
    "name" : "...",
    "message" : "...",
    "rbKey" : "...",
    "fieldName" : "...",
    "objectId" : 12345
  }, {
    "name" : "...",
    "message" : "...",
    "rbKey" : "...",
    "fieldName" : "...",
    "objectId" : 12345
  } ],
  "statusCode" : 12345,
  "httpStatusCode" : 12345
}

GET /public/v2/api/roles/user/{user}

Request Parameters
name	type	description
user	path

Response Body
media type	data type	description
application/json	array of string (JSON)

Example

Request

GET /public/v2/api/roles/user/{user}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
...

PUT /public/v2/api/roles/{id}/addUsersAndGroups

Request Parameters
name	type	description	constraints
id	path		long

Request Body
media type	data type
application/json	boolean (JSON)

Response Body
media type	data type	description
application/json	RangerRole (JSON)

Example

Request

PUT /public/v2/api/roles/{id}/addUsersAndGroups
Content-Type: application/json
Accept: application/json

                
...

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "createdByUser" : "...",
  "name" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

PUT /public/v2/api/roles/{id}/removeAdminFromUsersAndGroups

Request Parameters
name	type	description	constraints
id	path		long

Request Body
media type	data type
application/json	array of string (JSON)

Response Body
media type	data type	description
application/json	RangerRole (JSON)

Example

Request

PUT /public/v2/api/roles/{id}/removeAdminFromUsersAndGroups
Content-Type: application/json
Accept: application/json

                
...

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "createdByUser" : "...",
  "name" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

PUT /public/v2/api/roles/{id}/removeUsersAndGroups

Request Parameters
name	type	description	constraints
id	path		long

Request Body
media type	data type
application/json	array of string (JSON)

Response Body
media type	data type	description
application/json	RangerRole (JSON)

Example

Request

PUT /public/v2/api/roles/{id}/removeUsersAndGroups
Content-Type: application/json
Accept: application/json

                
...

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "createdByUser" : "...",
  "name" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

DELETE /public/v2/api/server/purge/records

Request Parameters
name	type	description	default	constraints
retentionDays	query		180	int
type	query

Response Body
media type	data type	description
application/json	array of RangerPurgeResult (JSON)
application/xml	list of rangerPurgeResult (XML)

Example

Request

DELETE /public/v2/api/server/purge/records
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
[ {
  "totalRecordCount" : 12345,
  "recordType" : "...",
  "purgedRecordCount" : 12345
} ]

DELETE /public/v2/api/server/purgepolicies/{serviceName}

Request Parameters
name	type	description
serviceName	path

Example

Request

DELETE /public/v2/api/server/purgepolicies/{serviceName}
Content-Type: */*

                
...

Response

HTTP/1.1 204 No Content

DELETE /public/v2/api/service/name/{name}

Request Parameters
name	type	description
name	path

Example

Request

DELETE /public/v2/api/service/name/{name}
Content-Type: */*

                
...

Response

HTTP/1.1 204 No Content

GET /public/v2/api/service/name/{name}

Request Parameters
name	type	description
name	path

Response Body
media type	data type	description
application/json	RangerService (JSON)

Example

Request

GET /public/v2/api/service/name/{name}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "tagVersion" : 12345,
  "policyUpdateTime" : 12345,
  "tagService" : "...",
  "policyVersion" : 12345,
  "type" : "...",
  "description" : "...",
  "tagUpdateTime" : 12345,
  "displayName" : "...",
  "name" : "...",
  "configs" : {
    "property1" : "...",
    "property2" : "..."
  },
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

PUT /public/v2/api/service/name/{name}

Request Parameters
name	type	description
name	path

Request Body
media type	data type
application/json	RangerService (JSON)

Response Body
media type	data type	description
application/json	RangerService (JSON)

Example

Request

PUT /public/v2/api/service/name/{name}
Content-Type: application/json
Accept: application/json

                
{
  "tagVersion" : 12345,
  "policyUpdateTime" : 12345,
  "tagService" : "...",
  "policyVersion" : 12345,
  "type" : "...",
  "description" : "...",
  "tagUpdateTime" : 12345,
  "displayName" : "...",
  "name" : "...",
  "configs" : {
    "property1" : "...",
    "property2" : "..."
  },
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "tagVersion" : 12345,
  "policyUpdateTime" : 12345,
  "tagService" : "...",
  "policyVersion" : 12345,
  "type" : "...",
  "description" : "...",
  "tagUpdateTime" : 12345,
  "displayName" : "...",
  "name" : "...",
  "configs" : {
    "property1" : "...",
    "property2" : "..."
  },
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

GET /public/v2/api/service/{serviceName}/tags

Request Parameters
name	type	description
serviceName	path

Response Body
media type	data type	description
application/json	RangerServiceTags (JSON)

Example

Request

GET /public/v2/api/service/{serviceName}/tags
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "op" : "...",
  "resourceToTagIds" : {
    "property1" : [ 12345, 12345 ],
    "property2" : [ 12345, 12345 ]
  },
  "serviceName" : "...",
  "tagDefinitions" : {
    "property1" : {
      "source" : "...",
      "attributeDefs" : [ {
        "type" : "...",
        "name" : "..."
      }, {
        "type" : "...",
        "name" : "..."
      } ],
      "name" : "...",
      "createdBy" : "...",
      "createTime" : 12345,
      "id" : 12345,
      "version" : 12345,
      "isEnabled" : true,
      "guid" : "...",
      "updateTime" : 12345,
      "updatedBy" : "..."
    },
    "property2" : {
      "source" : "...",
      "attributeDefs" : [ {
        "type" : "...",
        "name" : "..."
      }, {
        "type" : "...",
        "name" : "..."
      } ],
      "name" : "...",
      "createdBy" : "...",
      "createTime" : 12345,
      "id" : 12345,
      "version" : 12345,
      "isEnabled" : true,
      "guid" : "...",
      "updateTime" : 12345,
      "updatedBy" : "..."
    }
  },
  "tags" : {
    "property1" : {
      "options" : {
        "property1" : { },
        "property2" : { }
      },
      "owner" : 12345,
      "validityPeriods" : [ {
        "timeZone" : "...",
        "recurrences" : [ { }, { } ],
        "startTime" : "...",
        "endTime" : "..."
      }, {
        "timeZone" : "...",
        "recurrences" : [ { }, { } ],
        "startTime" : "...",
        "endTime" : "..."
      } ],
      "type" : "...",
      "attributes" : {
        "property1" : "...",
        "property2" : "..."
      },
      "createdBy" : "...",
      "createTime" : 12345,
      "id" : 12345,
      "version" : 12345,
      "isEnabled" : true,
      "guid" : "...",
      "updateTime" : 12345,
      "updatedBy" : "..."
    },
    "property2" : {
      "options" : {
        "property1" : { },
        "property2" : { }
      },
      "owner" : 12345,
      "validityPeriods" : [ {
        "timeZone" : "...",
        "recurrences" : [ { }, { } ],
        "startTime" : "...",
        "endTime" : "..."
      }, {
        "timeZone" : "...",
        "recurrences" : [ { }, { } ],
        "startTime" : "...",
        "endTime" : "..."
      } ],
      "type" : "...",
      "attributes" : {
        "property1" : "...",
        "property2" : "..."
      },
      "createdBy" : "...",
      "createTime" : 12345,
      "id" : 12345,
      "version" : 12345,
      "isEnabled" : true,
      "guid" : "...",
      "updateTime" : 12345,
      "updatedBy" : "..."
    }
  },
  "tagVersion" : 12345,
  "serviceResources" : [ {
    "resourceElements" : {
      "property1" : {
        "isRecursive" : true,
        "values" : [ "...", "..." ],
        "isExcludes" : true
      },
      "property2" : {
        "isRecursive" : true,
        "values" : [ "...", "..." ],
        "isExcludes" : true
      }
    },
    "resourceSignature" : "...",
    "serviceName" : "...",
    "additionalInfo" : {
      "property1" : "...",
      "property2" : "..."
    },
    "ownerUser" : "...",
    "createdBy" : "...",
    "createTime" : 12345,
    "id" : 12345,
    "version" : 12345,
    "isEnabled" : true,
    "guid" : "...",
    "updateTime" : 12345,
    "updatedBy" : "..."
  }, {
    "resourceElements" : {
      "property1" : {
        "isRecursive" : true,
        "values" : [ "...", "..." ],
        "isExcludes" : true
      },
      "property2" : {
        "isRecursive" : true,
        "values" : [ "...", "..." ],
        "isExcludes" : true
      }
    },
    "resourceSignature" : "...",
    "serviceName" : "...",
    "additionalInfo" : {
      "property1" : "...",
      "property2" : "..."
    },
    "ownerUser" : "...",
    "createdBy" : "...",
    "createTime" : 12345,
    "id" : 12345,
    "version" : 12345,
    "isEnabled" : true,
    "guid" : "...",
    "updateTime" : 12345,
    "updatedBy" : "..."
  } ],
  "tagUpdateTime" : 12345
}

PUT /public/v2/api/service/{serviceName}/tags

Request Parameters
name	type	description
serviceName	path

Request Body
media type	data type
application/json	RangerServiceTags (JSON)

Example

Request

PUT /public/v2/api/service/{serviceName}/tags
Content-Type: application/json

                
{
  "op" : "...",
  "resourceToTagIds" : {
    "property1" : [ 12345, 12345 ],
    "property2" : [ 12345, 12345 ]
  },
  "serviceName" : "...",
  "tagDefinitions" : {
    "property1" : {
      "source" : "...",
      "attributeDefs" : [ {
        "type" : "...",
        "name" : "..."
      }, {
        "type" : "...",
        "name" : "..."
      } ],
      "name" : "...",
      "createdBy" : "...",
      "createTime" : 12345,
      "id" : 12345,
      "version" : 12345,
      "isEnabled" : true,
      "guid" : "...",
      "updateTime" : 12345,
      "updatedBy" : "..."
    },
    "property2" : {
      "source" : "...",
      "attributeDefs" : [ {
        "type" : "...",
        "name" : "..."
      }, {
        "type" : "...",
        "name" : "..."
      } ],
      "name" : "...",
      "createdBy" : "...",
      "createTime" : 12345,
      "id" : 12345,
      "version" : 12345,
      "isEnabled" : true,
      "guid" : "...",
      "updateTime" : 12345,
      "updatedBy" : "..."
    }
  },
  "tags" : {
    "property1" : {
      "options" : {
        "property1" : { },
        "property2" : { }
      },
      "owner" : 12345,
      "validityPeriods" : [ {
        "timeZone" : "...",
        "recurrences" : [ { }, { } ],
        "startTime" : "...",
        "endTime" : "..."
      }, {
        "timeZone" : "...",
        "recurrences" : [ { }, { } ],
        "startTime" : "...",
        "endTime" : "..."
      } ],
      "type" : "...",
      "attributes" : {
        "property1" : "...",
        "property2" : "..."
      },
      "createdBy" : "...",
      "createTime" : 12345,
      "id" : 12345,
      "version" : 12345,
      "isEnabled" : true,
      "guid" : "...",
      "updateTime" : 12345,
      "updatedBy" : "..."
    },
    "property2" : {
      "options" : {
        "property1" : { },
        "property2" : { }
      },
      "owner" : 12345,
      "validityPeriods" : [ {
        "timeZone" : "...",
        "recurrences" : [ { }, { } ],
        "startTime" : "...",
        "endTime" : "..."
      }, {
        "timeZone" : "...",
        "recurrences" : [ { }, { } ],
        "startTime" : "...",
        "endTime" : "..."
      } ],
      "type" : "...",
      "attributes" : {
        "property1" : "...",
        "property2" : "..."
      },
      "createdBy" : "...",
      "createTime" : 12345,
      "id" : 12345,
      "version" : 12345,
      "isEnabled" : true,
      "guid" : "...",
      "updateTime" : 12345,
      "updatedBy" : "..."
    }
  },
  "tagVersion" : 12345,
  "serviceResources" : [ {
    "resourceElements" : {
      "property1" : {
        "isRecursive" : true,
        "values" : [ "...", "..." ],
        "isExcludes" : true
      },
      "property2" : {
        "isRecursive" : true,
        "values" : [ "...", "..." ],
        "isExcludes" : true
      }
    },
    "resourceSignature" : "...",
    "serviceName" : "...",
    "additionalInfo" : {
      "property1" : "...",
      "property2" : "..."
    },
    "ownerUser" : "...",
    "createdBy" : "...",
    "createTime" : 12345,
    "id" : 12345,
    "version" : 12345,
    "isEnabled" : true,
    "guid" : "...",
    "updateTime" : 12345,
    "updatedBy" : "..."
  }, {
    "resourceElements" : {
      "property1" : {
        "isRecursive" : true,
        "values" : [ "...", "..." ],
        "isExcludes" : true
      },
      "property2" : {
        "isRecursive" : true,
        "values" : [ "...", "..." ],
        "isExcludes" : true
      }
    },
    "resourceSignature" : "...",
    "serviceName" : "...",
    "additionalInfo" : {
      "property1" : "...",
      "property2" : "..."
    },
    "ownerUser" : "...",
    "createdBy" : "...",
    "createTime" : 12345,
    "id" : 12345,
    "version" : 12345,
    "isEnabled" : true,
    "guid" : "...",
    "updateTime" : 12345,
    "updatedBy" : "..."
  } ],
  "tagUpdateTime" : 12345
}

Response

HTTP/1.1 204 No Content

GET /public/v2/api/service/{servicename}/policy

Request Parameters
name	type	description
servicename	path

Response Body
media type	data type	description
application/json	array of RangerPolicy (JSON)

Example

Request

GET /public/v2/api/service/{servicename}/policy
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "policyType" : 12345,
  "serviceType" : "...",
  "policyLabels" : [ "...", "..." ],
  "name" : "...",
  "isAuditEnabled" : true,
  "isDenyAllElse" : true,
  "dataMaskPolicyItems" : [ {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "zoneName" : "...",
  "allowExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "conditions" : [ {
    "type" : "...",
    "values" : [ "...", "..." ]
  }, {
    "type" : "...",
    "values" : [ "...", "..." ]
  } ],
  "policyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "denyExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "policyPriority" : 12345,
  "resources" : {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  },
  "resourceSignature" : "...",
  "service" : "...",
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "rowFilterPolicyItems" : [ {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "validitySchedules" : [ {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  }, {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  } ],
  "additionalResources" : [ {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  }, {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  } ],
  "denyPolicyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
} ]

DELETE /public/v2/api/servicedef/name/{name}

Request Parameters
name	type	description
name	path

Example

Request

DELETE /public/v2/api/servicedef/name/{name}
Content-Type: */*

                
...

Response

HTTP/1.1 204 No Content

GET /public/v2/api/servicedef/name/{name}

Request Parameters
name	type	description
name	path

Response Body
media type	data type	description
application/json	RangerServiceDef (JSON)

Example

Request

GET /public/v2/api/servicedef/name/{name}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "contextEnrichers" : [ {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  }, {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  } ],
  "configs" : [ {
    "itemId" : 12345,
    "type" : "...",
    "defaultValue" : "...",
    "validationMessage" : "...",
    "description" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "rbKeyDescription" : "...",
    "subType" : "...",
    "uiHint" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "name" : "...",
    "validationRegEx" : "..."
  }, {
    "itemId" : 12345,
    "type" : "...",
    "defaultValue" : "...",
    "validationMessage" : "...",
    "description" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "rbKeyDescription" : "...",
    "subType" : "...",
    "uiHint" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "name" : "...",
    "validationRegEx" : "..."
  } ],
  "markerAccessTypes" : [ {
    "category" : "DELETE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  }, {
    "category" : "DELETE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  } ],
  "enums" : [ {
    "defaultIndex" : 12345,
    "itemId" : 12345,
    "elements" : [ {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    }, {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    } ],
    "name" : "..."
  }, {
    "defaultIndex" : 12345,
    "itemId" : 12345,
    "elements" : [ {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    }, {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    } ],
    "name" : "..."
  } ],
  "policyConditions" : [ {
    "description" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "validationMessage" : "...",
    "evaluator" : "...",
    "label" : "...",
    "uiHint" : "...",
    "rbKeyDescription" : "...",
    "itemId" : 12345,
    "rbKeyValidationMessage" : "...",
    "validationRegEx" : "..."
  }, {
    "description" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "validationMessage" : "...",
    "evaluator" : "...",
    "label" : "...",
    "uiHint" : "...",
    "rbKeyDescription" : "...",
    "itemId" : 12345,
    "rbKeyValidationMessage" : "...",
    "validationRegEx" : "..."
  } ],
  "rowFilterDef" : {
    "resources" : [ {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    }, {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    } ],
    "accessTypes" : [ {
      "category" : "MANAGE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "category" : "CREATE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ]
  },
  "rbKeyDescription" : "...",
  "implClass" : "...",
  "displayName" : "...",
  "name" : "...",
  "rbKeyLabel" : "...",
  "description" : "...",
  "dataMaskDef" : {
    "maskTypes" : [ {
      "rbKeyDescription" : "...",
      "label" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "name" : "...",
      "transformer" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "rbKeyDescription" : "...",
      "label" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "name" : "...",
      "transformer" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "accessTypes" : [ {
      "category" : "MANAGE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "category" : "READ",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "resources" : [ {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    }, {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    } ]
  },
  "accessTypes" : [ {
    "category" : "READ",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  }, {
    "category" : "UPDATE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  } ],
  "resources" : [ {
    "mandatory" : true,
    "rbKeyDescription" : "...",
    "level" : 12345,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "itemId" : 12345,
    "label" : "...",
    "rbKeyLabel" : "...",
    "name" : "...",
    "lookupSupported" : true,
    "matcher" : "...",
    "validationRegEx" : "...",
    "parent" : "...",
    "rbKeyValidationMessage" : "...",
    "excludesSupported" : true,
    "accessTypeRestrictions" : [ "...", "..." ],
    "isValidLeaf" : true,
    "description" : "...",
    "type" : "...",
    "recursiveSupported" : true,
    "validationMessage" : "...",
    "uiHint" : "..."
  }, {
    "mandatory" : true,
    "rbKeyDescription" : "...",
    "level" : 12345,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "itemId" : 12345,
    "label" : "...",
    "rbKeyLabel" : "...",
    "name" : "...",
    "lookupSupported" : true,
    "matcher" : "...",
    "validationRegEx" : "...",
    "parent" : "...",
    "rbKeyValidationMessage" : "...",
    "excludesSupported" : true,
    "accessTypeRestrictions" : [ "...", "..." ],
    "isValidLeaf" : true,
    "description" : "...",
    "type" : "...",
    "recursiveSupported" : true,
    "validationMessage" : "...",
    "uiHint" : "..."
  } ],
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "label" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

PUT /public/v2/api/servicedef/name/{name}

Request Parameters
name	type	description
name	path

Request Body
media type	data type
application/json	RangerServiceDef (JSON)

Response Body
media type	data type	description
application/json	RangerServiceDef (JSON)

Example

Request

PUT /public/v2/api/servicedef/name/{name}
Content-Type: application/json
Accept: application/json

                
{
  "contextEnrichers" : [ {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  }, {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  } ],
  "configs" : [ {
    "itemId" : 12345,
    "type" : "...",
    "defaultValue" : "...",
    "validationMessage" : "...",
    "description" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "rbKeyDescription" : "...",
    "subType" : "...",
    "uiHint" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "name" : "...",
    "validationRegEx" : "..."
  }, {
    "itemId" : 12345,
    "type" : "...",
    "defaultValue" : "...",
    "validationMessage" : "...",
    "description" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "rbKeyDescription" : "...",
    "subType" : "...",
    "uiHint" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "name" : "...",
    "validationRegEx" : "..."
  } ],
  "markerAccessTypes" : [ {
    "category" : "UPDATE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  }, {
    "category" : "CREATE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  } ],
  "enums" : [ {
    "defaultIndex" : 12345,
    "itemId" : 12345,
    "elements" : [ {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    }, {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    } ],
    "name" : "..."
  }, {
    "defaultIndex" : 12345,
    "itemId" : 12345,
    "elements" : [ {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    }, {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    } ],
    "name" : "..."
  } ],
  "policyConditions" : [ {
    "description" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "validationMessage" : "...",
    "evaluator" : "...",
    "label" : "...",
    "uiHint" : "...",
    "rbKeyDescription" : "...",
    "itemId" : 12345,
    "rbKeyValidationMessage" : "...",
    "validationRegEx" : "..."
  }, {
    "description" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "validationMessage" : "...",
    "evaluator" : "...",
    "label" : "...",
    "uiHint" : "...",
    "rbKeyDescription" : "...",
    "itemId" : 12345,
    "rbKeyValidationMessage" : "...",
    "validationRegEx" : "..."
  } ],
  "rowFilterDef" : {
    "resources" : [ {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    }, {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    } ],
    "accessTypes" : [ {
      "category" : "UPDATE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "category" : "DELETE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ]
  },
  "rbKeyDescription" : "...",
  "implClass" : "...",
  "displayName" : "...",
  "name" : "...",
  "rbKeyLabel" : "...",
  "description" : "...",
  "dataMaskDef" : {
    "maskTypes" : [ {
      "rbKeyDescription" : "...",
      "label" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "name" : "...",
      "transformer" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "rbKeyDescription" : "...",
      "label" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "name" : "...",
      "transformer" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "accessTypes" : [ {
      "category" : "READ",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "category" : "READ",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "resources" : [ {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    }, {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    } ]
  },
  "accessTypes" : [ {
    "category" : "MANAGE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  }, {
    "category" : "DELETE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  } ],
  "resources" : [ {
    "mandatory" : true,
    "rbKeyDescription" : "...",
    "level" : 12345,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "itemId" : 12345,
    "label" : "...",
    "rbKeyLabel" : "...",
    "name" : "...",
    "lookupSupported" : true,
    "matcher" : "...",
    "validationRegEx" : "...",
    "parent" : "...",
    "rbKeyValidationMessage" : "...",
    "excludesSupported" : true,
    "accessTypeRestrictions" : [ "...", "..." ],
    "isValidLeaf" : true,
    "description" : "...",
    "type" : "...",
    "recursiveSupported" : true,
    "validationMessage" : "...",
    "uiHint" : "..."
  }, {
    "mandatory" : true,
    "rbKeyDescription" : "...",
    "level" : 12345,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "itemId" : 12345,
    "label" : "...",
    "rbKeyLabel" : "...",
    "name" : "...",
    "lookupSupported" : true,
    "matcher" : "...",
    "validationRegEx" : "...",
    "parent" : "...",
    "rbKeyValidationMessage" : "...",
    "excludesSupported" : true,
    "accessTypeRestrictions" : [ "...", "..." ],
    "isValidLeaf" : true,
    "description" : "...",
    "type" : "...",
    "recursiveSupported" : true,
    "validationMessage" : "...",
    "uiHint" : "..."
  } ],
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "label" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "contextEnrichers" : [ {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  }, {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  } ],
  "configs" : [ {
    "itemId" : 12345,
    "type" : "...",
    "defaultValue" : "...",
    "validationMessage" : "...",
    "description" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "rbKeyDescription" : "...",
    "subType" : "...",
    "uiHint" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "name" : "...",
    "validationRegEx" : "..."
  }, {
    "itemId" : 12345,
    "type" : "...",
    "defaultValue" : "...",
    "validationMessage" : "...",
    "description" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "rbKeyDescription" : "...",
    "subType" : "...",
    "uiHint" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "name" : "...",
    "validationRegEx" : "..."
  } ],
  "markerAccessTypes" : [ {
    "category" : "MANAGE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  }, {
    "category" : "READ",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  } ],
  "enums" : [ {
    "defaultIndex" : 12345,
    "itemId" : 12345,
    "elements" : [ {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    }, {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    } ],
    "name" : "..."
  }, {
    "defaultIndex" : 12345,
    "itemId" : 12345,
    "elements" : [ {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    }, {
      "rbKeyLabel" : "...",
      "itemId" : 12345,
      "label" : "...",
      "name" : "..."
    } ],
    "name" : "..."
  } ],
  "policyConditions" : [ {
    "description" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "validationMessage" : "...",
    "evaluator" : "...",
    "label" : "...",
    "uiHint" : "...",
    "rbKeyDescription" : "...",
    "itemId" : 12345,
    "rbKeyValidationMessage" : "...",
    "validationRegEx" : "..."
  }, {
    "description" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "validationMessage" : "...",
    "evaluator" : "...",
    "label" : "...",
    "uiHint" : "...",
    "rbKeyDescription" : "...",
    "itemId" : 12345,
    "rbKeyValidationMessage" : "...",
    "validationRegEx" : "..."
  } ],
  "rowFilterDef" : {
    "resources" : [ {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    }, {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    } ],
    "accessTypes" : [ {
      "category" : "READ",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "category" : "UPDATE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ]
  },
  "rbKeyDescription" : "...",
  "implClass" : "...",
  "displayName" : "...",
  "name" : "...",
  "rbKeyLabel" : "...",
  "description" : "...",
  "dataMaskDef" : {
    "maskTypes" : [ {
      "rbKeyDescription" : "...",
      "label" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "name" : "...",
      "transformer" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "rbKeyDescription" : "...",
      "label" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "name" : "...",
      "transformer" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "accessTypes" : [ {
      "category" : "CREATE",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "category" : "READ",
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "resources" : [ {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    }, {
      "mandatory" : true,
      "rbKeyDescription" : "...",
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "...",
      "lookupSupported" : true,
      "matcher" : "...",
      "validationRegEx" : "...",
      "parent" : "...",
      "rbKeyValidationMessage" : "...",
      "excludesSupported" : true,
      "accessTypeRestrictions" : [ "...", "..." ],
      "isValidLeaf" : true,
      "description" : "...",
      "type" : "...",
      "recursiveSupported" : true,
      "validationMessage" : "...",
      "uiHint" : "..."
    } ]
  },
  "accessTypes" : [ {
    "category" : "CREATE",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  }, {
    "category" : "READ",
    "label" : "...",
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  } ],
  "resources" : [ {
    "mandatory" : true,
    "rbKeyDescription" : "...",
    "level" : 12345,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "itemId" : 12345,
    "label" : "...",
    "rbKeyLabel" : "...",
    "name" : "...",
    "lookupSupported" : true,
    "matcher" : "...",
    "validationRegEx" : "...",
    "parent" : "...",
    "rbKeyValidationMessage" : "...",
    "excludesSupported" : true,
    "accessTypeRestrictions" : [ "...", "..." ],
    "isValidLeaf" : true,
    "description" : "...",
    "type" : "...",
    "recursiveSupported" : true,
    "validationMessage" : "...",
    "uiHint" : "..."
  }, {
    "mandatory" : true,
    "rbKeyDescription" : "...",
    "level" : 12345,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "itemId" : 12345,
    "label" : "...",
    "rbKeyLabel" : "...",
    "name" : "...",
    "lookupSupported" : true,
    "matcher" : "...",
    "validationRegEx" : "...",
    "parent" : "...",
    "rbKeyValidationMessage" : "...",
    "excludesSupported" : true,
    "accessTypeRestrictions" : [ "...", "..." ],
    "isValidLeaf" : true,
    "description" : "...",
    "type" : "...",
    "recursiveSupported" : true,
    "validationMessage" : "...",
    "uiHint" : "..."
  } ],
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "label" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

GET /public/v2/api/zone-names/{serviceName}/resource

Request Parameters
name	type	description
serviceName	path

Response Body
media type	data type	description
application/json	array of string (JSON)

Example

Request

GET /public/v2/api/zone-names/{serviceName}/resource
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
...

DELETE /public/v2/api/zones/name/{name}

Request Parameters
name	type	description
name	path

Example

Request

DELETE /public/v2/api/zones/name/{name}
Content-Type: */*

                
...

Response

HTTP/1.1 204 No Content

GET /public/v2/api/zones/name/{name}

Request Parameters
name	type	description
name	path

Response Body
media type	data type	description
application/json	RangerSecurityZone (JSON)

Example

Request

GET /public/v2/api/zones/name/{name}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "adminUserGroups" : [ "...", "..." ],
  "auditUsers" : [ "...", "..." ],
  "adminUsers" : [ "...", "..." ],
  "name" : "...",
  "adminRoles" : [ "...", "..." ],
  "auditRoles" : [ "...", "..." ],
  "tagServices" : [ "...", "..." ],
  "services" : {
    "property1" : {
      "resourcesBaseInfo" : [ {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ],
      "resources" : [ {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      }, {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      } ]
    },
    "property2" : {
      "resourcesBaseInfo" : [ {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ],
      "resources" : [ {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      }, {
        "property1" : [ "...", "..." ],
        "property2" : [ "...", "..." ]
      } ]
    }
  },
  "description" : "...",
  "auditUserGroups" : [ "...", "..." ],
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

GET /public/v2/api/zones/{zoneId}/service-headers

Get service header info List for given zone. This API is authorized to every authenticated user.

Request Parameters
name	type	description	constraints
zoneId	path		long

Response Body
media type	data type	description
application/json	array of RangerServiceHeaderInfo (JSON)	List of RangerServiceHeaderInfo for given zone if present.

Example

Request

GET /public/v2/api/zones/{zoneId}/service-headers
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "isTagService" : true,
  "isGdsService" : true,
  "name" : "...",
  "type" : "...",
  "displayName" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
} ]

GET /public/v2/api/zones-v2/name/{name}

Request Parameters
name	type	description
name	path

Response Body
media type	data type	description
application/json	RangerSecurityZoneV2 (JSON)

Example

Request

GET /public/v2/api/zones-v2/name/{name}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "admins" : [ {
    "type" : "USER",
    "name" : "..."
  }, {
    "type" : "USER",
    "name" : "..."
  } ],
  "services" : {
    "property1" : {
      "resources" : [ {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ]
    },
    "property2" : {
      "resources" : [ {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ]
    }
  },
  "name" : "...",
  "auditors" : [ {
    "type" : "GROUP",
    "name" : "..."
  }, {
    "type" : "USER",
    "name" : "..."
  } ],
  "tagServices" : [ "...", "..." ],
  "description" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

PUT /public/v2/api/zones-v2/{id}/partial

Request Parameters
name	type	description	constraints
id	path		long

Request Body
media type	data type
application/json	RangerSecurityZoneChangeRequest (JSON)

Response Body
media type	data type	description
application/json	boolean (JSON)

Example

Request

PUT /public/v2/api/zones-v2/{id}/partial
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "resourcesToUpdate" : {
    "property1" : {
      "resources" : [ {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ]
    },
    "property2" : {
      "resources" : [ {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ]
    }
  },
  "tagServicesToAdd" : [ "...", "..." ],
  "adminsToRemove" : [ {
    "type" : "ROLE",
    "name" : "..."
  }, {
    "type" : "USER",
    "name" : "..."
  } ],
  "tagServicesToRemove" : [ "...", "..." ],
  "description" : "...",
  "auditorsToRemove" : [ {
    "type" : "ROLE",
    "name" : "..."
  }, {
    "type" : "ROLE",
    "name" : "..."
  } ],
  "adminsToAdd" : [ {
    "type" : "GROUP",
    "name" : "..."
  }, {
    "type" : "ROLE",
    "name" : "..."
  } ],
  "auditorsToAdd" : [ {
    "type" : "USER",
    "name" : "..."
  }, {
    "type" : "GROUP",
    "name" : "..."
  } ],
  "resourcesToRemove" : {
    "property1" : {
      "resources" : [ {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ]
    },
    "property2" : {
      "resources" : [ {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      }, {
        "resource" : {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        },
        "id" : 12345,
        "createTime" : 12345,
        "updateTime" : 12345,
        "updatedBy" : "...",
        "createdBy" : "..."
      } ]
    }
  }
}

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
...

GET /public/v2/api/service/{servicename}/policy/{policyname}

Request Parameters
name	type	description
policyname	path
servicename	path
zoneName	query

Response Body
media type	data type	description
application/json	RangerPolicy (JSON)

Example

Request

GET /public/v2/api/service/{servicename}/policy/{policyname}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "policyType" : 12345,
  "serviceType" : "...",
  "policyLabels" : [ "...", "..." ],
  "name" : "...",
  "isAuditEnabled" : true,
  "isDenyAllElse" : true,
  "dataMaskPolicyItems" : [ {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "zoneName" : "...",
  "allowExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "conditions" : [ {
    "type" : "...",
    "values" : [ "...", "..." ]
  }, {
    "type" : "...",
    "values" : [ "...", "..." ]
  } ],
  "policyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "denyExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "policyPriority" : 12345,
  "resources" : {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  },
  "resourceSignature" : "...",
  "service" : "...",
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "rowFilterPolicyItems" : [ {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "validitySchedules" : [ {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  }, {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  } ],
  "additionalResources" : [ {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  }, {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  } ],
  "denyPolicyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

PUT /public/v2/api/service/{servicename}/policy/{policyname}

Request Parameters
name	type	description
policyname	path
servicename	path
zoneName	query

Request Body
media type	data type
application/json	RangerPolicy (JSON)

Response Body
media type	data type	description
application/json	RangerPolicy (JSON)

Example

Request

PUT /public/v2/api/service/{servicename}/policy/{policyname}
Content-Type: application/json
Accept: application/json

                
{
  "policyType" : 12345,
  "serviceType" : "...",
  "policyLabels" : [ "...", "..." ],
  "name" : "...",
  "isAuditEnabled" : true,
  "isDenyAllElse" : true,
  "dataMaskPolicyItems" : [ {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "zoneName" : "...",
  "allowExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "conditions" : [ {
    "type" : "...",
    "values" : [ "...", "..." ]
  }, {
    "type" : "...",
    "values" : [ "...", "..." ]
  } ],
  "policyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "denyExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "policyPriority" : 12345,
  "resources" : {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  },
  "resourceSignature" : "...",
  "service" : "...",
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "rowFilterPolicyItems" : [ {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "validitySchedules" : [ {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  }, {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  } ],
  "additionalResources" : [ {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  }, {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  } ],
  "denyPolicyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "policyType" : 12345,
  "serviceType" : "...",
  "policyLabels" : [ "...", "..." ],
  "name" : "...",
  "isAuditEnabled" : true,
  "isDenyAllElse" : true,
  "dataMaskPolicyItems" : [ {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "dataMaskInfo" : {
      "dataMaskType" : "...",
      "valueExpr" : "...",
      "conditionExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "zoneName" : "...",
  "allowExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "conditions" : [ {
    "type" : "...",
    "values" : [ "...", "..." ]
  }, {
    "type" : "...",
    "values" : [ "...", "..." ]
  } ],
  "policyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "denyExceptions" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "policyPriority" : 12345,
  "resources" : {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  },
  "resourceSignature" : "...",
  "service" : "...",
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "rowFilterPolicyItems" : [ {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "rowFilterInfo" : {
      "filterExpr" : "..."
    },
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "validitySchedules" : [ {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  }, {
    "timeZone" : "...",
    "recurrences" : [ {
      "interval" : { },
      "schedule" : { }
    }, {
      "interval" : { },
      "schedule" : { }
    } ],
    "startTime" : "...",
    "endTime" : "..."
  } ],
  "additionalResources" : [ {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  }, {
    "property1" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    },
    "property2" : {
      "isRecursive" : true,
      "values" : [ "...", "..." ],
      "isExcludes" : true
    }
  } ],
  "denyPolicyItems" : [ {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  }, {
    "roles" : [ "...", "..." ],
    "users" : [ "...", "..." ],
    "delegateAdmin" : true,
    "accesses" : [ {
      "type" : "...",
      "isAllowed" : true
    }, {
      "type" : "...",
      "isAllowed" : true
    } ],
    "groups" : [ "...", "..." ],
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ]
  } ],
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
}

GET /public/v2/api/zones/zone-headers/for-service/{serviceId}

Get List of security zone header info. This API is authorized to every authenticated user.

Request Parameters
name	type	description	default	constraints
serviceId	path			long
isTagService	query		false	boolean

Response Body
media type	data type	description
application/json	array of RangerSecurityZoneHeaderInfo (JSON)	List of RangerSecurityZoneHeaderInfo if present.

Example

Request

GET /public/v2/api/zones/zone-headers/for-service/{serviceId}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "name" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
} ]

GET /public/v2/api/zones-v2/{id}/resources/{serviceName}

Request Parameters
name	type	description	constraints
id	path		long
serviceName	path

Response Body
media type	data type	description
application/json	PListOfRangerSecurityZoneResource (JSON)

Example

Request

GET /public/v2/api/zones-v2/{id}/resources/{serviceName}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "queryTimeMS" : 12345,
  "startIndex" : 12345,
  "resultSize" : 12345,
  "totalCount" : 12345,
  "pageSize" : 12345,
  "sortBy" : "...",
  "list" : [ {
    "resource" : {
      "property1" : [ "...", "..." ],
      "property2" : [ "...", "..." ]
    },
    "id" : 12345,
    "createTime" : 12345,
    "updateTime" : 12345,
    "updatedBy" : "...",
    "createdBy" : "..."
  }, {
    "resource" : {
      "property1" : [ "...", "..." ],
      "property2" : [ "...", "..." ]
    },
    "id" : 12345,
    "createTime" : 12345,
    "updateTime" : 12345,
    "updatedBy" : "...",
    "createdBy" : "..."
  } ],
  "listSize" : 12345,
  "sortType" : "..."
}

GET /public/v2/api/zones-v2/name/{name}/resources/{serviceName}

Request Parameters
name	type	description
name	path
serviceName	path

Response Body
media type	data type	description
application/json	PListOfRangerSecurityZoneResource (JSON)

Example

Request

GET /public/v2/api/zones-v2/name/{name}/resources/{serviceName}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "queryTimeMS" : 12345,
  "startIndex" : 12345,
  "resultSize" : 12345,
  "totalCount" : 12345,
  "pageSize" : 12345,
  "sortBy" : "...",
  "list" : [ {
    "resource" : {
      "property1" : [ "...", "..." ],
      "property2" : [ "...", "..." ]
    },
    "id" : 12345,
    "createTime" : 12345,
    "updateTime" : 12345,
    "updatedBy" : "...",
    "createdBy" : "..."
  }, {
    "resource" : {
      "property1" : [ "...", "..." ],
      "property2" : [ "...", "..." ]
    },
    "id" : 12345,
    "createTime" : 12345,
    "updateTime" : 12345,
    "updatedBy" : "...",
    "createdBy" : "..."
  } ],
  "listSize" : 12345,
  "sortType" : "..."
}

PublicAPIsv2 Resource

DELETE /public/v2/api/policy

Example

Request

Response

GET /public/v2/api/policy

Example

Request

Response

POST /public/v2/api/policy

Example

Request

Response

GET /public/v2/api/roles

Example

Request

Response

POST /public/v2/api/roles

Example

Request

Response

GET /public/v2/api/service

Example

Request

Response

POST /public/v2/api/service

Example

Request

Response

GET /public/v2/api/service-headers

Example

Request

Response

GET /public/v2/api/servicedef

Example

Request

Response

POST /public/v2/api/servicedef

Example

Request

Response

GET /public/v2/api/zone-headers

Example

Request

Response

GET /public/v2/api/zones

Example

Request

Response

POST /public/v2/api/zones

Example

Request

Response

GET /public/v2/api/zones-v2

Example

Request

Response

POST /public/v2/api/zones-v2

Example

Request

Response

GET /public/v2/api/plugins/info

Example

Request

Response

DELETE /public/v2/api/policies/bulk

Example

Request

Response

POST /public/v2/api/policy/apply

Example

Request

Response

DELETE /public/v2/api/policy/{id}

Example

Request

Response

GET /public/v2/api/policy/{id}

Example

Request