List Campaign Filters
GET/campaign-filters
Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters.
Request
Query Parameters
Possible values: <= 250
Default value: 250
Max number of results to return. See V3 API Standard Collection Parameters for more information.
Default value: 0
Start/Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
Default value: true
If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true.
Responses
- 200
- 400
- 401
- 403
- 429
- 500
List of campaign filter objects.
- application/json
- Schema
- Example (from schema)
- Example
Schema
Array [
Array [
]
]
items
object[]
List of campaign filters.
The unique ID of the campaign filter
Campaign filter name.
Campaign filter description.
Owner of the filter. This field automatically populates at creation time with the current user.
Possible values: [INCLUSION
, EXCLUSION
]
Mode/type of filter, either the INCLUSION or EXCLUSION type. The INCLUSION type includes the data in generated campaigns as per specified in the criteria, whereas the EXCLUSION type excludes the data in generated campaigns as per specified in criteria.
criteriaList
object[]
List of criteria.
Possible values: [COMPOSITE
, ROLE
, IDENTITY
, IDENTITY_ATTRIBUTE
, ENTITLEMENT
, ACCESS_PROFILE
, SOURCE
, ACCOUNT
, AGGREGATED_ENTITLEMENT
, INVALID_CERTIFIABLE_ENTITY
]
Type of the criteria in the filter. The COMPOSITE
filter can contain multiple filters in an AND/OR relationship.
Possible values: [EQUALS
, NOT_EQUALS
, CONTAINS
, STARTS_WITH
, ENDS_WITH
, AND
, OR
, null
]
Operation on a specific criteria
Specified key from the type of criteria.
Value for the specified key from the type of criteria.
If true, the filter is created by the system. If false, the filter is created by a user.
Number of filters returned.
{
"items": [
{
"id": "5ec18cef39020d6fd7a60ad3970aba61",
"name": "Identity Attribute Campaign Filter",
"description": "Campaign filter to certify data based on an identity attribute's specified property.",
"owner": "SailPoint Support",
"mode": "INCLUSION",
"criteriaList": [
{
"type": "IDENTITY_ATTRIBUTE",
"property": "displayName",
"value": "support",
"operation": "CONTAINS",
"negateResult": false,
"shortCircuit": false,
"recordChildMatches": false,
"id": null,
"suppressMatchedItems": false,
"children": null
}
],
"isSystemFilter": false
}
],
"count": 2
}
{
"items": [
{
"id": "5b8a2ba86393dd174495c4436dd76b25",
"name": "IdentityAttribute Inclusion Campaign Filter",
"description": "IdentityAttribute Inclusion Campaign Filter",
"owner": "SailPoint Support",
"mode": "INCLUSION",
"criteriaList": [
{
"type": "IDENTITY_ATTRIBUTE",
"property": "displayName",
"value": "#",
"operation": "CONTAINS",
"negateResult": false,
"shortCircuit": false,
"recordChildMatches": false,
"id": null,
"suppressMatchedItems": false,
"children": null
}
],
"isSystemFilter": false
},
{
"id": "e9f9a1397b842fd5a65842087040d3ac",
"name": "Exclusion Campaign Filter",
"description": "Campaign filter for Exclusion update",
"owner": "SailPoint Support",
"mode": "EXCLUSION",
"criteriaList": [
{
"type": "IDENTITY_ATTRIBUTE",
"property": "displayName",
"value": "#@",
"operation": "CONTAINS",
"negateResult": false,
"shortCircuit": false,
"recordChildMatches": false,
"id": null,
"suppressMatchedItems": false,
"children": null
}
],
"isSystemFilter": false
}
],
"count": 2
}
Client Error - Returned if the request body is invalid.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
causes
object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
{
"error": "JWT validation failed: JWT is expired"
}
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
- application/json
- Schema
- Example (from schema)
- 403
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
causes
object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
An example of a 403 response object
{
"detailCode": "403 Forbidden",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The server understood the request but refuses to authorize it."
}
]
}
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
{
"message": " Rate Limit Exceeded "
}
Internal Server Error - Returned if there is an unexpected error.
- application/json
- Schema
- Example (from schema)
- 500
Schema
Array [
]
Array [
]
Fine-grained error code providing more detail of the error.
Unique tracking id for the error.
messages
object[]
Generic localized reason for error
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
causes
object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
The locale for the message text, a BCP 47 language tag.
Possible values: [DEFAULT
, REQUEST
, null
]
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Actual text of the error message in the indicated locale.
{
"detailCode": "400.1 Bad Request Content",
"trackingId": "e7eab60924f64aa284175b9fa3309599",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
],
"causes": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "The request was syntactically correct but its content is semantically invalid."
}
]
}
An example of a 500 response object
{
"detailCode": "500.0 Internal Fault",
"trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "An internal fault occurred."
}
]
}