List row policies

GET /v1/tenants/{tenant}/db/rls

Review the row filters stored for rolesUse the effective-policy endpoint for a particular user's view.

List stored row policiesRequest policies in the selected tenant.
Read each predicateMatch table, role and command to its row filter.
Check user-specific applicationReview effective policies for the intended user and table.

Before you start

Use your database bearer token.

Use an identity authorized to manage access in this tenant.

Path parameters

Field	Type	Required
`tenant`	`string`	Required

Headers

Field	Type	Required	Description
`x-oc-db-user`	`string`	Optional	Acting database user (role, grant and row-policy checks). Send with x-oc-db-key.
`x-oc-db-key`	`string`	Optional	API key of the x-oc-db-user user.

Read the result

policies shows the stored table, role, command and predicate for each row policy. Use the effective-policy endpoint to see how these policies apply to a particular user.

Response statuses

HTTP status reference

Status	What to do
200	OK
400	Correct the request before retrying.
401	Check the credential and Authorization header.
402	Check feature access or available credits.
403	Check tenant access, roles and permissions.
429	Honor Retry-After when present; back off.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request GET "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/db/rls" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "policies": [
    {
      "role": "demo_reader",
      "command": "select",
      "using": "score >= 20",
      "table": "demo.people"
    }
  ]
}

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

HeadersCopy Anchor Link

Read the resultCopy Anchor Link

Response statusesCopy Anchor Link

Before you start

Path parameters

Headers

Read the result

Response statuses