Configure default options for Teams app

It’s common for an app to support multiple scenarios in Teams, but you might have designed it with a specific scope and capability in mind. For example, if your app is primarily for team or channel use, you can make sure that the first install option users see in the Microsoft Teams Store is Add to a team.

Screenshot shows the Add to a team option.

If your app's primary capability is a bot, you can also make the bot the default capability when a user installs your app to a team.

Configure your app's default install scope

Configure the default install scope for your app. You can set only one scope at a time. For more information, see app manifest.

To configure the default install scope in your app manifest:

  1. Open your app manifest and add the defaultInstallScope property.

  2. Set default install scope value as, either personal, team, groupchat, or meetings.

    "defaultInstallScope": "meetings",
    

Configure the default capability for shared scopes

Configure the default capability when your app is installed for a team, meeting, or groupchat. For more information, see app manifest.

Note

defaultGroupCapability provides the default capability that will be added to the team, groupchat, or meeting. Select a tab, bot, or connector as the default capability for your app, but you must ensure that you have provided the selected capability in your app definition.

To configure details in app manifest:

  1. Open your app manifest and add the defaultGroupCapability property to it.

  2. Set a value of team, groupchat, or meetings.

  3. For the selected group capability, the available group capabilities are, bot, tab, or connector.

    Note

    You can select only one default capability, bot, tab, or connector for the selected group capability.

    "defaultGroupCapability": {
        "team": "bot",
        "groupchat": "bot",
        "meetings": "tab"
    }
    

Block apps by default for users until an admin approves

To enhance Teams app experience, you can hide an app from users by default until admin allows the app. For example, consider a help desk app created by Contoso Electronics for Teams. To enable appropriate functioning of the app, Contoso Electronics’ wants the customers to first configure specific properties of the app. The app is hidden by default and is available to users only after the admin allows it.

To block the app by default, in the app manifest file, set the defaultBlockUntilAdminAction property to true. When the property is set to true, the status of the app in Teams admin center is Blocked by publisher in the Manage apps page.

Screenshot shows an app blocked by publisher.

The admin gets a request to take action before a user can access the app. Under Manage apps, the admins can select Allow to allow the app with Blocked by publisher status:

Screenshot shows the Allow option for the app blocked by publisher.

If by default, you don't want the app to be hidden, you can update the defaultBlockUntilAdminAction property to false. When the new version of the app is approved, by default the app is allowed as long as the admin hasn't taken any explicit action.

Note

For custom apps built for your org (LOB apps), defaultBlockUntilAdminAction isn't supported. The app isn't blocked if you upload a custom app built for your org with this property.

Next step

See also

Distribute your Microsoft Teams app