---
title: Filter objects
description: The required filters array defines a list of filters to be processed on each router request. Filters are processed in the order in which they are specified in this array, and have the following configuration:
component: pingoneaic
page_id: pingoneaic:idm-scripting:filter-objects
canonical_url: https://docs.pingidentity.com/pingoneaic/idm-scripting/filter-objects.html
---

# Filter objects

The required filters array defines a list of filters to be processed on each router request. Filters are processed in the order in which they are specified in this array, and have the following configuration:

```json
{
  "pattern": string,
  "methods": [ string, ... ],
  "condition": script object,
  "onRequest": script object,
  "onResponse": script object,
  "onFailure": script object
}
```

* pattern

  string, optional

  Specifies a regular expression pattern matching the JSON pointer of the object to trigger scripts. If not specified, all identifiers (including `null`) match. Pattern matching is done on the resource name, rather than on individual objects.

* methods

  array of strings, optional

  One or more methods for which the script(s) should be triggered. Supported methods are: `"create"`, `"read"`, `"update"`, `"delete"`, `"patch"`, `"query"`, `"action"`. If not specified, all methods are matched.

* condition

  script object, optional

  Specifies a script that is called first to determine if the script should be triggered. If the condition yields `"true"`, the other script(s) are executed. If no condition is specified, the script(s) are called unconditionally.

* onRequest

  script object, optional

  Specifies a script to execute before the request is dispatched to the resource. If the script throws an exception, the method is not performed, and a client error response is provided.

* onResponse

  script object, optional

  Specifies a script to execute after the request is successfully dispatched to the resource and a response is returned. Throwing an exception from this script does not undo the method already performed.

* onFailure

  script object, optional

  Specifies a script to execute if the request resulted in an exception being thrown. Throwing an exception from this script does not undo the method already performed.