List of Admins (Ruleset)

GET /policy/rulesets/{ruleset}/admins

List of Admins (Ruleset)

cURL

curl --request GET \
  --url https://wks-a1b2c3d4.provisionr.io/api/v1/policy/rulesets/{ruleset}/admins \
  --header 'Authorization: Bearer <token>'

200

{
  "current_page": 2,
  "data": [
    {
      "id": "<string>",
      "state": "staged",
      "role": "admin",
      "count": {
        "workspace_logs_parent": 123,
        "workspace_logs_record": 123,
        "workspace_logs_related": 123
      },
      "included": {
        "directory_user": {
          "id": "<string>",
          "state": "staged",
          "manager_id": "<string>",
          "is_manager": true,
          "full_name": "<string>",
          "email": "<string>",
          "username": "<string>",
          "org": {},
          "metadata": {}
        },
        "policy_ruleset": {
          "id": "<string>",
          "state": "unmanaged",
          "type": "directory_attribute",
          "resource_id": "<string>",
          "is_authoritative": true,
          "expires_after_days": 123
        }
      },
      "timestamp": {
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "activated_at": "2023-11-07T05:31:56Z",
        "expires_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      },
      "links": {
        "directory_user": "<string>",
        "policy_ruleset": "<string>",
        "self": "<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
}

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.

include · string

Include related resources (ruleset, user)

filter · string

page · string

sort · string

filter[id] · string

Filter by Policy Ruleset Admin ID

filter[directory_user_id] · string

Filter by Directory User ID

filter[role] · string

Filter by admin role (admin, audit, create, activate)

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)

Response

200

application/json

Paginated set of PolicyRulesetAdminDetailedResponseData

current_page · integer · required

Required range: x >= 1

data · PolicyRulesetAdminDetailedResponseData · 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

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