List of Conditions (Globally)

GET /policy/conditions

List of Conditions (Globally)

cURL

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

200

{
  "current_page": 2,
  "data": [
    {
      "id": "<string>",
      "is_imported": true,
      "type": "attribute",
      "resource_id": "<string>",
      "profile_key": "<string>",
      "profile_operator": "equals",
      "profile_value": "<string>",
      "description": "<string>",
      "timestamp": {
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      },
      "count": {
        "workspace_logs_parent": 123,
        "workspace_logs_record": 123,
        "workspace_logs_related": 123
      },
      "included": {
        "policy_ruleset": "<unknown>",
        "policy_rule": "<unknown>",
        "resource": "<unknown>",
        "directory_attribute": "<unknown>",
        "directory_user": "<unknown>",
        "manager_user": "<unknown>",
        "workspace_integration": "<unknown>"
      },
      "links": {
        "self": "<string>",
        "policy_rule": "<string>",
        "policy_ruleset": "<string>",
        "directory_attribute": "<string>",
        "directory_user": "<string>",
        "manager_user": "<string>",
        "workspace_integration": "<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.

Query Parameters

sort · string · default: profile_key

Available sorts are id, policy_ruleset_id, policy_rule_id, directory_attribute_id, manager_id, workspace_integration_id, directory_user_id, is_imported, type, profile_key, profile_operator, profile_value, created_at, updated_at, deleted_at, -id, -ruleset_id, -rule_id, -attribute_id, -manager_id, -source_id, -user_id, -is_imported, -type, -profile_key, -profile_operator, -profile_value, -created_at, -updated_at, -deleted_at. You can sort by multiple options by separating them with a comma. To sort in descending order, use - sign in front of the sort, for example: -id.

include · string

Available includes are directory_attribute, directory_attribute-count, directory_attribute-exists, manager_user, manager_user-count, manager_user-exists, policy_ruleset, policy_ruleset-count, policy_ruleset-exists, workspace_integration, workspace_integration-count, workspace_integration-exists, directory_user, directory_user-count, directory_user-exists. You can include multiple options by separating them with a comma.

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[policy_ruleset_id] · string

filter[directory_attribute_id] · string

filter[manager_id] · string

filter[workspace_integration_id] · string

filter[directory_user_id] · string

filter[is_imported] · string

filter[type] · string

filter[profile_key] · string

filter[profile_operator] · string

filter[profile_value] · string

filter[profile_value_search] · string

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).

filter · string

page · string

filter[id_search] · string

Filter by an partial match of the condition ID

filter[policy_rule_id] · string

Filter by an exact match of the policy rule ID

Response

200

application/json

Paginated set of PolicyConditionDetailedResponseData

current_page · integer · required

Required range: x >= 1

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