PingAuthorize

Modify query

Use modify-query to modify the query string of the request sent to the API server.

Description Details

Applicable to

All.

Additional information

The payload for this advice is a JSON object. The keys are the names of the query parameters that must be modified, and the values are the new values of the parameters. A value can be one of the following options:

null

Query parameter is removed from the request.

String

Parameter is set to that specific value.

Array of strings

Parameter is set to all of the values in the array.

If the query parameter already exists on the request, it is overwritten. If the query parameter does not already exist, it is added. For example, consider the following request made to a proxied API:

curl --location --request GET '{{apiPath}}/directory/v1/{{dn}}/subtree?searchScope=wholeSubtree&limit=1000' \
--header 'Authorization: Bearer {{jwtToken}}'

You can set a policy to limit certain groups of users to request only 20 users at a time. A payload of \{"limit": 20} causes the request to be rewritten as follows:

curl --location --request GET '{{apiPath}}/directory/v1/{{dn}}/subtree?searchScope=wholeSubtree&limit=20' \
--header 'Authorization: Bearer {{jwtToken}}'