Updating OAuthScopes of a Custom Application after the Custom Application is Ready state

[mohib0306]

Description:

The OAuthScopes required for a custom application to operate are being provided while the custom application is being registered. However it could be that the OAuthScopes needed for the custom application to operate change and the custom application's details need to be updated.

As of now the OAuthScopes can only be updated when the custom app is in draft state. While changing a currently ready custom application to draft a confirmation dialogue box is shown stating the following message.

This will cause the Custom Application to be uninstalled from all organizations and projects. This action cannot be undone.

• Question 1: What does this message mean and what are the consequences of this action? i.e. Are the project accesses are removed and had to be configured again?
• Question 2: Is there another way to update the OAuthScopes required by a custom application?
• Question 3: What should be done after moving the custom application to draft state, updating the custom application properties and then setting the custom application to ready state?

[emmenko]

Hi 👋

Thanks for reaching out.

These are very good questions.

Question 1: What does this message mean and what are the consequences of this action? i.e. Are the project accesses are removed and had to be configured again?

Yes correct. Uninstalling a Custom Application removes all its associated permissions from the projects.
You can install the Custom Application again but you need to reconfigure the permissions.

Question 2: Is there another way to update the OAuthScopes required by a custom application?

Not at the moment. This was a conscious decision and a restriction for the initial phase. Nevertheless, we do have plans to lift up this restriction and prevent the Custom Application to be uninstalled.

Question 3: What should be done after moving the custom application to draft state, updating the custom application properties and then setting the custom application to ready state?

Yes, once the Custom Application is in Draft state, you can change most of its configuration. Then you can move the Custom Application back to Ready, and install the application again.

Note that this restriction only applies to specific things, like changing OAuth Scopes. Most of the other configuration options can be updated at any time, for example the application URL, the name, the menu links, etc.

[emmenko]

This is now possible. See https://docs.commercetools.com/custom-applications/releases/2023-07-03-improved-permission-management-for-custom-applications