rest.properties
The properties of the rest.properties file control the behavior of the REST interfaces that are included in IBM Verify Identity Governance. As an administrator, you can update the properties in the rest.properties file to modify the behavior of certain aspects of the REST interfaces.
baseUri-
Specifies the base for the URIs that are returned from the REST interfaces.
If the property is not specified, the REST interfaces use the base URIs from the HTTP request.
Example:
baseUri=https://server/itim/rest enforceCRSetupOnLogin-
Specifies whether to enforce the challenge response questions when the user first logs on to the client application.
This property and value is returned in the response for the following REST API call:
GET http(s)://hostname : port/itim/rest/password/configuration?attributes=enforceCRSetupOnLogin
If the property is not specified, the REST API returns
false.Example:enforceCRSetupOnLogin=true search.limit-
Specifies the maximum number of items that are returned by the REST search APIs. The REST search APIs attempt to retrieve no more than the specified number of items plus one. Specifying a value of 0 indicates that there is no limit.
Example:
search.limit=1000Note: The limit of accesses that are returned by a search is determined by a separate propertysearch.limit.access. search.limit.access-
Specifies the maximum number of accesses that are returned by the REST access search API. The REST access search API attempts to retrieve no more than the specified number of accesses plus one. Specifying a value of 0 indicates that there is no limit.
Example:
search.limit.access=100 search.limit.activities-
Specifies the maximum number of activities that are returned by the REST activity search API. The REST activity search API attempts to retrieve no more than the specified number of activities plus one. Specifying a value of 0 indicates that there is no limit.
Example:
search.limit.activities=100 participant.limit-
Specifies the maximum number of participants that are assigned to the activity that are returned by a search or a retrieval of activities. Specifying a value of 0 indicates that there is no limit.
Example:
participant.limit=0 search.pagesize-
Specifies the maximum number of items that are included in each page when the REST search APIs perform paged searching. Specifying a value of 0 indicates that REST search APIs do not perform paged searching.
Example:
search.pagesize=100 search.queryfilter.allowedHiddenAttributes-
Specifies the list of hidden attributes, (specified in enrolehiddenattributes.properties file) that are allowed in filter query parameters. The value must be in lowercase, and separated by a comma. For example: erlastmodifiedtime,ercategory.
Example:
search.queryfilter.allowedHiddenAttributes=erlastmodifiedtime search.cache.enabled-
Specifies whether the REST search APIs cache search results to satisfy subsequent request that specify the same search criteria.
Example:
search.cache.enabled=true search.cache.limit-
Specifies the maximum number of searches for which results are cached for each client. Specifying a value of 0 indicates that there is no limit. This parameter is ignored if
search.cache.enabled=falseis specified.Example:
search.cache.limit=100 search.cache.timeout-
Specifies the number of seconds that search results remain cached for each client since the last time the client issued a request with the same search criteria. Specifying a value of 0 indicates that the search results remain cached until the client's HTTP session times out. This parameter is ignored if
search.cache.enabled=falseis specified.Example:
search.cache.timeout=600 activity.duedate.threshold-
Specifies the time in hours. If the due date is approaching within this threshold limit, it is flagged in the activity summary and detail pages. The activity card and activity due date are flagged.
Example:
activity.duedate.threshold=24