ServiceREST Resource

GET /plugins/checksso

Response Body
media type data type description
text/plain (custom)

Example

Request
GET /plugins/checksso
Content-Type: */*
Accept: text/plain

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: text/plain

                
...
                
              

GET /plugins/csrfconf

Response Body
media type data type description
application/json map of object (JSON)

Example

Request
GET /plugins/csrfconf
Content-Type: */*
Accept: application/json

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

                
...
                
              

GET /plugins/definitions

Response Body
media type data type description
application/json RangerServiceDefList (JSON)
application/xml rangerServiceDefList (XML)

Example

Request
GET /plugins/definitions
Content-Type: */*
Accept: application/json

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

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

POST /plugins/definitions

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 /plugins/definitions
Content-Type: application/json
Accept: application/json

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

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

GET /plugins/policies

Response Body
media type data type description
application/json RangerPolicyList (JSON)
application/xml rangerPolicyList (XML)

Example

Request
GET /plugins/policies
Content-Type: */*
Accept: application/json

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

                
{
  "policies" : [ {
    "policyItems" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "allowExceptions" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "service" : "...",
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ],
    "resourceSignature" : "...",
    "policyLabels" : [ "...", "..." ],
    "name" : "...",
    "options" : {
      "property1" : { },
      "property2" : { }
    },
    "rowFilterPolicyItems" : [ {
      "rowFilterInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "rowFilterInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "resources" : {
      "property1" : {
        "isExcludes" : true,
        "values" : [ "...", "..." ],
        "isRecursive" : true
      },
      "property2" : {
        "isExcludes" : true,
        "values" : [ "...", "..." ],
        "isRecursive" : true
      }
    },
    "isDenyAllElse" : true,
    "isAuditEnabled" : true,
    "validitySchedules" : [ {
      "recurrences" : [ { }, { } ],
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "recurrences" : [ { }, { } ],
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "denyExceptions" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "policyType" : 12345,
    "zoneName" : "...",
    "dataMaskPolicyItems" : [ {
      "dataMaskInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "dataMaskInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "denyPolicyItems" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "policyPriority" : 12345,
    "description" : "...",
    "serviceType" : "...",
    "createTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "updateTime" : 12345,
    "id" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "isEnabled" : true
  }, {
    "policyItems" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "allowExceptions" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "service" : "...",
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ],
    "resourceSignature" : "...",
    "policyLabels" : [ "...", "..." ],
    "name" : "...",
    "options" : {
      "property1" : { },
      "property2" : { }
    },
    "rowFilterPolicyItems" : [ {
      "rowFilterInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "rowFilterInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "resources" : {
      "property1" : {
        "isExcludes" : true,
        "values" : [ "...", "..." ],
        "isRecursive" : true
      },
      "property2" : {
        "isExcludes" : true,
        "values" : [ "...", "..." ],
        "isRecursive" : true
      }
    },
    "isDenyAllElse" : true,
    "isAuditEnabled" : true,
    "validitySchedules" : [ {
      "recurrences" : [ { }, { } ],
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "recurrences" : [ { }, { } ],
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "denyExceptions" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "policyType" : 12345,
    "zoneName" : "...",
    "dataMaskPolicyItems" : [ {
      "dataMaskInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "dataMaskInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "denyPolicyItems" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "policyPriority" : 12345,
    "description" : "...",
    "serviceType" : "...",
    "createTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "updateTime" : 12345,
    "id" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "isEnabled" : true
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}
                
              

POST /plugins/policies

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 /plugins/policies
Content-Type: application/json
Accept: application/json

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

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

GET /plugins/policyLabels

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

Example

Request
GET /plugins/policyLabels
Content-Type: */*
Accept: application/json

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

                
...
                
              

GET /plugins/services

Response Body
media type data type description
application/json RangerServiceList (JSON)
application/xml rangerServiceList (XML)

Example

Request
GET /plugins/services
Content-Type: */*
Accept: application/json

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

                
{
  "services" : [ {
    "tagVersion" : 12345,
    "policyVersion" : 12345,
    "configs" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "type" : "...",
    "policyUpdateTime" : 12345,
    "description" : "...",
    "tagUpdateTime" : 12345,
    "tagService" : "...",
    "createTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "updateTime" : 12345,
    "id" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "isEnabled" : true
  }, {
    "tagVersion" : 12345,
    "policyVersion" : 12345,
    "configs" : {
      "property1" : "...",
      "property2" : "..."
    },
    "name" : "...",
    "type" : "...",
    "policyUpdateTime" : 12345,
    "description" : "...",
    "tagUpdateTime" : 12345,
    "tagService" : "...",
    "createTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "updateTime" : 12345,
    "id" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "isEnabled" : true
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}
                
              

POST /plugins/services

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 /plugins/services
Content-Type: application/json
Accept: application/json

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

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

DELETE /plugins/definitions/{id}

Request Parameters
name type description constraints
id path long

Example

Request
DELETE /plugins/definitions/{id}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /plugins/definitions/{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 /plugins/definitions/{id}
Content-Type: */*
Accept: application/json

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

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

PUT /plugins/definitions/{id}

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 /plugins/definitions/{id}
Content-Type: application/json
Accept: application/json

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

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

GET /plugins/plugins/info

Response Body
media type data type description
application/json RangerPluginInfoList (JSON)
application/xml rangerPluginInfoList (XML)

Example

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

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

                
{
  "pluginInfoList" : [ {
    "serviceName" : "...",
    "appType" : "...",
    "createTime" : 12345,
    "serviceType" : "...",
    "ipAddress" : "...",
    "hostName" : "...",
    "id" : 12345,
    "updateTime" : 12345,
    "info" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "serviceName" : "...",
    "appType" : "...",
    "createTime" : 12345,
    "serviceType" : "...",
    "ipAddress" : "...",
    "hostName" : "...",
    "id" : 12345,
    "updateTime" : 12345,
    "info" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}
                
              

POST /plugins/policies/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 /plugins/policies/apply
Content-Type: application/json
Accept: application/json

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

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

GET /plugins/policies/count

Response Body
media type data type description
application/json number (JSON)
application/xml long (XML)

Example

Request
GET /plugins/policies/count
Content-Type: */*
Accept: application/json

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

                
...
                
              

GET /plugins/policies/csv

Example

Request
GET /plugins/policies/csv
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 200 OK

              

GET /plugins/policies/downloadExcel

Example

Request
GET /plugins/policies/downloadExcel
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 200 OK

              

GET /plugins/policies/eventTime

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

Example

Request
GET /plugins/policies/eventTime
Content-Type: */*
Accept: application/json

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

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

GET /plugins/policies/exportJson

Request Parameters
name type description constraints
checkPoliciesExists query boolean

Example

Request
GET /plugins/policies/exportJson
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 200 OK

              

POST /plugins/policies/importPoliciesFromFile

Request Parameters
name type description constraints
fileDetail formdata  
serviceMapStream formdata  
uploadedInputStream formdata  
zoneMapStream formdata  
importType query  
isOverride query boolean
Request Body
media type data type
application/json (custom)
multipart/form-data (custom)

Example

Request
POST /plugins/policies/importPoliciesFromFile
Content-Type: application/json

                
...
                
              
Response
HTTP/1.1 201 Created

              

DELETE /plugins/policies/{id}

Request Parameters
name type description constraints
id path long

Example

Request
DELETE /plugins/policies/{id}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /plugins/policies/{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 /plugins/policies/{id}
Content-Type: */*
Accept: application/json

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

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

PUT /plugins/policies/{id}

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 /plugins/policies/{id}
Content-Type: application/json
Accept: application/json

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

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

DELETE /plugins/server/policydeltas

Request Parameters
name type description default constraints
days query 7 int
reloadServicePoliciesCache query false boolean

Example

Request
DELETE /plugins/server/policydeltas
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /plugins/services/count

Response Body
media type data type description
application/json number (JSON)
application/xml long (XML)

Example

Request
GET /plugins/services/count
Content-Type: */*
Accept: application/json

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

                
...
                
              

POST /plugins/services/validateConfig

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

Example

Request
POST /plugins/services/validateConfig
Content-Type: application/json
Accept: application/json

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

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

DELETE /plugins/services/{id}

Request Parameters
name type description constraints
id path long

Example

Request
DELETE /plugins/services/{id}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /plugins/services/{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 /plugins/services/{id}
Content-Type: */*
Accept: application/json

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

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

PUT /plugins/services/{id}

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 /plugins/services/{id}
Content-Type: application/json
Accept: application/json

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

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

GET /plugins/definitions/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 /plugins/definitions/name/{name}
Content-Type: */*
Accept: application/json

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

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

GET /plugins/metrics/type/{type}

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

Example

Request
GET /plugins/metrics/type/{type}
Content-Type: */*
Accept: application/json

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

                
...
                
              

GET /plugins/policies/download/{serviceName}

Request Parameters
name type description default constraints
serviceName path    
clusterName query  
lastActivationTime query 0 long
lastKnownVersion query   long
pluginId query    
supportsPolicyDeltas query false boolean
zoneName query  
Response Body
media type data type description
application/json ServicePolicies (JSON)
application/xml servicePolicies (XML)

Example

Request
GET /plugins/policies/download/{serviceName}
Content-Type: */*
Accept: application/json

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

                
{
  "userRoles" : {
    "property1" : [ "...", "..." ],
    "property2" : [ "...", "..." ]
  },
  "serviceId" : 12345,
  "securityZones" : {
    "property1" : {
      "policies" : [ {
        "policyItems" : [ { }, { } ],
        "allowExceptions" : [ { }, { } ],
        "service" : "...",
        "conditions" : [ { }, { } ],
        "resourceSignature" : "...",
        "policyLabels" : [ "...", "..." ],
        "name" : "...",
        "options" : {
          "property1" : { },
          "property2" : { }
        },
        "rowFilterPolicyItems" : [ { }, { } ],
        "resources" : {
          "property1" : { },
          "property2" : { }
        },
        "isDenyAllElse" : true,
        "isAuditEnabled" : true,
        "validitySchedules" : [ { }, { } ],
        "denyExceptions" : [ { }, { } ],
        "policyType" : 12345,
        "zoneName" : "...",
        "dataMaskPolicyItems" : [ { }, { } ],
        "denyPolicyItems" : [ { }, { } ],
        "policyPriority" : 12345,
        "description" : "...",
        "serviceType" : "...",
        "createTime" : 12345,
        "updatedBy" : "...",
        "version" : 12345,
        "updateTime" : 12345,
        "id" : 12345,
        "createdBy" : "...",
        "guid" : "...",
        "isEnabled" : true
      }, {
        "policyItems" : [ { }, { } ],
        "allowExceptions" : [ { }, { } ],
        "service" : "...",
        "conditions" : [ { }, { } ],
        "resourceSignature" : "...",
        "policyLabels" : [ "...", "..." ],
        "name" : "...",
        "options" : {
          "property1" : { },
          "property2" : { }
        },
        "rowFilterPolicyItems" : [ { }, { } ],
        "resources" : {
          "property1" : { },
          "property2" : { }
        },
        "isDenyAllElse" : true,
        "isAuditEnabled" : true,
        "validitySchedules" : [ { }, { } ],
        "denyExceptions" : [ { }, { } ],
        "policyType" : 12345,
        "zoneName" : "...",
        "dataMaskPolicyItems" : [ { }, { } ],
        "denyPolicyItems" : [ { }, { } ],
        "policyPriority" : 12345,
        "description" : "...",
        "serviceType" : "...",
        "createTime" : 12345,
        "updatedBy" : "...",
        "version" : 12345,
        "updateTime" : 12345,
        "id" : 12345,
        "createdBy" : "...",
        "guid" : "...",
        "isEnabled" : true
      } ],
      "resources" : [ {
        "property1" : [ ],
        "property2" : [ ]
      }, {
        "property1" : [ ],
        "property2" : [ ]
      } ],
      "policyDeltas" : [ {
        "id" : 12345,
        "policy" : { },
        "changeType" : 12345
      }, {
        "id" : 12345,
        "policy" : { },
        "changeType" : 12345
      } ],
      "containsAssociatedTagService" : true,
      "zoneName" : "..."
    },
    "property2" : {
      "policies" : [ {
        "policyItems" : [ { }, { } ],
        "allowExceptions" : [ { }, { } ],
        "service" : "...",
        "conditions" : [ { }, { } ],
        "resourceSignature" : "...",
        "policyLabels" : [ "...", "..." ],
        "name" : "...",
        "options" : {
          "property1" : { },
          "property2" : { }
        },
        "rowFilterPolicyItems" : [ { }, { } ],
        "resources" : {
          "property1" : { },
          "property2" : { }
        },
        "isDenyAllElse" : true,
        "isAuditEnabled" : true,
        "validitySchedules" : [ { }, { } ],
        "denyExceptions" : [ { }, { } ],
        "policyType" : 12345,
        "zoneName" : "...",
        "dataMaskPolicyItems" : [ { }, { } ],
        "denyPolicyItems" : [ { }, { } ],
        "policyPriority" : 12345,
        "description" : "...",
        "serviceType" : "...",
        "createTime" : 12345,
        "updatedBy" : "...",
        "version" : 12345,
        "updateTime" : 12345,
        "id" : 12345,
        "createdBy" : "...",
        "guid" : "...",
        "isEnabled" : true
      }, {
        "policyItems" : [ { }, { } ],
        "allowExceptions" : [ { }, { } ],
        "service" : "...",
        "conditions" : [ { }, { } ],
        "resourceSignature" : "...",
        "policyLabels" : [ "...", "..." ],
        "name" : "...",
        "options" : {
          "property1" : { },
          "property2" : { }
        },
        "rowFilterPolicyItems" : [ { }, { } ],
        "resources" : {
          "property1" : { },
          "property2" : { }
        },
        "isDenyAllElse" : true,
        "isAuditEnabled" : true,
        "validitySchedules" : [ { }, { } ],
        "denyExceptions" : [ { }, { } ],
        "policyType" : 12345,
        "zoneName" : "...",
        "dataMaskPolicyItems" : [ { }, { } ],
        "denyPolicyItems" : [ { }, { } ],
        "policyPriority" : 12345,
        "description" : "...",
        "serviceType" : "...",
        "createTime" : 12345,
        "updatedBy" : "...",
        "version" : 12345,
        "updateTime" : 12345,
        "id" : 12345,
        "createdBy" : "...",
        "guid" : "...",
        "isEnabled" : true
      } ],
      "resources" : [ {
        "property1" : [ ],
        "property2" : [ ]
      }, {
        "property1" : [ ],
        "property2" : [ ]
      } ],
      "policyDeltas" : [ {
        "id" : 12345,
        "policy" : { },
        "changeType" : 12345
      }, {
        "id" : 12345,
        "policy" : { },
        "changeType" : 12345
      } ],
      "containsAssociatedTagService" : true,
      "zoneName" : "..."
    }
  },
  "serviceDef" : {
    "implClass" : "...",
    "contextEnrichers" : [ {
      "enricherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "name" : "...",
      "itemId" : 12345,
      "enricher" : "..."
    }, {
      "enricherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "name" : "...",
      "itemId" : 12345,
      "enricher" : "..."
    } ],
    "rbKeyDescription" : "...",
    "configs" : [ {
      "name" : "...",
      "mandatory" : true,
      "itemId" : 12345,
      "validationRegEx" : "...",
      "type" : "...",
      "validationMessage" : "...",
      "subType" : "...",
      "uiHint" : "...",
      "rbKeyDescription" : "...",
      "defaultValue" : "...",
      "rbKeyLabel" : "...",
      "label" : "...",
      "description" : "...",
      "rbKeyValidationMessage" : "..."
    }, {
      "name" : "...",
      "mandatory" : true,
      "itemId" : 12345,
      "validationRegEx" : "...",
      "type" : "...",
      "validationMessage" : "...",
      "subType" : "...",
      "uiHint" : "...",
      "rbKeyDescription" : "...",
      "defaultValue" : "...",
      "rbKeyLabel" : "...",
      "label" : "...",
      "description" : "...",
      "rbKeyValidationMessage" : "..."
    } ],
    "rbKeyLabel" : "...",
    "name" : "...",
    "enums" : [ {
      "defaultIndex" : 12345,
      "elements" : [ { }, { } ],
      "itemId" : 12345,
      "name" : "..."
    }, {
      "defaultIndex" : 12345,
      "elements" : [ { }, { } ],
      "itemId" : 12345,
      "name" : "..."
    } ],
    "resources" : [ {
      "lookupSupported" : true,
      "name" : "...",
      "description" : "...",
      "isValidLeaf" : true,
      "uiHint" : "...",
      "matcher" : "...",
      "accessTypeRestrictions" : [ "...", "..." ],
      "validationMessage" : "...",
      "excludesSupported" : true,
      "type" : "...",
      "rbKeyValidationMessage" : "...",
      "validationRegEx" : "...",
      "itemId" : 12345,
      "recursiveSupported" : true,
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "rbKeyDescription" : "...",
      "parent" : "...",
      "rbKeyLabel" : "...",
      "label" : "...",
      "mandatory" : true
    }, {
      "lookupSupported" : true,
      "name" : "...",
      "description" : "...",
      "isValidLeaf" : true,
      "uiHint" : "...",
      "matcher" : "...",
      "accessTypeRestrictions" : [ "...", "..." ],
      "validationMessage" : "...",
      "excludesSupported" : true,
      "type" : "...",
      "rbKeyValidationMessage" : "...",
      "validationRegEx" : "...",
      "itemId" : 12345,
      "recursiveSupported" : true,
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "rbKeyDescription" : "...",
      "parent" : "...",
      "rbKeyLabel" : "...",
      "label" : "...",
      "mandatory" : true
    } ],
    "dataMaskDef" : {
      "accessTypes" : [ { }, { } ],
      "resources" : [ { }, { } ],
      "maskTypes" : [ { }, { } ]
    },
    "policyConditions" : [ {
      "label" : "...",
      "itemId" : 12345,
      "evaluatorOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "rbKeyLabel" : "...",
      "uiHint" : "...",
      "rbKeyDescription" : "...",
      "rbKeyValidationMessage" : "...",
      "validationRegEx" : "...",
      "validationMessage" : "...",
      "name" : "...",
      "evaluator" : "...",
      "description" : "..."
    }, {
      "label" : "...",
      "itemId" : 12345,
      "evaluatorOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "rbKeyLabel" : "...",
      "uiHint" : "...",
      "rbKeyDescription" : "...",
      "rbKeyValidationMessage" : "...",
      "validationRegEx" : "...",
      "validationMessage" : "...",
      "name" : "...",
      "evaluator" : "...",
      "description" : "..."
    } ],
    "label" : "...",
    "accessTypes" : [ {
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "itemId" : 12345,
      "rbKeyLabel" : "...",
      "name" : "..."
    }, {
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "itemId" : 12345,
      "rbKeyLabel" : "...",
      "name" : "..."
    } ],
    "description" : "...",
    "rowFilterDef" : {
      "resources" : [ { }, { } ],
      "accessTypes" : [ { }, { } ]
    },
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "createTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "updateTime" : 12345,
    "id" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "isEnabled" : true
  },
  "policies" : [ {
    "policyItems" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "allowExceptions" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "service" : "...",
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ],
    "resourceSignature" : "...",
    "policyLabels" : [ "...", "..." ],
    "name" : "...",
    "options" : {
      "property1" : { },
      "property2" : { }
    },
    "rowFilterPolicyItems" : [ {
      "rowFilterInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "rowFilterInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "resources" : {
      "property1" : {
        "isExcludes" : true,
        "values" : [ "...", "..." ],
        "isRecursive" : true
      },
      "property2" : {
        "isExcludes" : true,
        "values" : [ "...", "..." ],
        "isRecursive" : true
      }
    },
    "isDenyAllElse" : true,
    "isAuditEnabled" : true,
    "validitySchedules" : [ {
      "recurrences" : [ { }, { } ],
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "recurrences" : [ { }, { } ],
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "denyExceptions" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "policyType" : 12345,
    "zoneName" : "...",
    "dataMaskPolicyItems" : [ {
      "dataMaskInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "dataMaskInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "denyPolicyItems" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "policyPriority" : 12345,
    "description" : "...",
    "serviceType" : "...",
    "createTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "updateTime" : 12345,
    "id" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "isEnabled" : true
  }, {
    "policyItems" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "allowExceptions" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "service" : "...",
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ],
    "resourceSignature" : "...",
    "policyLabels" : [ "...", "..." ],
    "name" : "...",
    "options" : {
      "property1" : { },
      "property2" : { }
    },
    "rowFilterPolicyItems" : [ {
      "rowFilterInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "rowFilterInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "resources" : {
      "property1" : {
        "isExcludes" : true,
        "values" : [ "...", "..." ],
        "isRecursive" : true
      },
      "property2" : {
        "isExcludes" : true,
        "values" : [ "...", "..." ],
        "isRecursive" : true
      }
    },
    "isDenyAllElse" : true,
    "isAuditEnabled" : true,
    "validitySchedules" : [ {
      "recurrences" : [ { }, { } ],
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "recurrences" : [ { }, { } ],
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "denyExceptions" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "policyType" : 12345,
    "zoneName" : "...",
    "dataMaskPolicyItems" : [ {
      "dataMaskInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "dataMaskInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "denyPolicyItems" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "policyPriority" : 12345,
    "description" : "...",
    "serviceType" : "...",
    "createTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "updateTime" : 12345,
    "id" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "isEnabled" : true
  } ],
  "policyVersion" : 12345,
  "groupRoles" : {
    "property1" : [ "...", "..." ],
    "property2" : [ "...", "..." ]
  },
  "tagPolicies" : {
    "auditMode" : "...",
    "policyUpdateTime" : 12345,
    "policies" : [ {
      "policyItems" : [ { }, { } ],
      "allowExceptions" : [ { }, { } ],
      "service" : "...",
      "conditions" : [ { }, { } ],
      "resourceSignature" : "...",
      "policyLabels" : [ "...", "..." ],
      "name" : "...",
      "options" : {
        "property1" : { },
        "property2" : { }
      },
      "rowFilterPolicyItems" : [ { }, { } ],
      "resources" : {
        "property1" : { },
        "property2" : { }
      },
      "isDenyAllElse" : true,
      "isAuditEnabled" : true,
      "validitySchedules" : [ { }, { } ],
      "denyExceptions" : [ { }, { } ],
      "policyType" : 12345,
      "zoneName" : "...",
      "dataMaskPolicyItems" : [ { }, { } ],
      "denyPolicyItems" : [ { }, { } ],
      "policyPriority" : 12345,
      "description" : "...",
      "serviceType" : "...",
      "createTime" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "updateTime" : 12345,
      "id" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "isEnabled" : true
    }, {
      "policyItems" : [ { }, { } ],
      "allowExceptions" : [ { }, { } ],
      "service" : "...",
      "conditions" : [ { }, { } ],
      "resourceSignature" : "...",
      "policyLabels" : [ "...", "..." ],
      "name" : "...",
      "options" : {
        "property1" : { },
        "property2" : { }
      },
      "rowFilterPolicyItems" : [ { }, { } ],
      "resources" : {
        "property1" : { },
        "property2" : { }
      },
      "isDenyAllElse" : true,
      "isAuditEnabled" : true,
      "validitySchedules" : [ { }, { } ],
      "denyExceptions" : [ { }, { } ],
      "policyType" : 12345,
      "zoneName" : "...",
      "dataMaskPolicyItems" : [ { }, { } ],
      "denyPolicyItems" : [ { }, { } ],
      "policyPriority" : 12345,
      "description" : "...",
      "serviceType" : "...",
      "createTime" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "updateTime" : 12345,
      "id" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "isEnabled" : true
    } ],
    "serviceDef" : {
      "implClass" : "...",
      "contextEnrichers" : [ { }, { } ],
      "rbKeyDescription" : "...",
      "configs" : [ { }, { } ],
      "rbKeyLabel" : "...",
      "name" : "...",
      "enums" : [ { }, { } ],
      "resources" : [ { }, { } ],
      "dataMaskDef" : { },
      "policyConditions" : [ { }, { } ],
      "label" : "...",
      "accessTypes" : [ { }, { } ],
      "description" : "...",
      "rowFilterDef" : { },
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "createTime" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "updateTime" : 12345,
      "id" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "isEnabled" : true
    },
    "policyVersion" : 12345,
    "serviceName" : "...",
    "serviceId" : 12345
  },
  "policyDeltas" : [ {
    "id" : 12345,
    "policy" : {
      "policyItems" : [ { }, { } ],
      "allowExceptions" : [ { }, { } ],
      "service" : "...",
      "conditions" : [ { }, { } ],
      "resourceSignature" : "...",
      "policyLabels" : [ "...", "..." ],
      "name" : "...",
      "options" : {
        "property1" : { },
        "property2" : { }
      },
      "rowFilterPolicyItems" : [ { }, { } ],
      "resources" : {
        "property1" : { },
        "property2" : { }
      },
      "isDenyAllElse" : true,
      "isAuditEnabled" : true,
      "validitySchedules" : [ { }, { } ],
      "denyExceptions" : [ { }, { } ],
      "policyType" : 12345,
      "zoneName" : "...",
      "dataMaskPolicyItems" : [ { }, { } ],
      "denyPolicyItems" : [ { }, { } ],
      "policyPriority" : 12345,
      "description" : "...",
      "serviceType" : "...",
      "createTime" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "updateTime" : 12345,
      "id" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "isEnabled" : true
    },
    "changeType" : 12345
  }, {
    "id" : 12345,
    "policy" : {
      "policyItems" : [ { }, { } ],
      "allowExceptions" : [ { }, { } ],
      "service" : "...",
      "conditions" : [ { }, { } ],
      "resourceSignature" : "...",
      "policyLabels" : [ "...", "..." ],
      "name" : "...",
      "options" : {
        "property1" : { },
        "property2" : { }
      },
      "rowFilterPolicyItems" : [ { }, { } ],
      "resources" : {
        "property1" : { },
        "property2" : { }
      },
      "isDenyAllElse" : true,
      "isAuditEnabled" : true,
      "validitySchedules" : [ { }, { } ],
      "denyExceptions" : [ { }, { } ],
      "policyType" : 12345,
      "zoneName" : "...",
      "dataMaskPolicyItems" : [ { }, { } ],
      "denyPolicyItems" : [ { }, { } ],
      "policyPriority" : 12345,
      "description" : "...",
      "serviceType" : "...",
      "createTime" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "updateTime" : 12345,
      "id" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "isEnabled" : true
    },
    "changeType" : 12345
  } ],
  "policyUpdateTime" : 12345,
  "serviceName" : "...",
  "auditMode" : "..."
}
                
              

GET /plugins/policies/service/{id}

Request Parameters
name type description constraints
id path long
Response Body
media type data type description
application/json RangerPolicyList (JSON)
application/xml rangerPolicyList (XML)

Example

Request
GET /plugins/policies/service/{id}
Content-Type: */*
Accept: application/json

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

                
{
  "policies" : [ {
    "policyItems" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "allowExceptions" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "service" : "...",
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ],
    "resourceSignature" : "...",
    "policyLabels" : [ "...", "..." ],
    "name" : "...",
    "options" : {
      "property1" : { },
      "property2" : { }
    },
    "rowFilterPolicyItems" : [ {
      "rowFilterInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "rowFilterInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "resources" : {
      "property1" : {
        "isExcludes" : true,
        "values" : [ "...", "..." ],
        "isRecursive" : true
      },
      "property2" : {
        "isExcludes" : true,
        "values" : [ "...", "..." ],
        "isRecursive" : true
      }
    },
    "isDenyAllElse" : true,
    "isAuditEnabled" : true,
    "validitySchedules" : [ {
      "recurrences" : [ { }, { } ],
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "recurrences" : [ { }, { } ],
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "denyExceptions" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "policyType" : 12345,
    "zoneName" : "...",
    "dataMaskPolicyItems" : [ {
      "dataMaskInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "dataMaskInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "denyPolicyItems" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "policyPriority" : 12345,
    "description" : "...",
    "serviceType" : "...",
    "createTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "updateTime" : 12345,
    "id" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "isEnabled" : true
  }, {
    "policyItems" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "allowExceptions" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "service" : "...",
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ],
    "resourceSignature" : "...",
    "policyLabels" : [ "...", "..." ],
    "name" : "...",
    "options" : {
      "property1" : { },
      "property2" : { }
    },
    "rowFilterPolicyItems" : [ {
      "rowFilterInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "rowFilterInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "resources" : {
      "property1" : {
        "isExcludes" : true,
        "values" : [ "...", "..." ],
        "isRecursive" : true
      },
      "property2" : {
        "isExcludes" : true,
        "values" : [ "...", "..." ],
        "isRecursive" : true
      }
    },
    "isDenyAllElse" : true,
    "isAuditEnabled" : true,
    "validitySchedules" : [ {
      "recurrences" : [ { }, { } ],
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "recurrences" : [ { }, { } ],
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "denyExceptions" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "policyType" : 12345,
    "zoneName" : "...",
    "dataMaskPolicyItems" : [ {
      "dataMaskInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "dataMaskInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "denyPolicyItems" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "policyPriority" : 12345,
    "description" : "...",
    "serviceType" : "...",
    "createTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "updateTime" : 12345,
    "id" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "isEnabled" : true
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}
                
              

GET /plugins/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 /plugins/policies/{serviceDefName}/for-resource
Content-Type: */*
Accept: application/json

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

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

GET /plugins/policy/{policyId}/versionList

Request Parameters
name type description constraints
policyId path long
Response Body
media type data type description
application/json VXString (JSON)
application/xml VXString (XML)

Example

Request
GET /plugins/policy/{policyId}/versionList
Content-Type: */*
Accept: application/json

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

                
{
  "value" : "...",
  "myClassType" : 12345
}
                
              

POST /plugins/services/grant/{serviceName}

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

Example

Request
POST /plugins/services/grant/{serviceName}
Content-Type: application/json
Accept: application/json

                
{
  "grantorGroups" : [ "...", "..." ],
  "groups" : [ "...", "..." ],
  "delegateAdmin" : true,
  "sessionId" : "...",
  "replaceExistingPermissions" : true,
  "zoneName" : "...",
  "grantor" : "...",
  "isRecursive" : true,
  "clientIPAddress" : "...",
  "enableAudit" : true,
  "accessTypes" : [ "...", "..." ],
  "users" : [ "...", "..." ],
  "clientType" : "...",
  "clusterName" : "...",
  "requestData" : "...",
  "resource" : {
    "property1" : "...",
    "property2" : "..."
  },
  "roles" : [ "...", "..." ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

POST /plugins/services/lookupResource/{serviceName}

Request Parameters
name type description
serviceName path
Request Body
media type data type
application/json ResourceLookupContext (JSON)
application/xml resourceLookupContext (XML)
Response Body
media type data type description
application/json array of string (JSON)
application/xml list of string (XML)

Example

Request
POST /plugins/services/lookupResource/{serviceName}
Content-Type: application/json
Accept: application/json

                
{
  "resources" : {
    "property1" : [ "...", "..." ],
    "property2" : [ "...", "..." ]
  },
  "resourceName" : "...",
  "userInput" : "..."
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...
                
              

GET /plugins/services/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 /plugins/services/name/{name}
Content-Type: */*
Accept: application/json

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

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

POST /plugins/services/revoke/{serviceName}

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

Example

Request
POST /plugins/services/revoke/{serviceName}
Content-Type: application/json
Accept: application/json

                
{
  "grantorGroups" : [ "...", "..." ],
  "groups" : [ "...", "..." ],
  "delegateAdmin" : true,
  "sessionId" : "...",
  "replaceExistingPermissions" : true,
  "zoneName" : "...",
  "grantor" : "...",
  "isRecursive" : true,
  "clientIPAddress" : "...",
  "enableAudit" : true,
  "accessTypes" : [ "...", "..." ],
  "users" : [ "...", "..." ],
  "clientType" : "...",
  "clusterName" : "...",
  "requestData" : "...",
  "resource" : {
    "property1" : "...",
    "property2" : "..."
  },
  "roles" : [ "...", "..." ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

GET /plugins/policies/service/name/{name}

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

Example

Request
GET /plugins/policies/service/name/{name}
Content-Type: */*
Accept: application/json

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

                
{
  "policies" : [ {
    "policyItems" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "allowExceptions" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "service" : "...",
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ],
    "resourceSignature" : "...",
    "policyLabels" : [ "...", "..." ],
    "name" : "...",
    "options" : {
      "property1" : { },
      "property2" : { }
    },
    "rowFilterPolicyItems" : [ {
      "rowFilterInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "rowFilterInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "resources" : {
      "property1" : {
        "isExcludes" : true,
        "values" : [ "...", "..." ],
        "isRecursive" : true
      },
      "property2" : {
        "isExcludes" : true,
        "values" : [ "...", "..." ],
        "isRecursive" : true
      }
    },
    "isDenyAllElse" : true,
    "isAuditEnabled" : true,
    "validitySchedules" : [ {
      "recurrences" : [ { }, { } ],
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "recurrences" : [ { }, { } ],
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "denyExceptions" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "policyType" : 12345,
    "zoneName" : "...",
    "dataMaskPolicyItems" : [ {
      "dataMaskInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "dataMaskInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "denyPolicyItems" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "policyPriority" : 12345,
    "description" : "...",
    "serviceType" : "...",
    "createTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "updateTime" : 12345,
    "id" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "isEnabled" : true
  }, {
    "policyItems" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "allowExceptions" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "service" : "...",
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ],
    "resourceSignature" : "...",
    "policyLabels" : [ "...", "..." ],
    "name" : "...",
    "options" : {
      "property1" : { },
      "property2" : { }
    },
    "rowFilterPolicyItems" : [ {
      "rowFilterInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "rowFilterInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "resources" : {
      "property1" : {
        "isExcludes" : true,
        "values" : [ "...", "..." ],
        "isRecursive" : true
      },
      "property2" : {
        "isExcludes" : true,
        "values" : [ "...", "..." ],
        "isRecursive" : true
      }
    },
    "isDenyAllElse" : true,
    "isAuditEnabled" : true,
    "validitySchedules" : [ {
      "recurrences" : [ { }, { } ],
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "recurrences" : [ { }, { } ],
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "denyExceptions" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "policyType" : 12345,
    "zoneName" : "...",
    "dataMaskPolicyItems" : [ {
      "dataMaskInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "dataMaskInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "denyPolicyItems" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "policyPriority" : 12345,
    "description" : "...",
    "serviceType" : "...",
    "createTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "updateTime" : 12345,
    "id" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "isEnabled" : true
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}
                
              

GET /plugins/policy/{policyId}/version/{versionNo}

Request Parameters
name type description constraints
policyId path long
versionNo path int
Response Body
media type data type description
application/json RangerPolicy (JSON)
application/xml rangerPolicy (XML)

Example

Request
GET /plugins/policy/{policyId}/version/{versionNo}
Content-Type: */*
Accept: application/json

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

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

GET /plugins/secure/policies/download/{serviceName}

Request Parameters
name type description default constraints
serviceName path    
clusterName query  
lastActivationTime query 0 long
lastKnownVersion query   long
pluginId query    
supportsPolicyDeltas query false boolean
zoneName query  
Response Body
media type data type description
application/json ServicePolicies (JSON)
application/xml servicePolicies (XML)

Example

Request
GET /plugins/secure/policies/download/{serviceName}
Content-Type: */*
Accept: application/json

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

                
{
  "userRoles" : {
    "property1" : [ "...", "..." ],
    "property2" : [ "...", "..." ]
  },
  "serviceId" : 12345,
  "securityZones" : {
    "property1" : {
      "policies" : [ {
        "policyItems" : [ { }, { } ],
        "allowExceptions" : [ { }, { } ],
        "service" : "...",
        "conditions" : [ { }, { } ],
        "resourceSignature" : "...",
        "policyLabels" : [ "...", "..." ],
        "name" : "...",
        "options" : {
          "property1" : { },
          "property2" : { }
        },
        "rowFilterPolicyItems" : [ { }, { } ],
        "resources" : {
          "property1" : { },
          "property2" : { }
        },
        "isDenyAllElse" : true,
        "isAuditEnabled" : true,
        "validitySchedules" : [ { }, { } ],
        "denyExceptions" : [ { }, { } ],
        "policyType" : 12345,
        "zoneName" : "...",
        "dataMaskPolicyItems" : [ { }, { } ],
        "denyPolicyItems" : [ { }, { } ],
        "policyPriority" : 12345,
        "description" : "...",
        "serviceType" : "...",
        "createTime" : 12345,
        "updatedBy" : "...",
        "version" : 12345,
        "updateTime" : 12345,
        "id" : 12345,
        "createdBy" : "...",
        "guid" : "...",
        "isEnabled" : true
      }, {
        "policyItems" : [ { }, { } ],
        "allowExceptions" : [ { }, { } ],
        "service" : "...",
        "conditions" : [ { }, { } ],
        "resourceSignature" : "...",
        "policyLabels" : [ "...", "..." ],
        "name" : "...",
        "options" : {
          "property1" : { },
          "property2" : { }
        },
        "rowFilterPolicyItems" : [ { }, { } ],
        "resources" : {
          "property1" : { },
          "property2" : { }
        },
        "isDenyAllElse" : true,
        "isAuditEnabled" : true,
        "validitySchedules" : [ { }, { } ],
        "denyExceptions" : [ { }, { } ],
        "policyType" : 12345,
        "zoneName" : "...",
        "dataMaskPolicyItems" : [ { }, { } ],
        "denyPolicyItems" : [ { }, { } ],
        "policyPriority" : 12345,
        "description" : "...",
        "serviceType" : "...",
        "createTime" : 12345,
        "updatedBy" : "...",
        "version" : 12345,
        "updateTime" : 12345,
        "id" : 12345,
        "createdBy" : "...",
        "guid" : "...",
        "isEnabled" : true
      } ],
      "resources" : [ {
        "property1" : [ ],
        "property2" : [ ]
      }, {
        "property1" : [ ],
        "property2" : [ ]
      } ],
      "policyDeltas" : [ {
        "id" : 12345,
        "policy" : { },
        "changeType" : 12345
      }, {
        "id" : 12345,
        "policy" : { },
        "changeType" : 12345
      } ],
      "containsAssociatedTagService" : true,
      "zoneName" : "..."
    },
    "property2" : {
      "policies" : [ {
        "policyItems" : [ { }, { } ],
        "allowExceptions" : [ { }, { } ],
        "service" : "...",
        "conditions" : [ { }, { } ],
        "resourceSignature" : "...",
        "policyLabels" : [ "...", "..." ],
        "name" : "...",
        "options" : {
          "property1" : { },
          "property2" : { }
        },
        "rowFilterPolicyItems" : [ { }, { } ],
        "resources" : {
          "property1" : { },
          "property2" : { }
        },
        "isDenyAllElse" : true,
        "isAuditEnabled" : true,
        "validitySchedules" : [ { }, { } ],
        "denyExceptions" : [ { }, { } ],
        "policyType" : 12345,
        "zoneName" : "...",
        "dataMaskPolicyItems" : [ { }, { } ],
        "denyPolicyItems" : [ { }, { } ],
        "policyPriority" : 12345,
        "description" : "...",
        "serviceType" : "...",
        "createTime" : 12345,
        "updatedBy" : "...",
        "version" : 12345,
        "updateTime" : 12345,
        "id" : 12345,
        "createdBy" : "...",
        "guid" : "...",
        "isEnabled" : true
      }, {
        "policyItems" : [ { }, { } ],
        "allowExceptions" : [ { }, { } ],
        "service" : "...",
        "conditions" : [ { }, { } ],
        "resourceSignature" : "...",
        "policyLabels" : [ "...", "..." ],
        "name" : "...",
        "options" : {
          "property1" : { },
          "property2" : { }
        },
        "rowFilterPolicyItems" : [ { }, { } ],
        "resources" : {
          "property1" : { },
          "property2" : { }
        },
        "isDenyAllElse" : true,
        "isAuditEnabled" : true,
        "validitySchedules" : [ { }, { } ],
        "denyExceptions" : [ { }, { } ],
        "policyType" : 12345,
        "zoneName" : "...",
        "dataMaskPolicyItems" : [ { }, { } ],
        "denyPolicyItems" : [ { }, { } ],
        "policyPriority" : 12345,
        "description" : "...",
        "serviceType" : "...",
        "createTime" : 12345,
        "updatedBy" : "...",
        "version" : 12345,
        "updateTime" : 12345,
        "id" : 12345,
        "createdBy" : "...",
        "guid" : "...",
        "isEnabled" : true
      } ],
      "resources" : [ {
        "property1" : [ ],
        "property2" : [ ]
      }, {
        "property1" : [ ],
        "property2" : [ ]
      } ],
      "policyDeltas" : [ {
        "id" : 12345,
        "policy" : { },
        "changeType" : 12345
      }, {
        "id" : 12345,
        "policy" : { },
        "changeType" : 12345
      } ],
      "containsAssociatedTagService" : true,
      "zoneName" : "..."
    }
  },
  "serviceDef" : {
    "implClass" : "...",
    "contextEnrichers" : [ {
      "enricherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "name" : "...",
      "itemId" : 12345,
      "enricher" : "..."
    }, {
      "enricherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "name" : "...",
      "itemId" : 12345,
      "enricher" : "..."
    } ],
    "rbKeyDescription" : "...",
    "configs" : [ {
      "name" : "...",
      "mandatory" : true,
      "itemId" : 12345,
      "validationRegEx" : "...",
      "type" : "...",
      "validationMessage" : "...",
      "subType" : "...",
      "uiHint" : "...",
      "rbKeyDescription" : "...",
      "defaultValue" : "...",
      "rbKeyLabel" : "...",
      "label" : "...",
      "description" : "...",
      "rbKeyValidationMessage" : "..."
    }, {
      "name" : "...",
      "mandatory" : true,
      "itemId" : 12345,
      "validationRegEx" : "...",
      "type" : "...",
      "validationMessage" : "...",
      "subType" : "...",
      "uiHint" : "...",
      "rbKeyDescription" : "...",
      "defaultValue" : "...",
      "rbKeyLabel" : "...",
      "label" : "...",
      "description" : "...",
      "rbKeyValidationMessage" : "..."
    } ],
    "rbKeyLabel" : "...",
    "name" : "...",
    "enums" : [ {
      "defaultIndex" : 12345,
      "elements" : [ { }, { } ],
      "itemId" : 12345,
      "name" : "..."
    }, {
      "defaultIndex" : 12345,
      "elements" : [ { }, { } ],
      "itemId" : 12345,
      "name" : "..."
    } ],
    "resources" : [ {
      "lookupSupported" : true,
      "name" : "...",
      "description" : "...",
      "isValidLeaf" : true,
      "uiHint" : "...",
      "matcher" : "...",
      "accessTypeRestrictions" : [ "...", "..." ],
      "validationMessage" : "...",
      "excludesSupported" : true,
      "type" : "...",
      "rbKeyValidationMessage" : "...",
      "validationRegEx" : "...",
      "itemId" : 12345,
      "recursiveSupported" : true,
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "rbKeyDescription" : "...",
      "parent" : "...",
      "rbKeyLabel" : "...",
      "label" : "...",
      "mandatory" : true
    }, {
      "lookupSupported" : true,
      "name" : "...",
      "description" : "...",
      "isValidLeaf" : true,
      "uiHint" : "...",
      "matcher" : "...",
      "accessTypeRestrictions" : [ "...", "..." ],
      "validationMessage" : "...",
      "excludesSupported" : true,
      "type" : "...",
      "rbKeyValidationMessage" : "...",
      "validationRegEx" : "...",
      "itemId" : 12345,
      "recursiveSupported" : true,
      "level" : 12345,
      "matcherOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "rbKeyDescription" : "...",
      "parent" : "...",
      "rbKeyLabel" : "...",
      "label" : "...",
      "mandatory" : true
    } ],
    "dataMaskDef" : {
      "accessTypes" : [ { }, { } ],
      "resources" : [ { }, { } ],
      "maskTypes" : [ { }, { } ]
    },
    "policyConditions" : [ {
      "label" : "...",
      "itemId" : 12345,
      "evaluatorOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "rbKeyLabel" : "...",
      "uiHint" : "...",
      "rbKeyDescription" : "...",
      "rbKeyValidationMessage" : "...",
      "validationRegEx" : "...",
      "validationMessage" : "...",
      "name" : "...",
      "evaluator" : "...",
      "description" : "..."
    }, {
      "label" : "...",
      "itemId" : 12345,
      "evaluatorOptions" : {
        "property1" : "...",
        "property2" : "..."
      },
      "rbKeyLabel" : "...",
      "uiHint" : "...",
      "rbKeyDescription" : "...",
      "rbKeyValidationMessage" : "...",
      "validationRegEx" : "...",
      "validationMessage" : "...",
      "name" : "...",
      "evaluator" : "...",
      "description" : "..."
    } ],
    "label" : "...",
    "accessTypes" : [ {
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "itemId" : 12345,
      "rbKeyLabel" : "...",
      "name" : "..."
    }, {
      "label" : "...",
      "impliedGrants" : [ "...", "..." ],
      "itemId" : 12345,
      "rbKeyLabel" : "...",
      "name" : "..."
    } ],
    "description" : "...",
    "rowFilterDef" : {
      "resources" : [ { }, { } ],
      "accessTypes" : [ { }, { } ]
    },
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "createTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "updateTime" : 12345,
    "id" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "isEnabled" : true
  },
  "policies" : [ {
    "policyItems" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "allowExceptions" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "service" : "...",
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ],
    "resourceSignature" : "...",
    "policyLabels" : [ "...", "..." ],
    "name" : "...",
    "options" : {
      "property1" : { },
      "property2" : { }
    },
    "rowFilterPolicyItems" : [ {
      "rowFilterInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "rowFilterInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "resources" : {
      "property1" : {
        "isExcludes" : true,
        "values" : [ "...", "..." ],
        "isRecursive" : true
      },
      "property2" : {
        "isExcludes" : true,
        "values" : [ "...", "..." ],
        "isRecursive" : true
      }
    },
    "isDenyAllElse" : true,
    "isAuditEnabled" : true,
    "validitySchedules" : [ {
      "recurrences" : [ { }, { } ],
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "recurrences" : [ { }, { } ],
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "denyExceptions" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "policyType" : 12345,
    "zoneName" : "...",
    "dataMaskPolicyItems" : [ {
      "dataMaskInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "dataMaskInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "denyPolicyItems" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "policyPriority" : 12345,
    "description" : "...",
    "serviceType" : "...",
    "createTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "updateTime" : 12345,
    "id" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "isEnabled" : true
  }, {
    "policyItems" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "allowExceptions" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "service" : "...",
    "conditions" : [ {
      "type" : "...",
      "values" : [ "...", "..." ]
    }, {
      "type" : "...",
      "values" : [ "...", "..." ]
    } ],
    "resourceSignature" : "...",
    "policyLabels" : [ "...", "..." ],
    "name" : "...",
    "options" : {
      "property1" : { },
      "property2" : { }
    },
    "rowFilterPolicyItems" : [ {
      "rowFilterInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "rowFilterInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "resources" : {
      "property1" : {
        "isExcludes" : true,
        "values" : [ "...", "..." ],
        "isRecursive" : true
      },
      "property2" : {
        "isExcludes" : true,
        "values" : [ "...", "..." ],
        "isRecursive" : true
      }
    },
    "isDenyAllElse" : true,
    "isAuditEnabled" : true,
    "validitySchedules" : [ {
      "recurrences" : [ { }, { } ],
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "recurrences" : [ { }, { } ],
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "denyExceptions" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "policyType" : 12345,
    "zoneName" : "...",
    "dataMaskPolicyItems" : [ {
      "dataMaskInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "dataMaskInfo" : { },
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "denyPolicyItems" : [ {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    }, {
      "roles" : [ "...", "..." ],
      "groups" : [ "...", "..." ],
      "conditions" : [ { }, { } ],
      "delegateAdmin" : true,
      "accesses" : [ { }, { } ],
      "users" : [ "...", "..." ]
    } ],
    "policyPriority" : 12345,
    "description" : "...",
    "serviceType" : "...",
    "createTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "updateTime" : 12345,
    "id" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "isEnabled" : true
  } ],
  "policyVersion" : 12345,
  "groupRoles" : {
    "property1" : [ "...", "..." ],
    "property2" : [ "...", "..." ]
  },
  "tagPolicies" : {
    "auditMode" : "...",
    "policyUpdateTime" : 12345,
    "policies" : [ {
      "policyItems" : [ { }, { } ],
      "allowExceptions" : [ { }, { } ],
      "service" : "...",
      "conditions" : [ { }, { } ],
      "resourceSignature" : "...",
      "policyLabels" : [ "...", "..." ],
      "name" : "...",
      "options" : {
        "property1" : { },
        "property2" : { }
      },
      "rowFilterPolicyItems" : [ { }, { } ],
      "resources" : {
        "property1" : { },
        "property2" : { }
      },
      "isDenyAllElse" : true,
      "isAuditEnabled" : true,
      "validitySchedules" : [ { }, { } ],
      "denyExceptions" : [ { }, { } ],
      "policyType" : 12345,
      "zoneName" : "...",
      "dataMaskPolicyItems" : [ { }, { } ],
      "denyPolicyItems" : [ { }, { } ],
      "policyPriority" : 12345,
      "description" : "...",
      "serviceType" : "...",
      "createTime" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "updateTime" : 12345,
      "id" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "isEnabled" : true
    }, {
      "policyItems" : [ { }, { } ],
      "allowExceptions" : [ { }, { } ],
      "service" : "...",
      "conditions" : [ { }, { } ],
      "resourceSignature" : "...",
      "policyLabels" : [ "...", "..." ],
      "name" : "...",
      "options" : {
        "property1" : { },
        "property2" : { }
      },
      "rowFilterPolicyItems" : [ { }, { } ],
      "resources" : {
        "property1" : { },
        "property2" : { }
      },
      "isDenyAllElse" : true,
      "isAuditEnabled" : true,
      "validitySchedules" : [ { }, { } ],
      "denyExceptions" : [ { }, { } ],
      "policyType" : 12345,
      "zoneName" : "...",
      "dataMaskPolicyItems" : [ { }, { } ],
      "denyPolicyItems" : [ { }, { } ],
      "policyPriority" : 12345,
      "description" : "...",
      "serviceType" : "...",
      "createTime" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "updateTime" : 12345,
      "id" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "isEnabled" : true
    } ],
    "serviceDef" : {
      "implClass" : "...",
      "contextEnrichers" : [ { }, { } ],
      "rbKeyDescription" : "...",
      "configs" : [ { }, { } ],
      "rbKeyLabel" : "...",
      "name" : "...",
      "enums" : [ { }, { } ],
      "resources" : [ { }, { } ],
      "dataMaskDef" : { },
      "policyConditions" : [ { }, { } ],
      "label" : "...",
      "accessTypes" : [ { }, { } ],
      "description" : "...",
      "rowFilterDef" : { },
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "createTime" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "updateTime" : 12345,
      "id" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "isEnabled" : true
    },
    "policyVersion" : 12345,
    "serviceName" : "...",
    "serviceId" : 12345
  },
  "policyDeltas" : [ {
    "id" : 12345,
    "policy" : {
      "policyItems" : [ { }, { } ],
      "allowExceptions" : [ { }, { } ],
      "service" : "...",
      "conditions" : [ { }, { } ],
      "resourceSignature" : "...",
      "policyLabels" : [ "...", "..." ],
      "name" : "...",
      "options" : {
        "property1" : { },
        "property2" : { }
      },
      "rowFilterPolicyItems" : [ { }, { } ],
      "resources" : {
        "property1" : { },
        "property2" : { }
      },
      "isDenyAllElse" : true,
      "isAuditEnabled" : true,
      "validitySchedules" : [ { }, { } ],
      "denyExceptions" : [ { }, { } ],
      "policyType" : 12345,
      "zoneName" : "...",
      "dataMaskPolicyItems" : [ { }, { } ],
      "denyPolicyItems" : [ { }, { } ],
      "policyPriority" : 12345,
      "description" : "...",
      "serviceType" : "...",
      "createTime" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "updateTime" : 12345,
      "id" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "isEnabled" : true
    },
    "changeType" : 12345
  }, {
    "id" : 12345,
    "policy" : {
      "policyItems" : [ { }, { } ],
      "allowExceptions" : [ { }, { } ],
      "service" : "...",
      "conditions" : [ { }, { } ],
      "resourceSignature" : "...",
      "policyLabels" : [ "...", "..." ],
      "name" : "...",
      "options" : {
        "property1" : { },
        "property2" : { }
      },
      "rowFilterPolicyItems" : [ { }, { } ],
      "resources" : {
        "property1" : { },
        "property2" : { }
      },
      "isDenyAllElse" : true,
      "isAuditEnabled" : true,
      "validitySchedules" : [ { }, { } ],
      "denyExceptions" : [ { }, { } ],
      "policyType" : 12345,
      "zoneName" : "...",
      "dataMaskPolicyItems" : [ { }, { } ],
      "denyPolicyItems" : [ { }, { } ],
      "policyPriority" : 12345,
      "description" : "...",
      "serviceType" : "...",
      "createTime" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "updateTime" : 12345,
      "id" : 12345,
      "createdBy" : "...",
      "guid" : "...",
      "isEnabled" : true
    },
    "changeType" : 12345
  } ],
  "policyUpdateTime" : 12345,
  "serviceName" : "...",
  "auditMode" : "..."
}
                
              

POST /plugins/secure/services/grant/{serviceName}

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

Example

Request
POST /plugins/secure/services/grant/{serviceName}
Content-Type: application/json
Accept: application/json

                
{
  "grantorGroups" : [ "...", "..." ],
  "groups" : [ "...", "..." ],
  "delegateAdmin" : true,
  "sessionId" : "...",
  "replaceExistingPermissions" : true,
  "zoneName" : "...",
  "grantor" : "...",
  "isRecursive" : true,
  "clientIPAddress" : "...",
  "enableAudit" : true,
  "accessTypes" : [ "...", "..." ],
  "users" : [ "...", "..." ],
  "clientType" : "...",
  "clusterName" : "...",
  "requestData" : "...",
  "resource" : {
    "property1" : "...",
    "property2" : "..."
  },
  "roles" : [ "...", "..." ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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

POST /plugins/secure/services/revoke/{serviceName}

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

Example

Request
POST /plugins/secure/services/revoke/{serviceName}
Content-Type: application/json
Accept: application/json

                
{
  "grantorGroups" : [ "...", "..." ],
  "groups" : [ "...", "..." ],
  "delegateAdmin" : true,
  "sessionId" : "...",
  "replaceExistingPermissions" : true,
  "zoneName" : "...",
  "grantor" : "...",
  "isRecursive" : true,
  "clientIPAddress" : "...",
  "enableAudit" : true,
  "accessTypes" : [ "...", "..." ],
  "users" : [ "...", "..." ],
  "clientType" : "...",
  "clusterName" : "...",
  "requestData" : "...",
  "resource" : {
    "property1" : "...",
    "property2" : "..."
  },
  "roles" : [ "...", "..." ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

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