Deprecation: CC, V1, and V2 API Decommission Update

[tyler_mairose]

Private API Deprecations - Being Proactive

When will the APIs be deprecated?

Since February of 2023, SailPoint has been in the process of deprecating non public APIs. The original date we communicated to you was December 31st, 2023, but that has been extended.

SailPoint now intends to turn off (sunset) ALL non-public API endpoints on March 31st, 2024. A non public API endpoint is one that contains any of the following keywords in the URL:

• /cc/api
• /api
• /api/v2

Certain non-public API endpoints that show very little to no utilization by external users may be deprecated and turned off without notice.

How will we communicate these deprecations?

Deprecations are an ongoing effort, and we will announce the deprecation of individual endpoints as soon as production replacements are made available.

These announcements will happen in the form of a new topic in the Non-Public API Deprecations category in our forum, where each topic will be:

• The endpoint being deprecated
• It’s suitable replacement
• This topic is also where you will provide any feedback you have on this endpoint

We strongly encourage you to subscribe to new topics in this category so you do not miss new endpoints that are ready to switch over.

We will also provide weekly recaps with the latest batch of deprecated APIs for that week. You will find these announcements in the following channels:

• The #announcements:product-updates forum category. We recommend subscribing to new topics here.
• In-app announcements within the “Admin” page of IdentityNow
• Targeted emails

What do you need to do?

Subscribe to the API Deprecations Category

The first thing you should do is subscribe to notifications in the #idn:api-deprecations category for the latest updates to deprecations. You can subscribe by clicking on the “bell” icon in the top right and setting your notification preference to “Tracking” or higher. If you need help learning how to subscribe to notifications in our forum, you can read our guide here:

Subscribing to categories, topics, and tags

Subscribing to a category, topic, or tag is a way for you to get notified when new things happen. For example: You could subscribe to a category, such as #announcements:security-update, because you want to get an updated on all things security announcements. You could subscribe to a tag like workflows, because you want to be notified on all things workflows, regardless of which category it happens in. You could even subscribe to a *topic (like this one!) because you want to be notified every t…

Start your migration plan early

If you are using any deprecated APIs in custom code that you have written, please discontinue use of the deprecated API as soon as possible. Each deprecated endpoint will offer one or more alternatives to migrate to our production API. Please click on the topic in #idn:api-deprecations for the deprecated endpoint you are using for more information on how to migrate. If you have any concerns about migrating off of a deprecated endpoint, please reply to the topic of that endpoint with your concerns.

Join our bi-weekly API Deprecation Office Hours

Our Developer Relations team is here to help you with this transition. To do this, we are going to be providing open office hours every two weeks where you can join and ask us about challenges you’re currently facing in your migration from our non-public APIs to a V3 API. Below is our first office hours, and more will follow in the Events category soon.

API Deprecation Office Hours

Our bi-weekly API Deprecation Office Hours are a great place to get help from the SailPoint Developer Relations team with migrating from CC, V1, or V2 APIs to our V3 APIs equivalents. If you have any questions about these APIs (e.g. object mappings, data types), how to change your API calls our for our SDKs, or anything else related to our API deprecations then this is the place for you to join and ask! Office Hours Recording Office Hours Notes Specific API requests made on the call today PO…

Have a question about using our SDK? Create a new topic in IDN Discussion and Questions and let us know. We’re here to help!

What does SailPoint recommend?

Move your direct API calls to SailPoint-maintained SDKs

We strongly recommend you use this opportunity to migrate off of any custom code for your implementations, and onto SailPoint’s official SDKs. Our SailPoint-built and supported SDKs will make implementing with our APIs easier, less time-consuming, and offer a number of benefits over direct API calls.

Read the SDK Docs

SDKs | SailPoint Developer Community

Watch our Getting Started With SDKs Video

Still have questions?

Let us know here in this announcement and we’ll help you get to the right place.

[bastienprulhiere]

Hi @colin_mckibben,
Do you have inputs to share for the replacement of the following endpoints ?
- /cc/api/user/loadAccounts
- /cc/api/user/list
- /cc/api/user/updatePermissions
Thanks in advance.
Regards,

[colin_mckibben]

/cc/api/user/list should be available in in list-identities | SailPoint Developer Community

The rest should be coming to the Identities collection at some point, but I don’t have a specific date on when. I realize the endpoints I have linked here are in beta right now, but they will have a v3 before we deprecate the CC.

