Skip to main content
GET
/
api
/
govern
/
data-access
/
policies
/
{policy_id}
Get a single Ranger policy
curl --request GET \
  --url https://api.example.com/api/govern/data-access/policies/{policy_id} \
  --header 'Authorization: Bearer <token>'
{
  "policy_id": 123,
  "policy_name": "<string>",
  "service": "<string>",
  "resources": {},
  "policyType": 0,
  "isEnabled": true,
  "isAuditEnabled": true,
  "policyItems": [
    {}
  ],
  "denyPolicyItems": [
    {}
  ],
  "allowExceptions": [
    {}
  ],
  "denyExceptions": [
    {}
  ],
  "rowFilterPolicyItems": [
    {}
  ],
  "dataMaskPolicyItems": [
    {}
  ],
  "policyPriority": 0,
  "isDenyAllElse": false,
  "policyLabels": [
    "<string>"
  ],
  "description": ""
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

policy_id
integer
required

Ranger policy ID.

Response

Successful Response

policy_id
integer
required

Ranger policy ID.

policy_name
string
required

Ranger policy name.

service
string
required

Ranger service name.

resources
Resources · object
required

Policy resource definitions.

policyType
integer
default:0

0=ACCESS, 1=MASKING, 2=ROWFILTER.

isEnabled
boolean
default:true
isAuditEnabled
boolean
default:true
policyItems
Policyitems · object[]

Allow access items.

denyPolicyItems
Denypolicyitems · object[]

Deny access items.

allowExceptions
Allowexceptions · object[]

Allow exception items.

denyExceptions
Denyexceptions · object[]

Deny exception items.

rowFilterPolicyItems
Rowfilterpolicyitems · object[]

Row filter items.

dataMaskPolicyItems
Datamaskpolicyitems · object[]

Masking items.

policyPriority
integer
default:0

0=NORMAL, 1=OVERRIDE.

isDenyAllElse
boolean
default:false
policyLabels
string[]

Policy labels.

description
string
default:""