Inspect permissions

See each role's effective table permissions and column masks, including inherited permissions.

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

Understand permissions after role inheritanceThe matrix explains access without running a query as that role.

Choose objects to inspectSelect tables or inspect the available scope.
Resolve role permissionsInclude inherited privileges and column masks.
Review the access matrixCompare effective permissions by role and object.

Before you start

Use your database bearer token.

Connection setup

Use an identity authorized to manage access in this tenant.

Path parameters

Field	Type	Required
`tenant`	`string`	Required

Query parameters

Field	Type	Required
`objects`	`string`	Optional

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

For each object, roles shows effective privileges and masked columns, including inherited permissions. Use this to review access; it does not execute a query as the role.

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/matrix?objects=demo.people" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "objects": [
    {
      "object": "demo.people",
      "roles": {
        "demo_reader": {
          "priv": "S",
          "masked": []
        }
      }
    }
  ]
}

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

Query parametersCopy Anchor Link

HeadersCopy Anchor Link