Apache Ranger Public REST APIs
Also available as:
PDF

Search Policies in a Service

Reference information for the Ranger REST API service/public/v2/api/service/{service-name}/policy.

API Name Search Policies in a Service
API Name Search Policies in a Service
Request Type GET
Request URL service/public/v2/api/service/{service-name}/policy
Request Params

Query Parameters:

pageSize int The page size required

startIndex int The start record index

policyName string The Exact Name of the policy

policyNamePartial string The Partial Name of the policy

policyId string The policy ID

polResource string The policy resource value

resource:resource-type string The policy resource value for given resource-type

user stringThe user name

group string The group name

isRecursive boolean The isRecursive property ("true" or "false")

isEnabled boolean The enable/disabled property ("true" or "false")

Example =

pageSize=25&startIndex=0&resource:database=finance

Response
[
    {
        "allowExceptions": [],
        "createTime": 1450757992000,
        "createdBy": "amb_ranger_admin",
        "denyExceptions": [],
        "denyPolicyItems": [],
        "description": "Default Policy for Service: cl1_hive",
        "guid": "4a322a05-c17f-4d6c-b291-94cae3e6c353",
        "id": 3,
        "isAuditEnabled": true,
        "isEnabled": true,
        "name": "cl1_hive-1-20151222041951",
        "policyItems": [
            {
                "accesses": [
                    {
                        "isAllowed": true,
                        "type": "select"
                    },
                    {
                        "isAllowed": true,
                        "type": "update"
                    },
                    {
                        "isAllowed": true,
                        "type": "create"
                    },
                    {
                        "isAllowed": true,
                        "type": "drop"
                    },
                    {
                        "isAllowed": true,
                        "type": "alter"
                    },
                    {
                        "isAllowed": true,
                        "type": "index"
                    },
                    {
                        "isAllowed": true,
                        "type": "lock"
                    },
                    {
                        "isAllowed": true,
                        "type": "all"
                    }
                ],
                "conditions": [],
                "delegateAdmin": true,
                "groups": [],
                "users": [
                    "ambari-qa"
                ]
            }
        ],
        "resourceSignature": "6e79c1c989c79b7e53af663d3bdc2de6",
        "resources": {
            "column": {
                "isExcludes": false,
                "isRecursive": false,
                "values": [
                    "*"
                ]
            },
            "database": {
                "isExcludes": false,
                "isRecursive": false,
                "values": [
                    "*"
                ]
            },
            "table": {
                "isExcludes": false,
                "isRecursive": false,
                "values": [
                    "*"
                ]
            }
        },
        "service": "cl1_hive",
        "updateTime": 1450757994000,
        "updatedBy": "amb_ranger_admin",
        "version": 2
    },
    {
        "allowExceptions": [],
        "createTime": 1450757992000,
        "createdBy": "amb_ranger_admin",
        "denyExceptions": [],
        "denyPolicyItems": [],
        "description": "Default Policy for Service: cl1_hive",
        "guid": "d6218120-1b66-43e6-9fef-9c917a8e9e25",
        "id": 4,
        "isAuditEnabled": true,
        "isEnabled": true,
        "name": "cl1_hive-2-20151222041952",
        "policyItems": [
            {
                "accesses": [
                    {
                        "isAllowed": true,
                        "type": "select"
                    },
                    {
                        "isAllowed": true,
                        "type": "update"
                    },
                    {
                        "isAllowed": true,
                        "type": "create"
                    },
                    {
                        "isAllowed": true,
                        "type": "drop"
                    },
                    {
                        "isAllowed": true,
                        "type": "alter"
                    },
                    {
                        "isAllowed": true,
                        "type": "index"
                    },
                    {
                        "isAllowed": true,
                        "type": "lock"
                    },
                    {
                        "isAllowed": true,
                        "type": "all"
                    }
                ],
                "conditions": [],
                "delegateAdmin": true,
                "groups": [],
                "users": [
                    "ambari-qa"
                ]
            }
        ],
        "resourceSignature": "c834ed2b8c7462d2aa8bbffdb05226c8",
        "resources": {
            "database": {
                "isExcludes": false,
                "isRecursive": false,
                "values": [
                    "*"
                ]
            },
            "udf": {
                "isExcludes": false,
                "isRecursive": false,
                "values": [
                    "*"
                ]
            }
        },
        "service": "cl1_hive",
        "updateTime": 1450757995000,
        "updatedBy": "amb_ranger_admin",
        "version": 2
    }
]