List of Rules (Ruleset)

curl --request GET \
  --url https://wksusa1b2c3d.provisionr.app/api/v1/policy/rulesets/{ruleset}/rules \
  --header 'Authorization: Bearer <token>'

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$response = Invoke-WebRequest -Uri 'https://wksusa1b2c3d.provisionr.app/api/v1/policy/rulesets/{ruleset}/rules' -Method GET -Headers $headers

import requests

url = "https://wksusa1b2c3d.provisionr.app/api/v1/policy/rulesets/{ruleset}/rules"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://wksusa1b2c3d.provisionr.app/api/v1/policy/rulesets/{ruleset}/rules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "current_page": 2,
  "data": [
    {
      "id": "porul_01hq8xyzabc123def456ghi789",
      "state": "active",
      "role_name": "Group Member",
      "role_handle": "member",
      "is_imported": true,
      "description": "<string>",
      "metadata": [
        "<string>"
      ],
      "expires_after_days": 123,
      "expires_after_days_inherited": true,
      "priority": 42,
      "timestamp": {
        "created_at": "2025-01-28T13:37:00Z",
        "updated_at": "2025-05-04T03:27:00Z",
        "activated_at": "2025-03-14T15:07:00Z",
        "expires_at": null,
        "deleted_at": null
      },
      "count": {
        "policy_conditions": 123,
        "manifest_users": 123,
        "qualified_users": 123,
        "staged_users": 123,
        "audit_logs_parent": 123,
        "audit_logs_record": 123,
        "audit_logs_related": 123
      },
      "included": {
        "policy_conditions": [
          {
            "id": "pocon_01hq8xyzabc123def456ghi789",
            "is_imported": true,
            "type": "attribute",
            "ruleset_id": "poset_01hq8xyzabc123def456ghi789",
            "rule_id": "porul_01hq8xyzabc123def456ghi789",
            "resource_id": "dratr_01hq8xyzabc123def456ghi789",
            "profile_key": "department",
            "profile_operator": "equals",
            "profile_value": "IT Helpdesk",
            "description": "<string>"
          }
        ],
        "policy_role": {
          "id": "<string>"
        },
        "policy_ruleset": {
          "id": "poset_01hq8xyzabc123def456ghi789",
          "state": "unmanaged",
          "type": "directory_attribute",
          "resource_id": "dratr_01hq8xyzabc123def456ghi789",
          "is_authoritative": false,
          "expires_after_days": 30
        }
      },
      "links": {
        "self": "<string>",
        "policy_conditions": "<string>",
        "policy_ruleset": "<string>",
        "policy_resource": "<string>",
        "manifest_users": "<string>",
        "qualified_users": "<string>",
        "staged_users": "<string>",
        "audit_logs_parent": "<string>",
        "audit_logs_record": "<string>",
        "audit_logs_related": "<string>"
      }
    }
  ],
  "first_page_url": "<string>",
  "from": 2,
  "last_page_url": "<string>",
  "last_page": 2,
  "links": [
    {
      "url": "<string>",
      "label": "<string>",
      "active": true
    }
  ],
  "next_page_url": "<string>",
  "path": "<string>",
  "per_page": 1,
  "prev_page_url": "<string>",
  "to": 2,
  "total": 1
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

GET

policy

rulesets

{ruleset}

rules

List of Rules (Ruleset)

curl --request GET \
  --url https://wksusa1b2c3d.provisionr.app/api/v1/policy/rulesets/{ruleset}/rules \
  --header 'Authorization: Bearer <token>'

$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$response = Invoke-WebRequest -Uri 'https://wksusa1b2c3d.provisionr.app/api/v1/policy/rulesets/{ruleset}/rules' -Method GET -Headers $headers

import requests

