---
title: ScriptableFilter
description: Processes requests and responses by executing a Groovy script. Executed scripts must return one of the following:
component: pinggateway
version: 2023.11
page_id: pinggateway:reference:ScriptableFilter
canonical_url: https://docs.pingidentity.com/pinggateway/2026/reference/ScriptableFilter.html
llms_txt: https://docs.pingidentity.com/pinggateway/llms.txt
docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md
revdate: 2025-06-03T11:21:31Z
superseded_by: https://docs.pingidentity.com/pinggateway/2026/reference/ScriptableFilter.html
section_ids:
  ScriptableFilter-usage: Usage
  ScriptableFilter-properties: Properties
  ScriptableFilter-examples: Examples
  ScriptableFilter-moreinfo: More information
---

# ScriptableFilter

Processes requests and responses by executing a Groovy script. Executed scripts must return one of the following:

* [Promise\<Response, NeverThrowsException>](../_attachments/apidocs/org/forgerock/util/promise/Promise.html)

* [Response](../_attachments/apidocs/org/forgerock/http/protocol/Response.html)

To execute the next element in a chain (a filter or a handler), the script must call the expression `next.handle(context, request)`. If the script does not call `next.handle(context, request)`, the chain flow breaks and the script has to build and return its own response by calling one of the following expressions:

* `return myResponse`

* `return newResultPromise(myResponse)`

Actions on the response returned from the downstream flow must be performed in the Promise's callback methods.

For information about script properties, available global objects, and automatically imported classes, refer to [Scripts](Scripts.html). For information about creating scriptable objects in Studio, refer to [Scripts in Studio](../configure/extending.html#scripting-studio) and [Configure scriptable throttling](../gateway-guide/throttling.html#throttling-scriptable).

## Usage

```json
{
    "name": string,
    "type": "ScriptableFilter",
    "config": {
        "type": configuration expression<string>,
        "file": configuration expression<string>, // Use either "file"
        "source": [ string, ... ],                // or "source", but not both.
        "args": map,
        "clientHandler": Handler reference
    }
}
```

## Properties

For information about properties for ScriptableFilter, refer to [Scripts](Scripts.html).

## Examples

For an example scriptable filter that recovers policy advices from AM, see the `failureHandler` property of [PolicyEnforcementFilter](Filters.html#PolicyEnforcementFilter).

## More information

[Scripts](Scripts.html)

[org.forgerock.openig.filter.ScriptableFilter](../_attachments/apidocs/org/forgerock/openig/filter/ScriptableFilter.html)