v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB

Policy Guards (EAP)

List Policy Guard Rules

List all rules for a Policy guard scope.

get/v2/policy_guards/scopes/{policy_guard_scope_id}/rules

Path parameters

policy_guard_scope_idstring required

Either the unique id of the policy_guard_scope, or the URL-friendly key of the policy_guard_scope (i.e: the "slug").

Query parameters

pageinteger

Page number of the results to fetch, starting at 1.

per_pageinteger

The number of results per page (max 100).

Response

Successful Response

is_allowedboolean required

If True, the permission will be allowed for the role in the policy guard across all projectswithin the policy scope, and the permission will be locked from further editing.

resource_keystring required

The key of the resource.

role_keystring

The key of the role.

action_keystring required

The key of the action.

scope_idstring uuid required

The unique identifier of the policy guard.

organization_idstring uuid required

Unique id of the organization that the ScopeConfig belongs to.

idstring uuid required

Unique id of the ScopeConfig

Example response

[
  {
    "id": "c3b6f5d7-8b1e-4c6d-9e9f-8c9d6f8e0c8f",
    "scope_id": "c3b6f5d7-8b1e-4c6d-9e9f-hgk4f8e0c8f",
    "resource_key": "document",
    "role_key": "admin",
    "action_key": "read",
    "is_allowed": true,
    "org_id": "c3b6f5d7-8b1e-4c6d-9e9f-8c9d6f8e0c8f",
    "resource_set": {
      "key": "country_condition",
      "attribute": "document_country",
      "operator": "equals",
      "value": "US"
    },
    "user_set": {
      "key": "city_condition",
      "attribute": "city",
      "operator": "equals",
      "value": "New York"
    }
  }
]