Update policy rule settings | API Reference

POST

/v1/mgmt/policies/settings/update

Authorization

Descope Project ID and Management Key

AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

defaultAction decides the verdict when rules target the resource but none matches. An unconfigured project reports the empty value; updates must pick allow or block — the choice is one-way and cannot return to unset.

Update the project-level policy rule settings. defaultAction is allow or block; the choice is one-way and cannot be reset to the unconfigured state.

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

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

ResponseOK

{
  "settings": {
    "defaultAction": "string",
    "version": "string"
  }
}

{  "settings": {    "defaultAction": "string",    "version": "string"  }}

TypeScript

export interface Response {
settings?: PolicyRuleSettings
}
/**
 * defaultAction decides the verdict when rules target the resource but none
 *  matches. An unconfigured project reports the empty value; updates must pick
 *  allow or block — the choice is one-way and cannot return to unset.
 */
export interface PolicyRuleSettings {
defaultAction?: string
version?: string
}

export interface Response {settings?: PolicyRuleSettings}/** * defaultAction decides the verdict when rules target the resource but none *  matches. An unconfigured project reports the empty value; updates must pick *  allow or block — the choice is one-way and cannot return to unset. */export interface PolicyRuleSettings {defaultAction?: stringversion?: string}

Was this helpful?

Authorization

Request Body