[u92119 (Chris Smith)]

I am assuming the Non-Public APIs being used in purchased integrations like the Servicenow Service Catalog will be replaced and made available well in advance of them being deprecated?

[tombui (Thomas Bui)]

Hey @colin_mckibben and @jordan_violet

Do you happen to know if there is an official replacement for the following endpoint yet?
/cc/api/connector/list

Sincerely,
Tom Bui

[colin_mckibben]

@tombui Yes, it turns out there is. I just created a new topic in the Non-Public API Deprecations category. If you have any questions or feedback, reply to this topic.

GET /api/connector/list

Replaced by:

[noureldeenyassin-up (NourEldeen Yassin)]

Hello
Is it safe to assume that endpoints that are not mentioned here would not be deprecated be EOY?
I looked all of them up in codebase and didn’t find occurrences, but we have /cc/api/user/details for example that is not mentioned in the Kanban board, and identities api didnt make it way to v3 yet

[jordan_violet]

Great question, NourEldeen!

All CC, V1, and V2 APIs will be deprecated and turned off by March 31st, 2024. If they are not on that kanban board, then we have not started working on them yet.

I would recommend that you subscribe to all new topics in that category (Non-Public API Deprecations) so you don’t miss any new endpoints as they’re added.

[BenNelson]

We are using /cc/api/user/loadAccounts to run scheduled non-optimized aggregations from a workflow so we will need a replacement for this.

[bastienprulhiere]

Hi @colin_mckibben, @jordan_violet

Do you know when the following endpoints will start to be replaced ?

• /cc/api/user/updatePermissions
• /cc/api/user/invite

Thanks in advance.
Regards,

[colin_mckibben]

@bastienprulhiere

• /cc/api/user/updatePermissions
• /cc/api/user/invite

I have added these to my list of APIs to investigate.

[questjj (Jason Quest)]

any update on loadAccounts replacement?

[jishnu_suresh]

Hi
Any update on the replacement of these api’s ? We are using /cc/api/user/loadAccounts for non-optimized aggregations. So we need a replacement api/method for this.

[angelo_mekenkamp]

Hi @colin_mckibben,

I don’t see the following APIs in the deprecation list that we do use often:

/api/role/refresh: This API ensures that when we create a role, it will get actually get added to search quicker. Otherwise we can’t request that role through the UI, since it depends on search and it can take a day before search is correct.

/api/account/remove: This API also removes accounts that do not belong to delimited file sources (remove from IDN, not from target application)

/api/emailTemplate/list, last time I checked, this is different than notification-templates. Both in behavior (notification-templates offers less functionality) and in the email templates (they have some disjunct templates).

/api/rule/list: This API also includes rules of both types, not just VA based rules. It allows us to see the definition of them.

[bastienprulhiere]

Hi Colin,
Any update regarding the replacement of updatePermissions endpoint ?
Regards

[colin_mckibben]

@bastienprulhiere

Any update regarding the replacement of updatePermissions endpoint ?

Hi Bastien. Yes, we now have a v3 endpoint to replace this. POST /api/user/updatePermissions

[colin_mckibben]

/api/role/refresh has been deprecated. There is no direct replacement, but there are a few paths forward. POST /api/role/refresh

/api/emailTemplate/list has also been deprecated. GET /api/emailTemplate/list. FYI, there is work being done to migrate the missing templates that are only found in the CC endpoint to the beta endpoint. If you have specific functionality requests regarding email templates, please let us know.

The other two endpoints are still being prioritized. I don’t have a date on when to expect replacements at this time.

[angelo_mekenkamp]

Wouldn’t the other two need their own page/post as well?

Even though there is no replacement yet, they will be deprecated as well on the 31st of March right? If a page exists for that API, developers could track it and respond to it such that SailPoint is aware which APIs are most crucial. Also, it shows us that these APIs haven’t been forgotten.

[colin_mckibben]

Just posted the status for /api/account/remove and /api/rule/list.

POST /api/account/remove

There will not be a public replacement available before March 31st.

GET /api/rule/list

There will not be a public replacement available before March 31st. Ticket for reference is IDNARSENAL-20896

[bastienprulhiere]

Hi @colin_mckibben,
Thanks for your update.
Do you have any input regarding the invite endpoint ?
This one is also important for us to start registration of the users to IDN for SSPR purpose.