Search policy rules | API Reference | Descope Documentation

POST

/v1/mgmt/policies/rule/search

Authorization

Descope Project ID and Management Key

AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Request Body

application/json

searchFields?array<SearchField>

batchSize?integer

Formatint32

page?integer

Formatint32

text?string

sort?array<projectv1.SortField>

ruleFamily?array<string>

string

actionKind?array<string>

string

effect?array<string>

string

principalType?array<string>

string

resourceType?array<string>

string

enabled?boolean

Search policy rule rows by filters (text, action_kind, effect, principal_type, resource_type, enabled). Paged and sorted.

curl -X POST "https://api.descope.com/v1/mgmt/policies/rule/search" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X POST "https://api.descope.com/v1/mgmt/policies/rule/search" \  -H "Content-Type: application/json" \  -d '{}'

ResponseOK

{
  "policyRules": [
    {
      "id": "string",
      "version": "string",
      "name": "string",
      "description": "string",
      "enabled": true,
      "ruleFamily": "string",
      "actionKinds": [
        "string"
      ],
      "effect": "string",
      "principalType": "string",
      "principalSelector": [
        "string"
      ],
      "resourceTargets": [
        {
          "type": "string",
          "allOfType": true,
          "ids": [
            "string"
          ]
        }
      ],
      "grants": [
        {
          "scopes": [
            "string"
          ],
          "allowedAudiences": [
            "string"
          ]
        }
      ],
      "conditions": "string",
      "cedarText": "string",
      "createdTime": 0,
      "modifiedTime": 0
    }
  ],
  "total": 0
}

{  "policyRules": [    {      "id": "string",      "version": "string",      "name": "string",      "description": "string",      "enabled": true,      "ruleFamily": "string",      "actionKinds": [        "string"      ],      "effect": "string",      "principalType": "string",      "principalSelector": [        "string"      ],      "resourceTargets": [        {          "type": "string",          "allOfType": true,          "ids": [            "string"          ]        }      ],      "grants": [        {          "scopes": [            "string"          ],          "allowedAudiences": [            "string"          ]        }      ],      "conditions": "string",      "cedarText": "string",      "createdTime": 0,      "modifiedTime": 0    }  ],  "total": 0}

TypeScript

export interface Response {
policyRules?: PolicyRule[]
total?: number
}
export interface PolicyRule {
id?: string
version?: string
name?: string
description?: string
enabled?: boolean
ruleFamily?: string
actionKinds?: string[]
effect?: string
principalType?: string
principalSelector?: string[]
resourceTargets?: RuleResourceTarget[]
grants?: PolicyRuleGrant[]
conditions?: string
cedarText?: string
/**
 * int32 epoch seconds: proto3 emits int64 as JSON string. See .claude/rules/proto-files.md.
 */
createdTime?: number
modifiedTime?: number
}
/**
 * RuleResourceTarget identifies a Resource subset for an PolicyRule. A
 *  target with AllOfType=true matches every resource of Type; otherwise the
 *  IDs list enumerates the specific resources.
 */
export interface RuleResourceTarget {
type?: string
allOfType?: boolean
ids?: string[]
}
export interface PolicyRuleGrant {
scopes?: string[]
allowedAudiences?: string[]
}

export interface Response {policyRules?: PolicyRule[]total?: number}export interface PolicyRule {id?: stringversion?: stringname?: stringdescription?: stringenabled?: booleanruleFamily?: stringactionKinds?: string[]effect?: stringprincipalType?: stringprincipalSelector?: string[]resourceTargets?: RuleResourceTarget[]grants?: PolicyRuleGrant[]conditions?: stringcedarText?: string/** * int32 epoch seconds: proto3 emits int64 as JSON string. See .claude/rules/proto-files.md. */createdTime?: numbermodifiedTime?: number}/** * RuleResourceTarget identifies a Resource subset for an PolicyRule. A *  target with AllOfType=true matches every resource of Type; otherwise the *  IDs list enumerates the specific resources. */export interface RuleResourceTarget {type?: stringallOfType?: booleanids?: string[]}export interface PolicyRuleGrant {scopes?: string[]allowedAudiences?: string[]}

Was this helpful?