List of Rule Staged Users

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

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

import requests

url = "https://wksusa1b2c3d.provisionr.app/api/v1/policy/rules/{rule}/staged-users"

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/rules/{rule}/staged-users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "current_page": 2,
  "data": [
    {
      "state": "<string>",
      "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": {
        "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
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

GET

policy

rules

{rule}

staged-users

List of Rule Staged Users

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

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

import requests

url = "https://wksusa1b2c3d.provisionr.app/api/v1/policy/rules/{rule}/staged-users"

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/rules/{rule}/staged-users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "current_page": 2,
  "data": [
    {
      "state": "<string>",
      "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": {
        "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
}

{
  "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

rule

string

required

Policy Rule 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.

filter

string

page

string

filter[directory_user_id]

string

Filter by Directory User ID

sort

enum<string>[]

Sort by field (prefix with - for descending)

Available options:

policy_ruleset_id,

-policy_ruleset_id,

policy_rule_id,

-policy_rule_id,

directory_user_id,

-directory_user_id,

state,

-state,

-policy_ruleset_id,

--policy_ruleset_id,

-policy_rule_id,

--policy_rule_id,

-directory_user_id,

--directory_user_id,

-state,

--state

Response

Paginated set of PolicyRuleUserResponse

current_page

integer

required

Required range: x >= 1

data

PolicyRuleUserResponse · 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 Rule Staged Users

Authorizations

Path Parameters

Query Parameters

Response