Uninstall application package with json manifest by manifest id not working

[tranhuyentran23]

Describe the bug

To Reproduce

1. Sideload the application package with json manifest by command line:
   teamsapp install --file-path appPackage.zip

2. Observe the manifest sideloaded successfully

3. Uninstall the sideloaded manifest by manifest id
   teamsapp uninstall -i false --mode manifest-id --manifest-id <manifestId> --options m365-app
   (manifestId is the "id" property of the json manifest as definition in document)

4. An error was shown

Expected behavior
The sideloaded manifest will be uninstall successfully without any errror

Screenshots

VS Code Extension Information:

• OS: Windows 10

[teams-toolkit-assistant]

👋 Hi @tranhuyentran23,

Thank you for reporting this issue! We want to let you know that:

⏱️ Our team will personally review your issue
🎯 You can expect a response within 2 business days

✨ This is an AI-generated initial response
🤖 AI-Generated Preliminary Analysis:

To address the issue with uninstalling the application package by manifest id, follow these steps to troubleshoot and resolve the problem:

1. Verify Manifest ID: Ensure that the manifestId you are using is correct and matches the "id" property in your JSON manifest file. You can open the appPackage.zip and inspect the manifest file to confirm this.

2. Confirm Uninstall Command: Double-check the command syntax you are using to uninstall the app. Based on the error description, your command should look like this:

   teamsapp uninstall --manifest-id <manifestId> --options m365-app

3. Check for Errors in Command Execution: Look at the error message displayed when you attempt to uninstall the app. This might give you more insight into what is going wrong.

4. Use a JSON Validator: Ensure that your JSON manifest file is correctly formatted. Malformed JSON can sometimes cause issues with commands that rely on the manifest file. Use a JSON validator tool to check for syntax errors.

5. Refer to Documentation: As mentioned in your question, refer to the official documentation to ensure you are following the correct steps for sideloading and uninstalling the app.

6. Update Teams Toolkit: Ensure that you are using the latest version of the Teams Toolkit. Sometimes issues are resolved in newer versions, so updating might help.

Example Steps for Troubleshooting

1. Inspect the JSON Manifest:

   {
     "id": "your-manifest-id",
     // other properties
   }

   Make sure the "id" property matches the manifestId you are using in the uninstall command.

2. Run the Uninstall Command:

   teamsapp uninstall --manifest-id your-manifest-id --options m365-app

If the problem persists after following these steps, consider providing more details about the error message you are receiving. This will help in diagnosing the issue more precisely.

For additional support, you can also refer to related issues on GitHub, such as:

• Issue #7556 regarding JSON manifest parsing errors.
• Issue #7118 for issues related to JSON formatting.

By following these steps, you should be able to identify and resolve the issue with uninstalling the application package by manifest id.

---

Note: This is an automated first response generated by AI. A human team member will review your issue and provide a more detailed response soon. We appreciate your patience!

[Meghana-MSFT]

Thank you for reporting this, we will check this and get back to you.

[Meghana-MSFT]

@tranhuyentran23 - We tested this at our end, and we are able to run the uninstall command successfully. Could you please confirm that you have used correct manifest id only?

[tranhuyentran23]

Hi @Meghana-MSFT , I tried with a sample zip package that using schema:
https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.schema.json
manifestVersion: devPreview
manifest id: e923e00f-b3e3-123d-b81e-de9c3a31718c

Could you help to take a look at my sample json that I was using, and let me know if I missed any config. Thanks!

