Skip to main content
GET
/
policy
/
rulesets
/
{ruleset}
/
staged-users
List of Ruleset Staged Users
curl --request GET \
  --url https://wks-a1b2c3d4.provisionr.io/api/v1/policy/rulesets/{ruleset}/staged-users \
  --header 'Authorization: Bearer <token>'
{
  "current_page": 2,
  "data": [
    {
      "state": "<string>",
      "directory_user": {
        "id": "<string>",
        "state": "staged",
        "manager_id": "<string>",
        "is_manager": true,
        "full_name": "<string>",
        "email": "<string>",
        "username": "<string>",
        "org": {},
        "metadata": {}
      },
      "policy_rule": {
        "id": "<string>",
        "state": "staged",
        "role_name": "<string>",
        "role_handle": "<string>",
        "is_imported": true,
        "description": "<string>",
        "expires_after_days": 123,
        "expires_after_days_inherited": true,
        "priority": 123
      },
      "policy_ruleset": {
        "id": "<string>",
        "state": "unmanaged",
        "type": "directory_attribute",
        "resource_id": "<string>",
        "is_authoritative": true,
        "expires_after_days": 123
      },
      "links": {
        "directory_user": "<string>",
        "policy_rule": "<string>",
        "policy_ruleset": "<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
}

Documentation Index

Fetch the complete documentation index at: https://docs.provisionr.io/llms.txt

Use this file to discover all available pages before exploring further.

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
string
default:policy_rule_id

Sort by field (prefix with - for descending)

​
filter
string
​
page
string
​
filter[policy_rule_id]
string

Filter by Policy Rule ID

​
filter[directory_user_id]
string

Filter by Directory User ID

Response

Paginated set of PolicyRuleUserResponse

​
current_page
integer
required
Required range: x >= 1
​
data
PolicyRuleUserResponse · object[]
required
​
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.

​
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
​
to
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