This category is the single source of truth for non-public API deprecations, which is a part of SailPoints plan to end of life all non-public APIs. We are continuously adding to this list as v3 APIs become available. If you don’t see a non-public API that you are using, it will be coming soon once the v3 replacement is ready.
Please click here to view the kanban board. The topic title is the non-public endpoint that is being deprecated. If you click on the post, you will find a description of the V3 API(s) that replace the deprecated endpoint, along with the end of life date. If you have any questions or concerns about specific endpoints, please comment in the topic.
You can also find the list of deprecated endpoints in this Excel sheet. deprecations.csv (24.2 KB)
Please subscribe to this category to receive the latest deprecations and updates. We will be adding more deprecations as V3 equivalents are ready.
Phases
Non-public APIs will go through the following phases.
Deprecated
Deprecated endpoints will appear in the deprecated column. This means they are marked as obsolete and should no longer be used. Deprecated endpoints will remain available until the end of life date. It is highly recommended that you begin moving off of deprecated endpoints as soon as possible. The target date to deprecate and turn off all private API endpoints is March 31st, 2024.
I don’t see it on the list yet but since your post mentions all of the non-public APIs will be deprecated as some point, what can you tell me about this one: /cc/api/source/loadAccounts/<source_id>
I believe this is also what the File Upload Utility uses under the covers right? Is there a plan to create a V3 version of this one soon along with a new version of the File Upload Utility?
Where are the migrated APIs located? I’m trying to locate a v3 or beta AP for the account profile API and can’t find it - GET {{api-url}}/cc/api/accountProfile/list
Do we have any equivalents for POST /cc/api/user/delete or DELETE /v2/identities{id}? Typically we would reccomend removing the user account from the authoritative source but wanted to check if we plan to keep these API calls to delete an identity.
There are a fair few /CC/API endpoints, which are being used out there, which have been reverse engineered from the UI.
Is there a document to cross reference these to the v3/beta endpoints?
Considering more and more of the “older” API’s are getting tagged as deprecated but without a replacement/alternative listed how can we help our clients plan for the urgency around the replacements, potential loss of functionality, etc.
We all understand the old are going away, but without knowing:
Will there be a replacement?
What is an alternative?
If the UI provides this functionality today is it being updated also and when?
It’s hard to know how critical these are from a timing perspective to ensure existing functionality is migrated to either new API’s, migrated to other API’s (i.e. Search?), or is functionality that is being obsoleted.
API’s are just a gateway to the underlying functionality, so without knowing the impact on functionality it’s hard to plan for alternatives.
I apologize. I did not do my due diligence on the latest batch of deprecated APIs. A couple of them clearly didn’t have a replacement ready, which means they shouldn’t have been announced as deprecated. However, we are now aware of these gaps and are actively working to create replacements.
My recommendation is to treat any API deprecations as high priority. We have many more endpoints to deprecate, and they will be announced incrementally as we finish their replacements. It would not be ideal to wait until march to start working on any deprecations you may have to do.
It looks like the Kanban board has gotten substantially shorter so should we assume anything that is not listed here has been assigned a disposition (replaced, obsolete, etc.) and exists in the spreadsheet?
Specific examples:
POST /api/source/loadAccounts/ - I’m not seeing this on the Kanban board any longer, but it is in the spreadsheet. This is problematic though because there doesn’t appear to be a replacement yet based on reading the specific page. Do we need to research each of these independently?
GET /api/app/list This one is on the Kanban board but doesn’t appear in the Excel list. Hoping this confirms the assumption noted above they’re moved from Kanban to Excel.
At a basic level - the developer community needs a list that says “POST /api/source/loadAccounts/” has been replaced with “POST /beta/source/aggregate/”. From here we can read the specifics about the new/updated endpoint and figure out what changes we need to make.
Sorry about the confusion. I updated the CSV file in the post above to the latest list. It provides a link to the exact forum post for each deprecation, so you can read more about it.
Welcome to the Developer Community Francis. Please see this post for more information on the deprecation of /api/system/refreshIdentities and what is replacing it.