{
    "$schema": "https://developer.microsoft.com/json-schemas/teams/vDevPreview/MicrosoftTeams.schema.json",
    "accentColor": "#230201",
    "authorization": {
        "permissions": {
            "resourceSpecific": [
                {
                    "name": "Document.ReadWrite.User",
                    "type": "Delegated"
                }
            ]
        }
    },
    "description": {
        "full": "This is the template to get started.",
        "short": "A template to get started."
    },
    "developer": {
        "name": "Contoso",
        "privacyUrl": "https://www.contoso.com/privacy",
        "termsOfUseUrl": "https://www.contoso.com/servicesagreement",
        "websiteUrl": "https://www.contoso.com"
    },
    "extensions": [
        {
            "requirements": {
                "capabilities": [
                    {
                        "minVersion": "1.1",
                        "name": "Selection"
                    },
                    {
                        "minVersion": "1.1",
                        "name": "DialogApi"
                    },
                    {
                        "minVersion": "1.5",
                        "name": "WordApi"
                    }
                ],
                "scopes": [
                    "document"
                ]
            },
            "ribbons": [
                {
                    "contexts": [
                        "default"
                    ],
                    "requirements": {
                        "capabilities": [
                            {
                                "minVersion": "1.1",
                                "name": "AddinCommands"
                            }
                        ],
                        "formFactors": [
                            "desktop"
                        ],
                        "scopes": [
                            "document"
                        ]
                    },
                    "tabs": [
                        {
                            "builtInTabId": "TabHome",
                            "groups": [
                                {
                                    "controls": [
                                        {
                                            "actionId": "Office.AutoShowTaskpaneWithDocument",
                                            "enabled": true,
                                            "icons": [
                                                {
                                                    "size": 16,
                                                    "url": "https://localhost:3000/assets/icon-16.png"
                                                },
                                                {
                                                    "size": 32,
                                                    "url": "https://localhost:3000/assets/icon-16.png"
                                                },
                                                {
                                                    "size": 80,
                                                    "url": "https://localhost:3000/assets/icon-16.png"
                                                }
                                            ],
                                            "id": "msgReadOpenPaneButton",
                                            "label": "Show Taskpane",
                                            "overriddenByRibbonApi": false,
                                            "supertip": {
                                                "description": "Opens a pane displaying all available properties.",
                                                "title": "Show Taskpane"
                                            },
                                            "type": "button"
                                        }
                                    ],
                                    "icons": [
                                        {
                                            "size": 16,
                                            "url": "https://localhost:3000/assets/icon-16.png"
                                        },
                                        {
                                            "size": 32,
                                            "url": "https://localhost:3000/assets/icon-32.png"
                                        },
                                        {
                                            "size": 80,
                                            "url": "https://localhost:3000/assets/icon-80.png"
                                        }
                                    ],
                                    "id": "msgReadGroup",
                                    "label": "Contoso Add-in"
                                }
                            ]
                        }
                    ]
                }
            ],
            "runtimes": [
                {
                    "code": {
                        "page": "https://localhost:3000/functions.html"
                    },
                    "id": "ow365.FunctionFile.Url",
                    "lifetime": "short",
                    "requirements": {
                        "capabilities": [
                            {
                                "minVersion": "1.1",
                                "name": "AddinCommands"
                            }
                        ],
                        "formFactors": [
                            "desktop"
                        ]
                    },
                    "type": "general"
                },
                {
                    "actions": [
                        {
                            "id": "Office.AutoShowTaskpaneWithDocument",
                            "multiselect": false,
                            "pinnable": false,
                            "supportsNoItemContext": false,
                            "type": "openPage"
                        }
                    ],
                    "code": {
                        "page": "https://localhost:3000/index.html"
                    },
                    "id": "Index.Url",
                    "lifetime": "short",
                    "requirements": {
                        "capabilities": [
                            {
                                "minVersion": "1.1",
                                "name": "AddinCommands"
                            }
                        ],
                        "formFactors": [
                            "desktop"
                        ]
                    },
                    "type": "general"
                }
            ]
        }
    ],
    "icons": {
        "color": "color.png",
        "outline": "outline.png"
    },
    "id": "e923e00f-b3e3-123d-b81e-de9c3a31718c",
    "localizationInfo": {
        "additionalLanguages": [
        ],
        "defaultLanguageTag": "en-us"
    },
    "manifestVersion": "devPreview",
    "name": {
        "full": "Contoso Add-in",
        "short": "contoso"
    },
    "showLoadingIndicator": true,
    "validDomains": [
        "contoso.com"
    ],
    "version": "4.1.0"
}

