List of Rulesets

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

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

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

{
  "current_page": 2,
  "data": [
    {
      "id": "poset_01hq8xyzabc123def456ghi789",
      "state": "unmanaged",
      "resource_type": "directory_attribute",
      "resource_id": "dratr_01hq8xyzabc123def456ghi789",
      "resource_parent": "Department",
      "resource_name": "Engineering",
      "resource_handle": "eng",
      "is_authoritative": false,
      "expires_after_days": 30,
      "count": {
        "policy_ruleset_admins": 123,
        "policy_conditions": 123,
        "policy_rules": 123,
        "manifest_users": 123,
        "qualified_users": 123,
        "staged_users": 123,
        "audit_logs_parent": 123,
        "audit_logs_record": 123,
        "audit_logs_related": 123
      },
      "included": {
        "policy_resource": "<unknown>",
        "policy_ruleset_admins": [
          {
            "id": "posaa_01hq8xyzabc123def456ghi789",
            "state": "staged",
            "role": "admin",
            "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
            },
            "included": {
              "directory_user": {
                "id": "drusr_01hq8xyzabc123def456ghi789",
                "state": "active",
                "manager_id": "drusr_01kam9z5z71f7r4hhrm2ydxkhn",
                "is_manager": true,
                "full_name": "Dade Murphy",
                "email": "[email protected]",
                "username": "dmurphy",
                "badge_id": "<string>",
                "employee_id": "<string>",
                "employee_alt_id": "<string>",
                "org": {
                  "cost_center": "CC-1234",
                  "department": "Infrastructure",
                  "division": "Engineering",
                  "title": "Senior Engineer"
                },
                "metadata": {
                  "custom_field_1": "value1",
                  "employee_type": "full-time",
                  "desk_number": "42"
                }
              },
              "policy_ruleset": {
                "id": "poset_01hq8xyzabc123def456ghi789",
                "state": "unmanaged",
                "type": "directory_attribute",
                "resource_id": "dratr_01hq8xyzabc123def456ghi789",
                "is_authoritative": false,
                "expires_after_days": 30
              }
            },
            "links": {
              "self": "<string>",
              "directory_user": "<string>",
              "policy_ruleset": "<string>"
            }
          }
        ],
        "policy_rules": [
          {
            "id": "porul_01hq8xyzabc123def456ghi789",
            "state": "active",
            "role_name": "Group Member",
            "role_handle": "member",
            "is_imported": true,
            "description": "<string>",
            "expires_after_days": 123,
            "expires_after_days_inherited": true,
            "priority": 42
          }
        ],
        "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>"
          }
        ]
      },
      "links": {
        "self": "<string>",
        "policy_resource": "<string>",
        "policy_ruleset_admins": "<string>",
        "policy_rules": "<string>",
        "policy_conditions": "<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>"
}

GET

policy

rulesets

List of Rulesets

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

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

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

{
  "current_page": 2,
  "data": [
    {
      "id": "poset_01hq8xyzabc123def456ghi789",
      "state": "unmanaged",
      "resource_type": "directory_attribute",
      "resource_id": "dratr_01hq8xyzabc123def456ghi789",
      "resource_parent": "Department",
      "resource_name": "Engineering",
      "resource_handle": "eng",
      "is_authoritative": false,
      "expires_after_days": 30,
      "count": {
        "policy_ruleset_admins": 123,
        "policy_conditions": 123,
        "policy_rules": 123,
        "manifest_users": 123,
        "qualified_users": 123,
        "staged_users": 123,
        "audit_logs_parent": 123,
        "audit_logs_record": 123,
        "audit_logs_related": 123
      },
      "included": {
        "policy_resource": "<unknown>",
        "policy_ruleset_admins": [
          {
            "id": "posaa_01hq8xyzabc123def456ghi789",
            "state": "staged",
            "role": "admin",
            "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
            },
            "included": {
              "directory_user": {
                "id": "drusr_01hq8xyzabc123def456ghi789",
                "state": "active",
                "manager_id": "drusr_01kam9z5z71f7r4hhrm2ydxkhn",
                "is_manager": true,
                "full_name": "Dade Murphy",
                "email": "[email protected]",
                "username": "dmurphy",
                "badge_id": "<string>",
                "employee_id": "<string>",
                "employee_alt_id": "<string>",
                "org": {
                  "cost_center": "CC-1234",
                  "department": "Infrastructure",
                  "division": "Engineering",
                  "title": "Senior Engineer"
                },
                "metadata": {
                  "custom_field_1": "value1",
                  "employee_type": "full-time",
                  "desk_number": "42"
                }
              },
              "policy_ruleset": {
                "id": "poset_01hq8xyzabc123def456ghi789",
                "state": "unmanaged",
                "type": "directory_attribute",
                "resource_id": "dratr_01hq8xyzabc123def456ghi789",
                "is_authoritative": false,
                "expires_after_days": 30
              }
            },
            "links": {
              "self": "<string>",
              "directory_user": "<string>",
              "policy_ruleset": "<string>"
            }
          }
        ],
        "policy_rules": [
          {
            "id": "porul_01hq8xyzabc123def456ghi789",
            "state": "active",
            "role_name": "Group Member",
            "role_handle": "member",
            "is_imported": true,
            "description": "<string>",
            "expires_after_days": 123,
            "expires_after_days_inherited": true,
            "priority": 42
          }
        ],
        "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>"
          }
        ]
      },
      "links": {
        "self": "<string>",
        "policy_resource": "<string>",
        "policy_ruleset_admins": "<string>",
        "policy_rules": "<string>",
        "policy_conditions": "<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>"
}

Authorizations

Authorization

string

header

required

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

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.

filter[created_before]

string

filter[created_after]

string

filter[updated_before]

string

filter[updated_after]

string

filter[deactivated_before]

string

filter[deactivated_after]

string

filter[deleted_before]

string

filter[deleted_after]

string

filter[trashed]

string

Can be a value of with (response will contain deleted items as well), only (will contain only deleted items), or any arbitrary value (will contain only not deleted items).

sort

enum<string>[]

Available options:

type,

-type,

resource_id,

-resource_id,

is_authoritative,

-is_authoritative,

sync_enabled,

-sync_enabled,

state,

-state,

-resource_type,

--resource_type,

-resource_id,

--resource_id,

-is_authoritative,

--is_authoritative,

-sync_enabled,

--sync_enabled,

-state,

--state

include

enum<string>[]

Available options:

rules,

rules-count,

rules-exists,

conditions,

conditions-count,

conditions-exists,

manifestUsers,

manifestUsers-count,

manifestUsers-exists,

qualifiedUsers,

qualifiedUsers-count,

qualifiedUsers-exists,

stagedUsers,

stagedUsers-count,

stagedUsers-exists,

users,

users-count,

users-exists

filter

string

page

string

filter[id]

string

Filter by an exact match of the ruleset ID

filter[type]

string

Filter by the type of ruleset

filter[resource_id]

string

Filter by an exact match of the resource ID

filter[is_authoritative]

string

Filter by whether the ruleset is authoritative

filter[sync_enabled]

string

Filter by whether sync is enabled

filter[state]

string

Filter by an exact match of the state field

Response

Paginated set of PolicyRulesetDetailedResponseData

current_page

integer

required

Required range: x >= 1

data

PolicyRulesetDetailedResponseData · 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 Rulesets

Authorizations

Query Parameters

Response