url = "https://wksusa1b2c3d.provisionr.app/api/v1/policy/rulesets/{ruleset}/rules"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://wksusa1b2c3d.provisionr.app/api/v1/policy/rulesets/{ruleset}/rules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "current_page": 2,
  "data": [
    {
      "id": "porul_01hq8xyzabc123def456ghi789",
      "state": "active",
      "role_name": "Group Member",
      "role_handle": "member",
      "is_imported": true,
      "description": "<string>",
      "metadata": [
        "<string>"
      ],
      "expires_after_days": 123,
      "expires_after_days_inherited": true,
      "priority": 42,
      "timestamp": {
        "created_at": "2025-01-28T13:37:00Z",
        "updated_at": "2025-05-04T03:27:00Z",
        "activated_at": "2025-03-14T15:07:00Z",
        "expires_at": null,
        "deleted_at": null
      },
      "count": {
        "policy_conditions": 123,
        "manifest_users": 123,
        "qualified_users": 123,
        "staged_users": 123,
        "audit_logs_parent": 123,
        "audit_logs_record": 123,
        "audit_logs_related": 123
      },
      "included": {
        "policy_conditions": [
          {
            "id": "pocon_01hq8xyzabc123def456ghi789",
            "is_imported": true,
            "type": "attribute",
            "ruleset_id": "poset_01hq8xyzabc123def456ghi789",
            "rule_id": "porul_01hq8xyzabc123def456ghi789",
            "resource_id": "dratr_01hq8xyzabc123def456ghi789",
            "profile_key": "department",
            "profile_operator": "equals",
            "profile_value": "IT Helpdesk",
            "description": "<string>"
          }
        ],
        "policy_role": {
          "id": "<string>"
        },
        "policy_ruleset": {
          "id": "poset_01hq8xyzabc123def456ghi789",
          "state": "unmanaged",
          "type": "directory_attribute",
          "resource_id": "dratr_01hq8xyzabc123def456ghi789",
          "is_authoritative": false,
          "expires_after_days": 30
        }
      },
      "links": {
        "self": "<string>",
        "policy_conditions": "<string>",
        "policy_ruleset": "<string>",
        "policy_resource": "<string>",
        "manifest_users": "<string>",
        "qualified_users": "<string>",
        "staged_users": "<string>",
        "audit_logs_parent": "<string>",
        "audit_logs_record": "<string>",
        "audit_logs_related": "<string>"
      }
    }
  ],
  "first_page_url": "<string>",
  "from": 2,
  "last_page_url": "<string>",
  "last_page": 2,
  "links": [
    {
      "url": "<string>",
      "label": "<string>",
      "active": true
    }
  ],
  "next_page_url": "<string>",
  "path": "<string>",
  "per_page": 1,
  "prev_page_url": "<string>",
  "to": 2,
  "total": 1
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

ruleset

string

required

Policy Ruleset ID

Query Parameters

page[size]

integer

default:500

The number of results that will be returned per page.

page[number]

integer

The page number to start the pagination from.

sort

enum<string>[]

Available options:

policy_ruleset_id,

-policy_ruleset_id,

is_imported,

-is_imported,

state,

-state,

-ruleset_id,

--ruleset_id,

-is_imported,

--is_imported,

-state,

--state

include

enum<string>[]

Available options:

policy_conditions,

policy_conditions-count,

policy_conditions-exists,

policy_ruleset,

policy_ruleset-count,

policy_ruleset-exists

filter

string

page

string

filter[policy_ruleset_id]

string

Filter by an exact match of the policy ruleset ID

filter[is_imported]

string

Filter by whether the rule was auto-imported

filter[state]

string

Filter by an exact match of the state field

filter[description_search]

string

Filter by a partial match of the description field

filter[metadata_search]

string

Filter by searching custom metadata key/value pairs for any partial string match

filter[created_before]

string

Filter by created before date

filter[created_after]

string

Filter by created after date

filter[updated_before]

string

Filter by updated before date

filter[updated_after]

string

Filter by updated after date

filter[expires_before]

string

Filter by expires before date

filter[expires_after]

string

Filter by expires after date

filter[deactivated_before]

string

Filter by deactivated before date

filter[deactivated_after]

string

Filter by deactivated after date

filter[deleted_before]

string

Filter by deleted before date

filter[deleted_after]

string

Filter by deleted after date

filter[trashed]

string

Include trashed records (with, only, without)

Response

Paginated set of PolicyRuleDetailedResponseData

current_page

integer

required

Required range: x >= 1

data

PolicyRuleDetailedResponseData · object[]

required

Show child attributes

first_page_url

string | null

required

from

integer | null

required

Required range: x >= 1

last_page_url

string | null

required

last_page

integer

required

Required range: x >= 1

links

object[]

required

Generated paginator links.

Show child attributes

next_page_url

string | null

required

path

string | null

required

Base path for paginator generated URLs.

per_page

integer

required

Number of items shown per page.

Required range: x >= 0

prev_page_url

string | null

required

integer | null

required

Number of the last item in the slice.

Required range: x >= 1

total

integer

required

Total number of items being paginated.

Required range: x >= 0

Getting Started

Endpoints

List of Rules (Ruleset)

Authorizations

Path Parameters

Query Parameters

Response