Deprecation: CC, V1, and V2 API Decommission Update

[colin_mckibben]

The invite endpoint is one that I’m tracking internally right now. I’ll make a post in Non-Public API Deprecations once I know what the plan for it is.

[Achraf_Ben_Taieb]

Do you have inputs to share for the replacement of the following endpoints ?
• /cc/api/user/enabled
• /v2/identities/

Thanks in advance.
Regards,
Achraf

[adamian (Andrei Damian Fekete)]

I think it would have been really nice to announce a deprecation date AFTER the alternatives are already implemented and provided. Maybe even after IDN started using them itself. In the current state some are deprecated, some are unclear, for some a solution may be implemented, but nobody knows if it will be before the end date, how much time before it, or afterwards only.
I don’t think the uncertainty and lack of information helps with minimizing the effort of upgrading to alternatives.

I am wondering what IDN will use as alternative for /cc/api/user/list and /cc/api/account/getSourceAccounts?

[colin_mckibben]

Hey Andrei,

Great observation on noticing the deprecation dates! Just to clarify, deprecation does not mean they are turned off, but means that they will be turning off. You can read more about the descriptions of deprecation versus end of life, here:

Deprecation: Non-Public API Deprecations (CC, V2)

The official list of deprecated APIs has been released in a new category called API Deprecations. Please read this guide for more information on how the category works and how to provide feedback. General Guidance for the use of SailPoint APIs This announcement is to provide our Customers and Developer Community with appropriate expectations and guidance on the development and deprecation lifecycle of SailPoint’s Public APIs. Also included is information on the upcoming deprecation of SailPo…

So an API here goes from:
Live/Production > Deprecation > End of Life

We make sure to notify you when an endpoint reaches deprecation, so you have time to move over before it goes end of life.

[adamian (Andrei Damian Fekete)]

Hi Jordan,

I am somewhat confused. From the article you posted (less than a year old):

SailPoint APIs that start with /v2 do not have the same urgency and will follow the 12-month EOL period from their individual deprecation announcement.

but

SailPoint now intends to turn off (sunset) ALL non-public API endpoints on March 31st, 2024.

So the first information about the 1 year EOL is not true in all/most cases (/v2 api), right?

We make sure to notify you when an endpoint reaches deprecation, so you have time to move over before it goes end of life.

I am not quite sure how this helps if the alternative is not ready yet. Take GET /api/app/list - #5 by colin_mckibben for example. This is going to be turned off at the end of March, but nobody can actually implement the alternative as there is no information about it. So it may be ready in 1 day, 1 month of 6 months. If it is more than 2 months, the “non-public” API will be turned off, right?

How it should work to make the customer lives easier:
Live/Production > Implement Alternative > Use it internally > Announce Deprecation > Wait 1 year > End of Life (eventually bundle multiple deprecations in one clear announcement)

[colin_mckibben]

Hey Andrei,

That is all fair. I apologize on the link, I only meant to link to one specific excerpt, and linking to the whole topic caused more confusion—my mistake. I meant to reference this:

1. What does SailPoint mean by “deprecating” an API?
   Deprecation means to mark a component of software as obsolete so that it may be phased out at a later time. Generally speaking, any update to an API that removes or changes existing endpoints, schemas, response codes, parameters, or behavior can potentially break a user integration and should therefore follow this deprecation guide. Announced deprecation of an API starts the clock for its EOL (End of Life) date. SailPoint’s Public APIs have a 12 month EOL period to allow users to plan and implement changes accordingly. It is our intent to honor the same 12 month period for Non-Public APIs but depending on the reason for deprecation, a shorter timeline may be required in some cases. The posted deprecation details for each API will include the EOL date and the replacement APIs for that service, if applicable.

With that said, you are completely right about the product API lifecycle needing to be improved. We’re currently working with our product management team on this exact process.

In the interim, please don’t hesitate to continue posting in the #idn:api-deprecations category as your needs arise, and also don’t hesitate to join our API deprecation office hours, where we can help in real-time as well:

Events

[ruschel (Eduardo Ruschel)]

Any update for /user/invite

Tks

[colin_mckibben]

Not at this time. I will be sure to post the status of this endpoint in Non-Public API Deprecations when we have more information.

[blanked (Dave Blankenship)]

More confused than ever. So are the non-public APIs being turned off at the end of March? Or sooner if they were announced > 12 months ago? Or later if they were just announced?

Thanks!

[questjj (Jason Quest)]

Havent seem much talk about /cc/api/app/*

We have a tenant using the below, they use “Apps” to request access profiles and the app groups like access profiles. This was implemented before access profiles were available for request in request center, but the customer is use to this format.

/cc/api/app/getAccessProfiles
/cc/api/app/update

In scope for a replacement before retirement of cc?

[bkumar592 (Narendra Kumar)]

Hi
Do we have an alternate API for the below list please
/cc/api/task/listAll
/cc/api/task/complete/$TaskId
cc/api/user/updateLifecycleState

[hinsonhui (Chun Yu Hui)]

Hi
Do we have an alternate API for the below?
/cc/api/source/loadAccounts/

[bastienprulhiere]

Hi @colin_mckibben,

Is it planned to work on the endpoint scheduleAggregation ?

This one is very usefull to specify specific hours for our aggregations and avoid having all our aggregations starting at the beginning of an hours.

Regards

[colin_mckibben]

@bastienprulhiere

Is it planned to work on the endpoint scheduleAggregation ?

You can stay up-to-date on the status of this endpoint here.

POST /api/source/scheduleAggregation

This endpoint was previously in-progress for a replacement, but will no longer be ready before the March 31st, 2024 deadline. A replacement may be available after the deadline, but we cannot provide a date at this time.

[mbarthel (Matt Barthelme)]

Hello! Do you know if there is going to be a replacement for cc/api/certification/getReassignments? Thank you!

[MajidBellamkadam]

Is there a replacement for these endpoints?
When will these endpoints be EOL?

[ananthiv]

Hello,

Please confirm whether following API’s are impacted or not

1)Personal Access token for Authentication - Post - https://xxxx.api.identitynow.com/oauth/token

2. FileUploadUtility(To upload Delimitedfile to IDN - We are using version 3.0.0)

3)GetUncorrelated Accounts

“https://xxx.api.identitynow.com/cc/api/source/getUncorrelatedAccounts/xxxx”

Thanks in advance.

[cgurung (Chhiring Gurung)]

Hi @tyler_mairose , @colin_mckibben and @colin_mckibben
Recently our CSM had send us the report that below API endpoints are frequently being used in production tenant. We do not any custom code that uses these below endpoint. I believe this endpoint is being used by system itself. Any idea/insight you could provide would be very helpful
/api/source/testConnection
/api/cluster/list

[colin_mckibben]

The report the CSM gave you is not supposed to include API calls made by the VA or SailPoint systems. I have passed this information to our engineer who built the report to double check if this is indeed coming from outside of SailPoint or not.

[pratyush (Pratyush Mishra)]

Hi @colin_mckibben @colin_mckibben

Do we have an alternate API planned for the below?
/cc/api/account/remove/