Skip to main content
GET
/
policies
/
{idOrName}
{
  "environment_id": "ENV01FXJJFRNH8J1RBX7CCV2APD1M",
  "id": "POL01FXJJFRNH8J1RBX7CCV2APD1G",
  "name": "multi_tenant_policy",
  "permissions": [
    "query"
  ],
  "query_rules": [
    {
      "tables": [
        "users",
        "orders"
      ],
      "columns": [
        {
          "allow": [
            "id",
            "email",
            "name"
          ],
          "deny": [
            "password",
            "ssn"
          ]
        }
      ],
      "rows": "tenant_id = '123'"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z"
}

Path Parameters

​
idOrName
string
required

The ID or name of the policy to retrieve.

Response

200 - application/json

The request has succeeded.

​
environment_id
string
required
Example:

"ENV01FXJJFRNH8J1RBX7CCV2APD1M"

​
id
string
required
Example:

"POL01FXJJFRNH8J1RBX7CCV2APD1G"

​
permissions
enum<string>[]
required
Example:
["query"]
​
query_rules
object[]
required
Example:
[
  {
    "tables": ["users", "orders"],
    "columns": [
      {
        "allow": ["id", "email", "name"],
        "deny": ["password", "ssn"]
      }
    ],
    "rows": "tenant_id = '123'"
  }
]
​
created_at
string<date-time>
required
​
name
string
Example:

"multi_tenant_policy"