[Meghana-MSFT]

We will check this internally and get back to you.

[summzhan]

@tranhuyentran23 could you provide which Contoso sample you are using?

Note that you are using vDevPreview manifest. Could you please change to 1.19 manifest version and try again?

[tranhuyentran23]

Hi @summzhan
I used vDevPreview because I tried to work with Office Add-ins with the unified app manifest
https://learn.microsoft.com/en-us/office/dev/add-ins/develop/unified-manifest-overview
https://github.com/OfficeDev/Office-Samples/blob/dev/Teams-App-for-Office-Add-in/README.md
I also tried with manifest version 1.19, I still got an error and I cannot uninstall manifest

[anchenyi]

Hi @tranhuyentran23, I suspect that the app was not installed successfully, which caused the uninstallation to fail. Could you try provisioning the app first? Then, go to Microsoft Teams Developer Portal, click your app, and click "Preview in Teams" in the top right corner. If the app cannot be installed, you might need to recheck your manifest file.

[tranhuyentran23]

Hi @anchenyi , I tried with command line teamsapp install --file-path to sideload an manifest using version devPreview and I saw that the add-in was installed successfully
Contoso add-in was shown in "Developer Add-ins" section

but I cannot find this add-in from Microsoft Teams Developer Portal

and a note that I still can uninstall this add-in successfully with titleId mode

[anchenyi]

hi @tranhuyentran23, forget about the Teams Developer Portal. I found that TTK cannot retrieve the launch info of a Office Add-in app from the MOS API. This means that given a manifest ID of an Office Add-in app, TTK cannot obtain its title ID, causing the uninstallation to fail.

I will continue investigating why we failed to get the launch info. In the meantime, you can uninstall the app using the title ID mode as a temporary workaround.

Thanks for reporting this!

[Rick-Kirkham]

@anchenyi I'm also encountering the same issue. But the workaround doesn't entirely work for me:

The only way I can get the uninstall command to work without returning an error is to use BOTH the --title-id and --manifest-id options and specify --interActive false.

But note that I don't get the feedback that @tranhuyentran23 gets:

Microsoft 365 Application of Title ID: ..... successfully uninstalled.
The uninstallation of the Microsoft 365 Application may be delayed.

So, it is unclear if the add-in is being completely uninstalled. Outlook add-ins are different from WXP add-ins because in addition to being registered on the local client, Outlook add-ins are registered in the user’s Exchange service online. This registration has to be removed or every time Outlook is launched, the add-in’s manifest is re-downloaded from Exchange to the client and the add-in reappears on the Outlook ribbon.

Also, the workaround is not reliable because it can only be used if the developer makes a record of the titleID at the time of installation. There seems to be no way of discovering what the title ID is otherwise.

Office Add-ins developer docs refers to the uninstall command in the following article, so it would be great to get this fixed as soon as possible.
Sideload with the Teams Toolkit CLI

[anchenyi]

Hi @Rick-Kirkham , in the first screenshot, you need to select "Title ID" in response to the question "Choose a way to clean up resources". In the second screenshot, you need to add --mode title-id. By default, --mode is set to manifest-id, which also requires the --options argument to specify the resources to uninstall. Without --mode and --options, the command by default use manifest-id mode and select nothing (--options) to uninstall.

In your case, please try running:
teamsapp uninstall --mode title-id --title-id xxx --interactive false
You can also use teamsapp uninstall -h to see more examples.

Regarding our failure to retrieve the title ID from the manifest ID of Outlook add-in apps, this is due to an upstream API issue. We are working with the related team to determine how to resolve it. I will post any updates here as soon as I have them. Sorry for the inconvenience.