Configure Paging

Paging can be configured in Account/Entitlement Aggregation endpoints using the Paging tab with one of the following methods:

  • Paging based on limit-offset

  • Paging based on response markers

  • Paging based on response header links

Note
The Paging tab becomes available when you configure certain HTTP operations, such as account and entitlement aggregation. For more information on configuring Paging as an HTTP operation, refer to Paging.

Configuration Considerations

Consider the following while configuring paging in the Paging tab.

  • Every paging configuration step must start on a new line.

  • SailPoint recommends providing a <space> after every operator, condition, or placeholder for correct evaluation of the paging expression.

  • The paging mechanism follows the placeholder notation for resolution of attribute values:

    $response.attribute_key$

    Any attribute which follows the placeholder notation would be resolved or assigned a value depending upon the operator being used.

  • Intermediate values can also be stored between page requests by using the placeholder notation. In order to achieve this, any attribute key which does not match any of the predefined keywords can be used. For more information, see the example mentioned in For ServiceNow in Paging Based on Limit-Offset where $sysparm_offset$ is updated and used between page requests.

  • For complex expressions or conditions, multiple conditions can be grouped together using parentheses. For example:

    TERMINATE_IF ($someattribute$ == TRUE) && ($otherattribute$ == NULL)

Important
For more information and implementation of paging, contact SailPoint Services.

Paging Keywords

The paging mechanism has the following predefined set of keywords you can use:

Keywords

Description

application

Represents the application.

  • baseUrl – Base URL configured in the source.

endpoint

Represents endpoint configuration.

  • relativeURL – Relative URL of the endpoint.

  • fullUrl – Full URL contained within the endpoint.

limit

Indicates page limit configured in the endpoint configuration.

offset

Indicates page offset configured in the endpoint configuration.

request

Represents request body.

requestHeaders

Represents request header.

response

Represents response body object.

responseHeaders

Represents response header.

TERMINATE_IF

Indicates termination condition, multiple conditions can exist.

  • NO_RECORDS – Indicates no records retrieved; to be used in conjunction with TERMINATE_IF, evaluates to TRUE / FALSE

  • RECORDS_COUNT – Indicates number of records retrieved.

NULL

Indicates null or empty object.

REMOVE

Indicates to remove an attribute.

Supported Operators

The following table lists the supported and conditional supported operations

Type

Operations

Regular operations

+, -, *, /, =, && and ||

Conditional operations

<, >, <=, >=, == and !=