PublicAPIsv2 Resource

DELETE /public/v2/api/policy

Request Parameters
name type description
policyname query
servicename 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)
application/xml list of rangerPolicy (XML)

Example

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

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

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

POST /public/v2/api/policy

Request Body
media type data type
application/json RangerPolicy (JSON)
application/xml rangerPolicy (XML)
Response Body
media type data type description
application/json RangerPolicy (JSON)
application/xml rangerPolicy (XML)

Example

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

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

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

GET /public/v2/api/roles

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

Example

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

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

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

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)
application/xml rangerRole (XML)
Response Body
media type data type description
application/json RangerRole (JSON)
application/xml rangerRole (XML)

Example

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

                
{
  "createdByUser" : "...",
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "name" : "...",
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

GET /public/v2/api/service

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

Example

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

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

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

POST /public/v2/api/service

Request Body
media type data type
application/json RangerService (JSON)
application/xml rangerService (XML)
Response Body
media type data type description
application/json RangerService (JSON)
application/xml rangerService (XML)

Example

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

                
{
  "policyUpdateTime" : 12345,
  "description" : "...",
  "name" : "...",
  "type" : "...",
  "configs" : {
    "property1" : "...",
    "property2" : "..."
  },
  "tagVersion" : 12345,
  "tagUpdateTime" : 12345,
  "displayName" : "...",
  "policyVersion" : 12345,
  "tagService" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

GET /public/v2/api/servicedef

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

Example

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

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

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

POST /public/v2/api/servicedef

Request Body
media type data type
application/json RangerServiceDef (JSON)
application/xml rangerServiceDef (XML)
Response Body
media type data type description
application/json RangerServiceDef (JSON)
application/xml rangerServiceDef (XML)

Example

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

                
{
  "accessTypes" : [ {
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "label" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  }, {
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "label" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  } ],
  "label" : "...",
  "rbKeyLabel" : "...",
  "dataMaskDef" : {
    "maskTypes" : [ {
      "itemId" : 12345,
      "rbKeyDescription" : "...",
      "rbKeyLabel" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "transformer" : "...",
      "name" : "...",
      "label" : "..."
    }, {
      "itemId" : 12345,
      "rbKeyDescription" : "...",
      "rbKeyLabel" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "transformer" : "...",
      "name" : "...",
      "label" : "..."
    } ],
    "accessTypes" : [ {
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "label" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "label" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "resources" : [ {
      "recursiveSupported" : true,
      "label" : "...",
      "excludesSupported" : true,
      "parent" : "...",
      "matcher" : "...",
      "type" : "...",
      "accessTypeRestrictions" : [ "...", "..." ],
      "lookupSupported" : true,
      "isValidLeaf" : true,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "name" : "...",
      "rbKeyLabel" : "...",
      "mandatory" : true,
      "validationMessage" : "...",
      "level" : 12345,
      "itemId" : 12345,
      "uiHint" : "...",
      "rbKeyValidationMessage" : "...",
      "description" : "...",
      "validationRegEx" : "...",
      "rbKeyDescription" : "..."
    }, {
      "recursiveSupported" : true,
      "label" : "...",
      "excludesSupported" : true,
      "parent" : "...",
      "matcher" : "...",
      "type" : "...",
      "accessTypeRestrictions" : [ "...", "..." ],
      "lookupSupported" : true,
      "isValidLeaf" : true,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "name" : "...",
      "rbKeyLabel" : "...",
      "mandatory" : true,
      "validationMessage" : "...",
      "level" : 12345,
      "itemId" : 12345,
      "uiHint" : "...",
      "rbKeyValidationMessage" : "...",
      "description" : "...",
      "validationRegEx" : "...",
      "rbKeyDescription" : "..."
    } ]
  },
  "resources" : [ {
    "recursiveSupported" : true,
    "label" : "...",
    "excludesSupported" : true,
    "parent" : "...",
    "matcher" : "...",
    "type" : "...",
    "accessTypeRestrictions" : [ "...", "..." ],
    "lookupSupported" : true,
    "isValidLeaf" : true,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "validationMessage" : "...",
    "level" : 12345,
    "itemId" : 12345,
    "uiHint" : "...",
    "rbKeyValidationMessage" : "...",
    "description" : "...",
    "validationRegEx" : "...",
    "rbKeyDescription" : "..."
  }, {
    "recursiveSupported" : true,
    "label" : "...",
    "excludesSupported" : true,
    "parent" : "...",
    "matcher" : "...",
    "type" : "...",
    "accessTypeRestrictions" : [ "...", "..." ],
    "lookupSupported" : true,
    "isValidLeaf" : true,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "validationMessage" : "...",
    "level" : 12345,
    "itemId" : 12345,
    "uiHint" : "...",
    "rbKeyValidationMessage" : "...",
    "description" : "...",
    "validationRegEx" : "...",
    "rbKeyDescription" : "..."
  } ],
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "rowFilterDef" : {
    "accessTypes" : [ {
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "label" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "label" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "resources" : [ {
      "recursiveSupported" : true,
      "label" : "...",
      "excludesSupported" : true,
      "parent" : "...",
      "matcher" : "...",
      "type" : "...",
      "accessTypeRestrictions" : [ "...", "..." ],
      "lookupSupported" : true,
      "isValidLeaf" : true,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "name" : "...",
      "rbKeyLabel" : "...",
      "mandatory" : true,
      "validationMessage" : "...",
      "level" : 12345,
      "itemId" : 12345,
      "uiHint" : "...",
      "rbKeyValidationMessage" : "...",
      "description" : "...",
      "validationRegEx" : "...",
      "rbKeyDescription" : "..."
    }, {
      "recursiveSupported" : true,
      "label" : "...",
      "excludesSupported" : true,
      "parent" : "...",
      "matcher" : "...",
      "type" : "...",
      "accessTypeRestrictions" : [ "...", "..." ],
      "lookupSupported" : true,
      "isValidLeaf" : true,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "name" : "...",
      "rbKeyLabel" : "...",
      "mandatory" : true,
      "validationMessage" : "...",
      "level" : 12345,
      "itemId" : 12345,
      "uiHint" : "...",
      "rbKeyValidationMessage" : "...",
      "description" : "...",
      "validationRegEx" : "...",
      "rbKeyDescription" : "..."
    } ]
  },
  "description" : "...",
  "policyConditions" : [ {
    "uiHint" : "...",
    "description" : "...",
    "itemId" : 12345,
    "name" : "...",
    "validationRegEx" : "...",
    "label" : "...",
    "rbKeyLabel" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "validationMessage" : "...",
    "evaluator" : "...",
    "rbKeyValidationMessage" : "...",
    "rbKeyDescription" : "..."
  }, {
    "uiHint" : "...",
    "description" : "...",
    "itemId" : 12345,
    "name" : "...",
    "validationRegEx" : "...",
    "label" : "...",
    "rbKeyLabel" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "validationMessage" : "...",
    "evaluator" : "...",
    "rbKeyValidationMessage" : "...",
    "rbKeyDescription" : "..."
  } ],
  "implClass" : "...",
  "displayName" : "...",
  "name" : "...",
  "contextEnrichers" : [ {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  }, {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  } ],
  "enums" : [ {
    "name" : "...",
    "defaultIndex" : 12345,
    "elements" : [ {
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "..."
    }, {
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "..."
    } ],
    "itemId" : 12345
  }, {
    "name" : "...",
    "defaultIndex" : 12345,
    "elements" : [ {
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "..."
    }, {
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "..."
    } ],
    "itemId" : 12345
  } ],
  "rbKeyDescription" : "...",
  "configs" : [ {
    "rbKeyDescription" : "...",
    "subType" : "...",
    "rbKeyLabel" : "...",
    "defaultValue" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "name" : "...",
    "description" : "...",
    "itemId" : 12345,
    "mandatory" : true,
    "validationRegEx" : "...",
    "validationMessage" : "...",
    "type" : "...",
    "uiHint" : "..."
  }, {
    "rbKeyDescription" : "...",
    "subType" : "...",
    "rbKeyLabel" : "...",
    "defaultValue" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "name" : "...",
    "description" : "...",
    "itemId" : 12345,
    "mandatory" : true,
    "validationRegEx" : "...",
    "validationMessage" : "...",
    "type" : "...",
    "uiHint" : "..."
  } ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

GET /public/v2/api/zones

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

Example

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

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

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

POST /public/v2/api/zones

Request Body
media type data type
application/json RangerSecurityZone (JSON)
application/xml rangerSecurityZone (XML)
Response Body
media type data type description
application/json RangerSecurityZone (JSON)
application/xml rangerSecurityZone (XML)

Example

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

                
{
  "tagServices" : [ "...", "..." ],
  "description" : "...",
  "auditUsers" : [ "...", "..." ],
  "adminUserGroups" : [ "...", "..." ],
  "adminUsers" : [ "...", "..." ],
  "name" : "...",
  "services" : {
    "property1" : {
      "resources" : [ {
        "property1" : [ ],
        "property2" : [ ]
      }, {
        "property1" : [ ],
        "property2" : [ ]
      } ]
    },
    "property2" : {
      "resources" : [ {
        "property1" : [ ],
        "property2" : [ ]
      }, {
        "property1" : [ ],
        "property2" : [ ]
      } ]
    }
  },
  "auditUserGroups" : [ "...", "..." ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

GET /public/v2/api/plugins/info

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

Example

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

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

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

POST /public/v2/api/policy/apply

Request Body
media type data type
application/json RangerPolicy (JSON)
application/xml rangerPolicy (XML)
Response Body
media type data type description
application/json RangerPolicy (JSON)
application/xml rangerPolicy (XML)

Example

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

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

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

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)
application/xml rangerPolicy (XML)

Example

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

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

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

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)
application/xml rangerPolicy (XML)
Response Body
media type data type description
application/json RangerPolicy (JSON)
application/xml rangerPolicy (XML)

Example

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

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

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

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)
application/xml list of string (XML)

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)
application/xml rangerRole (XML)

Example

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

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

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

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)
application/xml rangerRole (XML)
Response Body
media type data type description
application/json RangerRole (JSON)
application/xml rangerRole (XML)

Example

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

                
{
  "createdByUser" : "...",
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "name" : "...",
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

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

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)
application/xml rangerService (XML)

Example

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

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

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

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)
application/xml rangerService (XML)
Response Body
media type data type description
application/json RangerService (JSON)
application/xml rangerService (XML)

Example

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

                
{
  "policyUpdateTime" : 12345,
  "description" : "...",
  "name" : "...",
  "type" : "...",
  "configs" : {
    "property1" : "...",
    "property2" : "..."
  },
  "tagVersion" : 12345,
  "tagUpdateTime" : 12345,
  "displayName" : "...",
  "policyVersion" : 12345,
  "tagService" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

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

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)
application/xml rangerServiceDef (XML)

Example

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

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

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

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)
application/xml rangerServiceDef (XML)
Response Body
media type data type description
application/json RangerServiceDef (JSON)
application/xml rangerServiceDef (XML)

Example

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

                
{
  "accessTypes" : [ {
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "label" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  }, {
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "label" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  } ],
  "label" : "...",
  "rbKeyLabel" : "...",
  "dataMaskDef" : {
    "maskTypes" : [ {
      "itemId" : 12345,
      "rbKeyDescription" : "...",
      "rbKeyLabel" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "transformer" : "...",
      "name" : "...",
      "label" : "..."
    }, {
      "itemId" : 12345,
      "rbKeyDescription" : "...",
      "rbKeyLabel" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "transformer" : "...",
      "name" : "...",
      "label" : "..."
    } ],
    "accessTypes" : [ {
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "label" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "label" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "resources" : [ {
      "recursiveSupported" : true,
      "label" : "...",
      "excludesSupported" : true,
      "parent" : "...",
      "matcher" : "...",
      "type" : "...",
      "accessTypeRestrictions" : [ "...", "..." ],
      "lookupSupported" : true,
      "isValidLeaf" : true,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "name" : "...",
      "rbKeyLabel" : "...",
      "mandatory" : true,
      "validationMessage" : "...",
      "level" : 12345,
      "itemId" : 12345,
      "uiHint" : "...",
      "rbKeyValidationMessage" : "...",
      "description" : "...",
      "validationRegEx" : "...",
      "rbKeyDescription" : "..."
    }, {
      "recursiveSupported" : true,
      "label" : "...",
      "excludesSupported" : true,
      "parent" : "...",
      "matcher" : "...",
      "type" : "...",
      "accessTypeRestrictions" : [ "...", "..." ],
      "lookupSupported" : true,
      "isValidLeaf" : true,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "name" : "...",
      "rbKeyLabel" : "...",
      "mandatory" : true,
      "validationMessage" : "...",
      "level" : 12345,
      "itemId" : 12345,
      "uiHint" : "...",
      "rbKeyValidationMessage" : "...",
      "description" : "...",
      "validationRegEx" : "...",
      "rbKeyDescription" : "..."
    } ]
  },
  "resources" : [ {
    "recursiveSupported" : true,
    "label" : "...",
    "excludesSupported" : true,
    "parent" : "...",
    "matcher" : "...",
    "type" : "...",
    "accessTypeRestrictions" : [ "...", "..." ],
    "lookupSupported" : true,
    "isValidLeaf" : true,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "validationMessage" : "...",
    "level" : 12345,
    "itemId" : 12345,
    "uiHint" : "...",
    "rbKeyValidationMessage" : "...",
    "description" : "...",
    "validationRegEx" : "...",
    "rbKeyDescription" : "..."
  }, {
    "recursiveSupported" : true,
    "label" : "...",
    "excludesSupported" : true,
    "parent" : "...",
    "matcher" : "...",
    "type" : "...",
    "accessTypeRestrictions" : [ "...", "..." ],
    "lookupSupported" : true,
    "isValidLeaf" : true,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "validationMessage" : "...",
    "level" : 12345,
    "itemId" : 12345,
    "uiHint" : "...",
    "rbKeyValidationMessage" : "...",
    "description" : "...",
    "validationRegEx" : "...",
    "rbKeyDescription" : "..."
  } ],
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "rowFilterDef" : {
    "accessTypes" : [ {
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "label" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "label" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "resources" : [ {
      "recursiveSupported" : true,
      "label" : "...",
      "excludesSupported" : true,
      "parent" : "...",
      "matcher" : "...",
      "type" : "...",
      "accessTypeRestrictions" : [ "...", "..." ],
      "lookupSupported" : true,
      "isValidLeaf" : true,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "name" : "...",
      "rbKeyLabel" : "...",
      "mandatory" : true,
      "validationMessage" : "...",
      "level" : 12345,
      "itemId" : 12345,
      "uiHint" : "...",
      "rbKeyValidationMessage" : "...",
      "description" : "...",
      "validationRegEx" : "...",
      "rbKeyDescription" : "..."
    }, {
      "recursiveSupported" : true,
      "label" : "...",
      "excludesSupported" : true,
      "parent" : "...",
      "matcher" : "...",
      "type" : "...",
      "accessTypeRestrictions" : [ "...", "..." ],
      "lookupSupported" : true,
      "isValidLeaf" : true,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "name" : "...",
      "rbKeyLabel" : "...",
      "mandatory" : true,
      "validationMessage" : "...",
      "level" : 12345,
      "itemId" : 12345,
      "uiHint" : "...",
      "rbKeyValidationMessage" : "...",
      "description" : "...",
      "validationRegEx" : "...",
      "rbKeyDescription" : "..."
    } ]
  },
  "description" : "...",
  "policyConditions" : [ {
    "uiHint" : "...",
    "description" : "...",
    "itemId" : 12345,
    "name" : "...",
    "validationRegEx" : "...",
    "label" : "...",
    "rbKeyLabel" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "validationMessage" : "...",
    "evaluator" : "...",
    "rbKeyValidationMessage" : "...",
    "rbKeyDescription" : "..."
  }, {
    "uiHint" : "...",
    "description" : "...",
    "itemId" : 12345,
    "name" : "...",
    "validationRegEx" : "...",
    "label" : "...",
    "rbKeyLabel" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "validationMessage" : "...",
    "evaluator" : "...",
    "rbKeyValidationMessage" : "...",
    "rbKeyDescription" : "..."
  } ],
  "implClass" : "...",
  "displayName" : "...",
  "name" : "...",
  "contextEnrichers" : [ {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  }, {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  } ],
  "enums" : [ {
    "name" : "...",
    "defaultIndex" : 12345,
    "elements" : [ {
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "..."
    }, {
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "..."
    } ],
    "itemId" : 12345
  }, {
    "name" : "...",
    "defaultIndex" : 12345,
    "elements" : [ {
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "..."
    }, {
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "..."
    } ],
    "itemId" : 12345
  } ],
  "rbKeyDescription" : "...",
  "configs" : [ {
    "rbKeyDescription" : "...",
    "subType" : "...",
    "rbKeyLabel" : "...",
    "defaultValue" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "name" : "...",
    "description" : "...",
    "itemId" : 12345,
    "mandatory" : true,
    "validationRegEx" : "...",
    "validationMessage" : "...",
    "type" : "...",
    "uiHint" : "..."
  }, {
    "rbKeyDescription" : "...",
    "subType" : "...",
    "rbKeyLabel" : "...",
    "defaultValue" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "name" : "...",
    "description" : "...",
    "itemId" : 12345,
    "mandatory" : true,
    "validationRegEx" : "...",
    "validationMessage" : "...",
    "type" : "...",
    "uiHint" : "..."
  } ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

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

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)
application/xml rangerSecurityZone (XML)

Example

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

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

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

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)
application/xml rangerSecurityZone (XML)
Response Body
media type data type description
application/json RangerSecurityZone (JSON)
application/xml rangerSecurityZone (XML)

Example

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

                
{
  "tagServices" : [ "...", "..." ],
  "description" : "...",
  "auditUsers" : [ "...", "..." ],
  "adminUserGroups" : [ "...", "..." ],
  "adminUsers" : [ "...", "..." ],
  "name" : "...",
  "services" : {
    "property1" : {
      "resources" : [ {
        "property1" : [ ],
        "property2" : [ ]
      }, {
        "property1" : [ ],
        "property2" : [ ]
      } ]
    },
    "property2" : {
      "resources" : [ {
        "property1" : [ ],
        "property2" : [ ]
      }, {
        "property1" : [ ],
        "property2" : [ ]
      } ]
    }
  },
  "auditUserGroups" : [ "...", "..." ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

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

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)
application/xml list of rangerPolicy (XML)

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

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

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

Request Parameters
name type description
serviceName path
Request Body
media type data type
application/json GrantRevokeRoleRequest (JSON)
application/xml grantRevokeRoleRequest (XML)
Response Body
media type data type description
application/json RESTResponse (JSON)
application/xml RESTResponse (XML)

Example

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

                
{
  "users" : [ "...", "..." ],
  "requestData" : "...",
  "grantorGroups" : [ "...", "..." ],
  "clientType" : "...",
  "targetRoles" : [ "...", "..." ],
  "clusterName" : "...",
  "grantOption" : true,
  "clientIPAddress" : "...",
  "sessionId" : "...",
  "grantor" : "...",
  "groups" : [ "...", "..." ],
  "roles" : [ "...", "..." ]
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "message" : "...",
  "msgDesc" : "...",
  "httpStatusCode" : 12345,
  "messageList" : [ {
    "fieldName" : "...",
    "objectId" : 12345,
    "rbKey" : "...",
    "message" : "...",
    "name" : "..."
  }, {
    "fieldName" : "...",
    "objectId" : 12345,
    "rbKey" : "...",
    "message" : "...",
    "name" : "..."
  } ],
  "statusCode" : 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)
application/xml rangerRole (XML)

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" : "...",
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "name" : "...",
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

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

Request Parameters
name type description
serviceName path
Request Body
media type data type
application/json GrantRevokeRoleRequest (JSON)
application/xml grantRevokeRoleRequest (XML)
Response Body
media type data type description
application/json RESTResponse (JSON)
application/xml RESTResponse (XML)

Example

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

                
{
  "users" : [ "...", "..." ],
  "requestData" : "...",
  "grantorGroups" : [ "...", "..." ],
  "clientType" : "...",
  "targetRoles" : [ "...", "..." ],
  "clusterName" : "...",
  "grantOption" : true,
  "clientIPAddress" : "...",
  "sessionId" : "...",
  "grantor" : "...",
  "groups" : [ "...", "..." ],
  "roles" : [ "...", "..." ]
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "message" : "...",
  "msgDesc" : "...",
  "httpStatusCode" : 12345,
  "messageList" : [ {
    "fieldName" : "...",
    "objectId" : 12345,
    "rbKey" : "...",
    "message" : "...",
    "name" : "..."
  }, {
    "fieldName" : "...",
    "objectId" : 12345,
    "rbKey" : "...",
    "message" : "...",
    "name" : "..."
  } ],
  "statusCode" : 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)
application/xml list of string (XML)

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)
application/xml boolean (XML)
Response Body
media type data type description
application/json RangerRole (JSON)
application/xml rangerRole (XML)

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" : "...",
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "name" : "...",
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

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)
application/xml list of string (XML)
Response Body
media type data type description
application/json RangerRole (JSON)
application/xml rangerRole (XML)

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" : "...",
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "name" : "...",
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

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)
application/xml list of string (XML)
Response Body
media type data type description
application/json RangerRole (JSON)
application/xml rangerRole (XML)

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" : "...",
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "name" : "...",
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "description" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              

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)
application/xml rangerService (XML)

Example

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

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

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

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

Request Parameters
name type description
name path
Request Body
media type data type
application/json RangerService (JSON)
application/xml rangerService (XML)
Response Body
media type data type description
application/json RangerService (JSON)
application/xml rangerService (XML)

Example

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

                
{
  "policyUpdateTime" : 12345,
  "description" : "...",
  "name" : "...",
  "type" : "...",
  "configs" : {
    "property1" : "...",
    "property2" : "..."
  },
  "tagVersion" : 12345,
  "tagUpdateTime" : 12345,
  "displayName" : "...",
  "policyVersion" : 12345,
  "tagService" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

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

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)
application/xml list of rangerPolicy (XML)

Example

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

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

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

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)
application/xml rangerServiceDef (XML)

Example

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

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

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

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

Request Parameters
name type description
name path
Request Body
media type data type
application/json RangerServiceDef (JSON)
application/xml rangerServiceDef (XML)
Response Body
media type data type description
application/json RangerServiceDef (JSON)
application/xml rangerServiceDef (XML)

Example

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

                
{
  "accessTypes" : [ {
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "label" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  }, {
    "impliedGrants" : [ "...", "..." ],
    "name" : "...",
    "label" : "...",
    "itemId" : 12345,
    "rbKeyLabel" : "..."
  } ],
  "label" : "...",
  "rbKeyLabel" : "...",
  "dataMaskDef" : {
    "maskTypes" : [ {
      "itemId" : 12345,
      "rbKeyDescription" : "...",
      "rbKeyLabel" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "transformer" : "...",
      "name" : "...",
      "label" : "..."
    }, {
      "itemId" : 12345,
      "rbKeyDescription" : "...",
      "rbKeyLabel" : "...",
      "dataMaskOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "description" : "...",
      "transformer" : "...",
      "name" : "...",
      "label" : "..."
    } ],
    "accessTypes" : [ {
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "label" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "label" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "resources" : [ {
      "recursiveSupported" : true,
      "label" : "...",
      "excludesSupported" : true,
      "parent" : "...",
      "matcher" : "...",
      "type" : "...",
      "accessTypeRestrictions" : [ "...", "..." ],
      "lookupSupported" : true,
      "isValidLeaf" : true,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "name" : "...",
      "rbKeyLabel" : "...",
      "mandatory" : true,
      "validationMessage" : "...",
      "level" : 12345,
      "itemId" : 12345,
      "uiHint" : "...",
      "rbKeyValidationMessage" : "...",
      "description" : "...",
      "validationRegEx" : "...",
      "rbKeyDescription" : "..."
    }, {
      "recursiveSupported" : true,
      "label" : "...",
      "excludesSupported" : true,
      "parent" : "...",
      "matcher" : "...",
      "type" : "...",
      "accessTypeRestrictions" : [ "...", "..." ],
      "lookupSupported" : true,
      "isValidLeaf" : true,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "name" : "...",
      "rbKeyLabel" : "...",
      "mandatory" : true,
      "validationMessage" : "...",
      "level" : 12345,
      "itemId" : 12345,
      "uiHint" : "...",
      "rbKeyValidationMessage" : "...",
      "description" : "...",
      "validationRegEx" : "...",
      "rbKeyDescription" : "..."
    } ]
  },
  "resources" : [ {
    "recursiveSupported" : true,
    "label" : "...",
    "excludesSupported" : true,
    "parent" : "...",
    "matcher" : "...",
    "type" : "...",
    "accessTypeRestrictions" : [ "...", "..." ],
    "lookupSupported" : true,
    "isValidLeaf" : true,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "validationMessage" : "...",
    "level" : 12345,
    "itemId" : 12345,
    "uiHint" : "...",
    "rbKeyValidationMessage" : "...",
    "description" : "...",
    "validationRegEx" : "...",
    "rbKeyDescription" : "..."
  }, {
    "recursiveSupported" : true,
    "label" : "...",
    "excludesSupported" : true,
    "parent" : "...",
    "matcher" : "...",
    "type" : "...",
    "accessTypeRestrictions" : [ "...", "..." ],
    "lookupSupported" : true,
    "isValidLeaf" : true,
    "matcherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "rbKeyLabel" : "...",
    "mandatory" : true,
    "validationMessage" : "...",
    "level" : 12345,
    "itemId" : 12345,
    "uiHint" : "...",
    "rbKeyValidationMessage" : "...",
    "description" : "...",
    "validationRegEx" : "...",
    "rbKeyDescription" : "..."
  } ],
  "options" : {
    "property1" : "...",
    "property2" : "..."
  },
  "rowFilterDef" : {
    "accessTypes" : [ {
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "label" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    }, {
      "impliedGrants" : [ "...", "..." ],
      "name" : "...",
      "label" : "...",
      "itemId" : 12345,
      "rbKeyLabel" : "..."
    } ],
    "resources" : [ {
      "recursiveSupported" : true,
      "label" : "...",
      "excludesSupported" : true,
      "parent" : "...",
      "matcher" : "...",
      "type" : "...",
      "accessTypeRestrictions" : [ "...", "..." ],
      "lookupSupported" : true,
      "isValidLeaf" : true,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "name" : "...",
      "rbKeyLabel" : "...",
      "mandatory" : true,
      "validationMessage" : "...",
      "level" : 12345,
      "itemId" : 12345,
      "uiHint" : "...",
      "rbKeyValidationMessage" : "...",
      "description" : "...",
      "validationRegEx" : "...",
      "rbKeyDescription" : "..."
    }, {
      "recursiveSupported" : true,
      "label" : "...",
      "excludesSupported" : true,
      "parent" : "...",
      "matcher" : "...",
      "type" : "...",
      "accessTypeRestrictions" : [ "...", "..." ],
      "lookupSupported" : true,
      "isValidLeaf" : true,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "name" : "...",
      "rbKeyLabel" : "...",
      "mandatory" : true,
      "validationMessage" : "...",
      "level" : 12345,
      "itemId" : 12345,
      "uiHint" : "...",
      "rbKeyValidationMessage" : "...",
      "description" : "...",
      "validationRegEx" : "...",
      "rbKeyDescription" : "..."
    } ]
  },
  "description" : "...",
  "policyConditions" : [ {
    "uiHint" : "...",
    "description" : "...",
    "itemId" : 12345,
    "name" : "...",
    "validationRegEx" : "...",
    "label" : "...",
    "rbKeyLabel" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "validationMessage" : "...",
    "evaluator" : "...",
    "rbKeyValidationMessage" : "...",
    "rbKeyDescription" : "..."
  }, {
    "uiHint" : "...",
    "description" : "...",
    "itemId" : 12345,
    "name" : "...",
    "validationRegEx" : "...",
    "label" : "...",
    "rbKeyLabel" : "...",
    "evaluatorOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "validationMessage" : "...",
    "evaluator" : "...",
    "rbKeyValidationMessage" : "...",
    "rbKeyDescription" : "..."
  } ],
  "implClass" : "...",
  "displayName" : "...",
  "name" : "...",
  "contextEnrichers" : [ {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  }, {
    "name" : "...",
    "itemId" : 12345,
    "enricherOptions" : {
      "property1" : "...",
      "property2" : "..."
    },
    "enricher" : "..."
  } ],
  "enums" : [ {
    "name" : "...",
    "defaultIndex" : 12345,
    "elements" : [ {
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "..."
    }, {
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "..."
    } ],
    "itemId" : 12345
  }, {
    "name" : "...",
    "defaultIndex" : 12345,
    "elements" : [ {
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "..."
    }, {
      "itemId" : 12345,
      "label" : "...",
      "rbKeyLabel" : "...",
      "name" : "..."
    } ],
    "itemId" : 12345
  } ],
  "rbKeyDescription" : "...",
  "configs" : [ {
    "rbKeyDescription" : "...",
    "subType" : "...",
    "rbKeyLabel" : "...",
    "defaultValue" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "name" : "...",
    "description" : "...",
    "itemId" : 12345,
    "mandatory" : true,
    "validationRegEx" : "...",
    "validationMessage" : "...",
    "type" : "...",
    "uiHint" : "..."
  }, {
    "rbKeyDescription" : "...",
    "subType" : "...",
    "rbKeyLabel" : "...",
    "defaultValue" : "...",
    "rbKeyValidationMessage" : "...",
    "label" : "...",
    "name" : "...",
    "description" : "...",
    "itemId" : 12345,
    "mandatory" : true,
    "validationRegEx" : "...",
    "validationMessage" : "...",
    "type" : "...",
    "uiHint" : "..."
  } ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

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

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)
application/xml rangerSecurityZone (XML)

Example

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

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

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

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

Request Parameters
name type description
policyname path
servicename path
Response Body
media type data type description
application/json RangerPolicy (JSON)
application/xml rangerPolicy (XML)

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

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

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

Request Parameters
name type description
policyname path
servicename path
Request Body
media type data type
application/json RangerPolicy (JSON)
application/xml rangerPolicy (XML)
Response Body
media type data type description
application/json RangerPolicy (JSON)
application/xml rangerPolicy (XML)

Example

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

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

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