List registered policies

Overview

Retrieve a paginated list of all registered policies under your profile, with optional filtering by status and name.

List Registered Policies

Endpoint: GET /policy/list-policies

Authentication: Required (Authorization token obtained from the step)

Query Parameters

Parameter	Type	Required	Description
`page`	integer	No	Page number for pagination
`perPage`	integer	No	Number of policies per page
`filters[active]`	boolean	No	Filter by active (`true`) or inactive (`false`) status. Omit to return both
`filters[name]`	string	No	Filter by policy name

Use Case

Use this endpoint to retrieve all policies registered under your profile, regardless of active/inactive state. This provides a comprehensive view of your authorization configuration.

The response includes for each policy:

Policy identifier and name

Active/inactive status

Template used to create the policy

Events that trigger the policy

Configuration parameters

Associated voting configuration

Voting attributes

This is useful for:

Comprehensive policy inventory and auditing

Managing large numbers of policies with pagination

Finding specific policies by name

Filtering policies by state (active/inactive)

Understanding complete authorization landscape

Filter Examples:

filters[active]=true - Only active policies

filters[active]=false - Only inactive policies

filters[name]=login-mfa-policy - Policies matching name

Omit filters - All registered policies

Returns both active and inactive policies unless filtered
Use pagination for profiles with many policies
Filter by active state to focus on enforced vs. suspended policies
Filter by name to find specific policies quickly
Combine filters to narrow results

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "items": [
        {
            "id": "example_policy_id",
            "name": "example_name",
            "policyId": "template_id",
            "votingConfigurationId": "245ce32f-e838-42ad-92ed-df93dbe0edab",
            "configuration": [
                "string"
            ],
            "active": 1,
            "applyingEventIds": [
                "string"
            ],
            "createdAt": "2025-02-10T10:03:06+00:00"
        }
    ],
    "meta": {
        "page": 1,
        "perPage": 25,
        "count": 1,
        "maxPage": 1
    }
}

🟠401401

🟠422422

List registered policies

Overview#