API to query all password resets for all sources

[#1]

The Dashboard > Overview page of the IdentityNow Admin interface includes the Password Resets dashboard which is described here.

To see additional information about password resets for an organization, you can use the password reset summary APIs. You have the following options:

• View the number of password resets for all sources in an organization
• View the password resets for a limited number of sources
• Run the report manually
• Change the time period that is being reported on

IMPORTANT: These APIs are being deprecated in favor of the IdentityNow Platform APIs. While these APIs will continue to be available for the foreseeable future, SailPoint recommends that you transition to the new versions as soon as possible. For detailed information about all new platform APIs, visit the SaaS API Reference.

Prerequisites:

• Sign in to the org as an administrator. Click Admin and strong authenticate.
• Open your preferred tool for making API calls

NOTE: If you're making these API calls, you'll need to use on of our supported authentication methods. As a best practice SailPoint recommends using OAuth 2. Also, the endpoint you use must be changed slightly based on the authentication method. For details, see the Authentication section of the Developer portal documentation.

All Password Resets per Source for the Org

The password reset summary report returns all sources that have had password resets in the last seven days. The list includes the count of password resets per source. It is sorted with the source with highest number of resets at the top.

This API returns the most recently run report. By default the report runs every hour. However, you can run it at any time.

GET <org>/api/source/getResetSummary

where <org> is the URL for the customer's IdentityNow org.

NOTE: In the results, the timestamp reflects Greenwich Mean Time (GMT).

Limit the Number of Sources

GET <org>/api/source/getResetSummary

where <org> is the URL for the customer's IdentityNow org.

It accepts the following parameters:

• limit (Number of sources you want to report on.  Ex. limit=12)

Run the Report Manually

The password reset summary report runs once an hour by default. However, you can run it at any time using the API runResetSummary.

POST <org>/api/source/getResetSummary

where <org> is the URL for the customer's IdentityNow org.

No results are returned. You can either see partial results in the UI or you can run the getResetSummary API to see the full results.

Change the Time Period for the Report

By default, the report returns the password reset activity for all sources over the last seven days. You can change this time period to any other value. For example, you might want to see the number of password resets over the last 30 days.

POST <org>/api/source/runResetSummary

It accepts the following query parameters:

• days (The time period you want to report on  Ex. days=12)

No results are returned. You can either see partial results in the UI or you can run the getResetSummary API to see the full results.

NOTE: Changes made with this API affect the results displayed in the Password Resets dashboard. However, the text in the dashboard continues to indicate a 7-day time period.