List of Global Manifest Users

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

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

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

{
  "current_page": 2,
  "data": [
    {
      "id": "pousr_01hq8xyzabc123def456ghi789",
      "state": "staged",
      "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": {
        "audit_logs_parent": 123,
        "audit_logs_record": 123
      },
      "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_rule": {
          "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_ruleset": {
          "id": "poset_01hq8xyzabc123def456ghi789",
          "state": "unmanaged",
          "type": "directory_attribute",
          "resource_id": "dratr_01hq8xyzabc123def456ghi789",
          "is_authoritative": false,
          "expires_after_days": 30
        }
      },
      "links": {
        "self": "https://ws-a1b2c3.provisionr.io/api/v1/policy/users/pousr_01hq8xyzabc123def456ghi789"
      }
    }
  ],
  "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

users

List of Global Manifest Users

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

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

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

{
  "current_page": 2,
  "data": [
    {
      "id": "pousr_01hq8xyzabc123def456ghi789",
      "state": "staged",
      "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": {
        "audit_logs_parent": 123,
        "audit_logs_record": 123
      },
      "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_rule": {
          "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_ruleset": {
          "id": "poset_01hq8xyzabc123def456ghi789",
          "state": "unmanaged",
          "type": "directory_attribute",
          "resource_id": "dratr_01hq8xyzabc123def456ghi789",
          "is_authoritative": false,
          "expires_after_days": 30
        }
      },
      "links": {
        "self": "https://ws-a1b2c3.provisionr.io/api/v1/policy/users/pousr_01hq8xyzabc123def456ghi789"
      }
    }
  ],
  "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

string

page

string

filter[id]

string

Filter by Policy User ID

filter[policy_ruleset_id]

string

Filter by Policy Ruleset ID

filter[policy_rule_id]

string

Filter by Policy Rule ID

filter[directory_user_id]

string

Filter by Directory User ID

filter[state]

string

Filter by state (staged, active, expiring, expired, deactivated)

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)

sort

enum<string>[]

Sort by field (prefix with - for descending)

Available options:

id,

-id,

policy_ruleset_id,

-policy_ruleset_id,

policy_rule_id,

-policy_rule_id,

directory_user_id,

-directory_user_id,

state,

-state,

-id,

--id,

-ruleset_id,

--ruleset_id,

-rule_id,

--rule_id,

-user_id,

--user_id,

-state,

--state

Response

Paginated set of PolicyUserDetailedResponseData

current_page

integer

required

Required range: x >= 1

data

PolicyUserDetailedResponseData · 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 Global Manifest Users

Authorizations

Query Parameters

Response