App manifest

Artykuł
11/18/2024

The app manifest (previously called Teams app manifest) describes how your app integrates into the Microsoft Teams product. Your app manifest must conform to the schema hosted at https://developer.microsoft.com/json-schemas/teams/v1.19/MicrosoftTeams.schema.json. Previous versions 1.0, 1.1,...,1.17, and the current version is 1.19 are each supported (using "v1.x" in the URL). Version 1.18 is not available. For more information on the changes made in each version, see app manifest change log and for previous versions, see app manifest versions.

The following table lists TeamsJS version and app manifest versions as per different app scenarios:

App type	TeamsJS version	App manifest version	Next steps
Teams apps extended across Outlook and Microsoft 365	TeamsJS v.2.19.0 or later	v.1.13 or later	Extend a Teams app to run across Microsoft 365 or Create a new Microsoft 365 app
Existing Teams-only apps	Update to TeamsJS v.2.19.0 when possible (v.1.12 is still supported*)	1.12	Understand TeamsJS backwards compatibility and Update to TeamsJS v.2.0
New Teams-only apps	TeamsJS v.2.19.0 or later	1.12	Create a new Teams app using Teams Toolkit

*Use the latest TeamsJS (v.2.19.0 or later) whenever possible, to take advantage of the latest improvements and new feature support including Teams-only apps. TeamsJS v.1.12 continues to be supported, however, no new features or improvements are added. The 1.12 and 1.13 schemas are otherwise the same. For more information, see TeamsJS library.

Note

If your Teams app is using the app manifest version 1.13 or later, ensure that your app meets the criteria to extend your app to run across Microsoft 365 or Outlook.

The following is the sample app manifest schema:

Sample app manifest

{
    "$schema": "https://developer.microsoft.com/json-schemas/teams/v1.19/MicrosoftTeams.schema.json",
    "manifestVersion": "1.19",
    "version": "1.0.0",
    "id": "%MICROSOFT-APP-ID%",
    "localizationInfo": {
        "defaultLanguageTag": "en",
        "defaultLanguageFile": "en.json",
        "additionalLanguages": [
            {
                "languageTag": "es",
                "file": "es.json"
            }
        ]
    },
    "developer": {
        "name": "Publisher Name",
        "websiteUrl": "https://example.com/",
        "privacyUrl": "https://example.com/privacy",
        "termsOfUseUrl": "https://example.com/app-tos",
        "mpnId": "1234567890"
    },
    "name": {
        "short": "Name of your app (<=30 chars)",
        "full": "Full name of app, if longer than 30 characters (<=100 chars)"
    },
    "description": {
        "short": "Short description of your app (<= 80 chars)",
        "full": "Full description of your app (<= 4000 chars)"
    },
    "icons": {
        "outline": "A relative path to a transparent .png icon — 32px X 32px",
        "color": "A relative path to a full color .png icon — 192px X 192px"
    },
    "accentColor": "A valid HTML color code.",
    "copilotAgents": {
        "declarativeAgents": [
            {
                "id": "agent1",
                "file": "declarativeAgent1.json"
            }
        ]
    },
    "configurableTabs": [
        {
            "configurationUrl": "https://contoso.com/teamstab/configure",
            "scopes": [
                "team",
                "groupChat"
            ],
            "canUpdateConfiguration": true,
            "context": [
                "channelTab",
                "privateChatTab",
                "meetingChatTab",
                "meetingDetailsTab",
                "meetingSidePanel",
                "meetingStage"
            ],
            "sharePointPreviewImage": "Relative path to a tab preview image for use in SharePoint — 1024px X 768",
            "supportedSharePointHosts": [
                "sharePointFullPage",
                "sharePointWebPart"
            ]
        }
    ],
    "staticTabs": [
        {
            "entityId": "unique Id for the page entity",
            "scopes": [
                "personal"
            ],
            "context": [
                "personalTab",
                "channelTab"
            ],
            "name": "Display name of tab",
            "contentUrl": "https://contoso.com/content (displayed in Teams canvas)",
            "websiteUrl": "https://contoso.com/content (displayed in web browser)",
            "searchUrl": "https://contoso.com/content (displayed in web browser)"
        }
    ],
    "supportedChannelTypes": [
        "sharedChannels",
        "privateChannels"
    ],
    "bots": [
        {
            "botId": "%MICROSOFT-APP-ID-REGISTERED-WITH-BOT-FRAMEWORK%",
            "scopes": [
                "team",
                "personal",
                "groupChat"
            ],
            "needsChannelSelector": false,
            "isNotificationOnly": false,
            "supportsFiles": true,
            "supportsCalling": false,
            "supportsVideo": true,
            "commandLists": [
                {
                    "scopes": [
                        "team",
                        "groupChat"
                    ],
                    "commands": [
                        {
                            "title": "Command 1",
                            "description": "Description of Command 1"
                        },
                        {
                            "title": "Command 2",
                            "description": "Description of Command 2"
                        }
                    ]
                },
                {
                    "scopes": [
                        "personal",
                        "groupChat"
                    ],
                    "commands": [
                        {
                            "title": "Personal command 1",
                            "description": "Description of Personal command 1"
                        },
                        {
                            "title": "Personal command N",
                            "description": "Description of Personal command N"
                        }
                    ]
                }
            ]
        }
    ],
    "connectors": [
        {
            "connectorId": "GUID-FROM-CONNECTOR-DEV-PORTAL%",
            "scopes": [
                "team"
            ],
            "configurationUrl": "https://contoso.com/teamsconnector/configure"
        }
    ],
    "composeExtensions": [
        {
            "canUpdateConfiguration": true,
            "botId": "%MICROSOFT-APP-ID-REGISTERED-WITH-BOT-FRAMEWORK%",
            "commands": [
                {
                    "id": "exampleCmd1",
                    "title": "Example Command",
                    "type": "query",
                    "context": [
                        "compose",
                        "commandBox"
                    ],
                    "description": "Command Description; e.g., Search on the web",
                    "initialRun": true,
                    "fetchTask": false,
                    "parameters": [
                        {
                            "name": "keyword",
                            "title": "Search keywords",
                            "inputType": "choiceset",
                            "description": "Enter the keywords to search for",
                            "value": "Initial value for the parameter",
                            "choices": [
                                {
                                    "title": "Title of the choice",
                                    "value": "Value of the choice"
                                }
                            ]
                        }
                    ]
                },
                {
                    "id": "exampleCmd2",
                    "title": "Example Command 2",
                    "type": "action",
                    "context": [
                        "message"
                    ],
                    "description": "Command Description; e.g., Add a customer",
                    "initialRun": true,
                    "fetchTask": false ,
                    "parameters": [
                        {
                            "name": "custinfo",
                            "title": "Customer name",
                            "description": "Enter a customer name",
                            "inputType": "text"
                        }
                    ]
                },
                {
                    "id": "exampleCmd3",
                    "title": "Example Command 3",
                    "type": "action",
                    "context": [
                        "compose",
                        "commandBox",
                        "message"
                    ],
                    "description": "Command Description; e.g., Add a customer",
                    "fetchTask": false,
                    "taskInfo": {
                        "title": "Initial dialog title",
                        "width": "Dialog width",
                        "height": "Dialog height",
                        "url": "Initial webview URL"
                    }
                }
            ],
            "messageHandlers": [
                {
                    "type": "link",
                    "value": {
                        "domains": [
                            "mysite.someplace.com",
                            "othersite.someplace.com"
                        ],
                        "supportsAnonymizedPayloads": false
                    }
                }
            ]
        }
    ],
    "permissions": [
        "identity",
        "messageTeamMembers"
    ],
    "devicePermissions": [
        "geolocation",
        "media",
        "notifications",
        "midi",
        "openExternal"
    ],
    "validDomains": [
        "contoso.com",
        "mysite.someplace.com",
        "othersite.someplace.com"
    ],
    "webApplicationInfo": {
        "id": "AAD App ID",
        "resource": "Resource URL for acquiring auth token for SSO"
    },
    "authorization": {
        "permissions": {
            "resourceSpecific": [
                {
                    "type": "Application",
                    "name": "ChannelSettings.Read.Group"
                },
                {
                    "type": "Delegated",
                    "name": "ChannelMeetingParticipant.Read.Group"
                }
            ]
        }
    },
    "showLoadingIndicator": false,
    "isFullScreen": false,
    "activities": {
        "activityTypes": [
            {
                "type": "taskCreated",
                "description": "Task created activity",
                "templateText": "<team member> created task <taskId> for you"
            },
            {
                "type": "userMention",
                "description": "Personal mention activity",
                "templateText": "<team member> mentioned you"
            }
        ]
    },
    "defaultBlockUntilAdminAction": true,
    "publisherDocsUrl": "https://example.com/app-info",
    "defaultInstallScope": "meetings",
    "defaultGroupCapability": {
        "meetings": "tab",
        "team": "bot",
        "groupchat": "bot"
    },
    "configurableProperties": [
        "name",
        "shortDescription",
        "longDescription",
        "smallImageUrl",
        "largeImageUrl",
        "accentColor",
        "developerUrl",
        "privacyUrl",
        "termsOfUseUrl"
    ],
    "subscriptionOffer": {
        "offerId": "publisherId.offerId"
    },
    "meetingExtensionDefinition": {
        "scenes": [
            {
                "id": "9082c811-7e6a-4174-8173-6ccd57d377e6",
                "name": "Getting started sample",
                "file": "scenes/sceneMetadata.json",
                "preview": "scenes/scenePreview.png",
                "maxAudience": 15,
                "seatsReservedForOrganizersOrPresenters": 0
            },
            {
                "id": "afeaed22-f89b-48e1-98b4-46a514344e4a",
                "name": "Sample-1",
                "file": "scenes/sceneMetadata.json",
                "preview": "scenes/scenePreview.png",
                "maxAudience": 15,
                "seatsReservedForOrganizersOrPresenters": 3
            }
        ]
    }
}

The schema defines the following properties:

$schema

Optional, but recommended – String

The https:// URL referencing the JSON Schema for the app manifest.

manifestVersion

Required – String

The version of the app manifest schema that this manifest is using. Use 1.13 to enable Teams app support in Outlook and Microsoft 365 app; use 1.12 (or earlier) for Teams-only apps.

version

Required – String

The version of a specific app. When you update something in your app manifest, the version must be incremented too. This way, when the new app manifest is installed, it overwrites the existing one and the user receives the new functionality. When this app was submitted to the Microsoft Teams Store, the new app manifest must be resubmitted and revalidated. The app users receive the new updated app manifest automatically within few hours after the app manifest is approved.

If the app requests for permissions change, the users are prompted to upgrade and reconsent to the app.

This version string must follow the semver standard (MAJOR.MINOR.PATCH).

Note

If your app includes an Office Add-in, each segment of the version string is limited to a maximum of five digits. The semver standard's pre-release and metadata version string extensions aren't supported.

ID

Required – Microsoft app ID

The ID is a unique Microsoft-generated identifier for the app. The format of the ID is GUID. You have an ID if your bot is registered through the Microsoft Bot Framework. You have an ID if your tab's web app already signs in with Microsoft. You must enter the ID here. Otherwise, you must generate a new ID at the Microsoft Application Registration Portal. Use the same ID if you add a bot.

The ID stored in Teams Admin Center is the External App ID and it's visible as ExternalID on the traces.

Note

If you are submitting an update to your existing app in AppSource, the ID in your app manifest must not be modified.

developer

Required – Object

Specifies information about your company. For apps submitted to the Teams Store, these values must match the information in your Teams Store listing. For more information, see the Teams Store publishing guidelines. Developer name helps improve your app discoverability in the Teams Store.

Name	Type	Maximum size	Required	Description
`name`	String	32 characters	✔️	The display name for the developer.
`websiteUrl`	String	2048 characters	✔️	The https:// URL to the developer's website. This link must take users to your company or product-specific landing page.
`privacyUrl`	String	2048 characters	✔️	The https:// URL to the developer's privacy policy.
`termsOfUseUrl`	String	2048 characters	✔️	The https:// URL to the developer's terms of use.
`mpnId`	String	10 characters		Optional The Microsoft Cloud Partner Program ID (formerly known as Microsoft Partner Network (MPN) ID) that identifies the partner organization building the app.

name

Required – Object

The name of your app experience, displayed to users in the Teams experience. For apps submitted to AppSource, these values must match the information in your AppSource entry. The values of short and full must be different. App name helps improve your app discoverability in the Teams Store.

Name	Type	Maximum size	Required	Description
`short`	String	30 characters	✔️	The short display name for the app. Use `short` property where the space is limited, such as the app header.
`full`	String	100 characters	✔️	The full name of the app, used if the full app name exceeds 30 characters. Use `full` property where there's more space, such as the app catalog or the app details page.

Note

In the app manifest v1.17 or later the full property is required and for app manifest v1.16 or earlier it isn't required.
The short property is used across all UI surfaces.

description

Required – Object

Describes your app to users. For apps submitted to AppSource, these values must match the information in your AppSource entry. App description helps improve your app discoverability in the Teams Store.

Ensure that your description describes your experience and helps potential customers understand what your experience does. You must note in the full description, if an external account is required for use. The values of short and full must be different. Your short description can't be repeated within the long description and must not include any other app name.

Name	Type	Maximum size	Required	Description
`short`	String	80 characters	✔️	A short description of your app experience, used when space is limited.
`full`	String	4000 characters	✔️	The full description of your app.

localizationInfo

Optional – Object

Allows the specification of a default language, and pointers to additional language files. See localization.

Name	Type	Maximum size	Required	Description
`defaultLanguageTag`	String		✔️	The language tag for the strings in this top-level app manifest file. Default is `en-us`.
`defaultLanguageFile`	String	2048 characters		A relative file path to the .json file that contains the strings. If unspecified, strings are taken directly from the app manifest file. A default language file is required for Copilot agents that support multiple languages.

localizationInfo.additionalLanguages

An array of objects, each with the following properties to specify additional language translations.

Name	Type	Maximum size	Required	Description
`languageTag`	String		✔️	The language tag of the strings in the provided file. For example, `es`
`file`	String	2048 characters	✔️	A relative file path to the .json file that contains the translated strings.

icons

Required – Object

Icons used within the Teams app. The icon files must be included as part of the upload package. For more information, see Icons.

Name	Type	Maximum size	Required	Description
`outline`	String	32 x 32 pixels	✔️	A relative file path to a transparent 32x32 PNG outline icon. The border color must be white.
`color`	String	192 x 192 pixels	✔️	A relative file path to a full color 192x192 PNG icon.

accentColor

Required – HTML Hex color code

A color to use and as a background for your color icons.

The value must be a valid HTML color code starting with '#', for example #4464ee. For more information, see accentColor.

copilotAgents

Optional – Object

Defines one or more agents to Microsoft 365 Copilot. Declarative agents are customizations of Microsoft 365 Copilot that run on its same orchestrator and foundation models.

Name	Type	Maximum size	Required	Description
`declarativeAgents`	Array of objects	1	✔️	Array of objects that each define a declarative agent.

declarativeAgents

Represents a customization of Microsoft 365 Copilot, as defined by its manifest file.

Name	Type	Maximum size	Required	Description
`id`	String		✔️	Unique identifier for the agent. When using Microsoft Copilot Studio to build agents, this is auto-generated. Otherwise, manually assign the value according to your own conventions or preference.
`file`	String	2048 characters	✔️	Relative file path within the app package to the declarative agent manifest file.

configurableTabs

Optional – Array

Used when your app experience has a team channel tab experience that requires extra configuration before it's added. Configurable tabs are supported only in the team and groupChat scopes and you can configure the same tabs multiple times. However, you can define it in the app manifest only once.

Name	Type	Maximum size	Required	Description
`configurationUrl`	String	2048 characters	✔️	The https:// URL to use when configuring the tab.
`scopes`	Array of enums	2	✔️	The configurable tabs support only the `team` and `groupChat` scopes.
`canUpdateConfiguration`	Boolean			A value indicating whether an instance of the tab's configuration can be updated by the user after creation. Default value: `true`
`meetingSurfaces`	Array of enums	2		The set of `meetingSurfaceItem` scopes where a tab is supported. Default values: `sidePanel`, `stage`
`context`	Array of enums	8		The set of `contextItem` scopes where a tab is supported. Accepted value: [personalTab, channelTab, privateChatTab, meetingChatTab, meetingDetailsTab, meetingSidePanel, meetingStage].
`sharePointPreviewImage`	String	2048 characters		A relative file path to a tab preview image for use in SharePoint. Size 1024x768.
`supportedSharePointHosts`	Array of enums	2		Defines how your tab is made available in SharePoint. Options are `sharePointFullPage` and `sharePointWebPart`.

staticTabs

Optional – Array

Defines a set of tabs that can be pinned by default, without the user adding them manually. Static tabs declared in personal scope are always pinned to the app's personal experience. However, the pinned tabs can be reordered by adding the details of the tab in the same desired order. For more information, see reorder static personal tabs.

This property also enables you to set the default landing capability for an app supporting both tab and bot capabilities in personal scope. For more information, see configure default landing capability.

This item is an array (maximum of 16 elements) with all elements of the type object. This block is required only for solutions that provide a static tab solution.

Name	Type	Maximum size	Required	Description
`entityId`	String	64 characters	✔️	A unique identifier for the entity that the tab displays.
`name`	String	128 characters		The display name of the tab.
`contentUrl`	String	2048 characters		The https:// URL that points to the entity UI to be displayed in the Teams canvas.
`contentBotId`	String	128 characters		The Microsoft app ID specified for the bot in the Bot Framework portal.
`websiteUrl`	String	2048 characters		The https:// URL to point to if a user opts to view in a browser.
`searchUrl`	String	2048 characters		The https:// URL to point to for a user's search queries.
`scopes`	Array of enums	3	✔️	Specifies whether the tab offers an experience in the context of a channel in a team, or an experience scoped to an individual user or group chat. The static tabs support `personal` scope only.
`context`	Array of enums	8		The set of `contextItem` contexts where a tab is supported. Accepted values: `personalTab`, `channelTab`, `privateChatTab`, `meetingChatTab`, `meetingDetailsTab`, `meetingStage`, `meetingSidepanel`, `teamLevelApp`. Default values: `personalTab`, `channelTab`, `privateChatTab`, `meetingChatTab`, `meetingDetailsTab`.

Note

The groupChat and team scopes are supported only in public developer preview.
The teamLevelApp context is dedicated only for Education tenants.
The searchUrl feature is not available for the third-party developers.
If your tabs require context-dependent information to display relevant content or for initiating an authentication flow, For more information, see Get context for your Microsoft Teams tab.

bots

Optional – Array

Defines a bot solution, along with optional information such as default command properties.

The item is an array (maximum of only one element— only one bot is allowed per app) with all elements of the type object. This block is required only for solutions that provide a bot experience.

Name	Type	Maximum size	Required	Description
`botId`	String		✔️	The unique Microsoft app ID for the bot as registered with the Bot Framework. The ID can be the same as the overall app ID.
`scopes`	Array of enums	3	✔️	Specifies whether the bot offers an experience in the context of a channel in a `team`, in a group chat (`groupChat`), or an experience scoped to an individual user alone (`personal`). These options are non-exclusive.
`needsChannelSelector`	Boolean			Describes whether or not the bot uses a user hint to add the bot to a specific channel. Default value: `false`
`isNotificationOnly`	Boolean			Indicates whether a bot is a one-way, notification-only bot, as opposed to a conversational bot. Default value: `false`
`supportsFiles`	Boolean			Indicates whether the bot supports the ability to upload/download files in personal chat. Default value: `false`
`supportsCalling`	Boolean			A value indicating where a bot supports audio calling. IMPORTANT: This property is experimental. Experimental properties might be incomplete and might undergo changes before they're fully available. The property is provided for testing and exploration purposes only and must not be used in production applications. Default value: `false`
`supportsVideo`	Boolean			A value indicating where a bot supports video calling. IMPORTANT: This property is experimental. Experimental properties might be incomplete and might undergo changes before they're fully available. The property is provided for testing and exploration purposes only and must not be used in production applications. Default value: `false`

bots.configuration

Optional – Object

Name	Type	Maximum size	Required	Description
`team.fetchTask`	Boolean		✔️	A boolean value that indicates if it should fetch dialog (referred as task module in TeamsJS v1.x) dynamically. Default value: `false`
`team.taskInfo`	Object		✔️	The dialog to preload when you use a bot
`team.taskInfo.title`	String	64 characters	✔️	Initial dialog title.
`team.taskInfo.width`	String	16 characters		The dialog width is either a number in pixels or default layout such as `large`, `medium`, or `small`.
`team.taskInfo.height`	String	16 characters		The dialog height is either a number in pixels or default layout such as `large`, `medium`, or `small`.
`team.taskInfo.url`	String	2048 characters		Initial webview URL.
`groupChat.fetchTask`	Boolean		✔️	A boolean value that indicates if it should fetch dialog dynamically. Default value: `false`
`groupChat.taskInfo`	Object			Dialog to be launched when fetch task set to false. Default value: `false`
`groupChat.taskInfo.title`	String	64 characters	✔️	Initial dialog title.
`groupChat.taskInfo.width`	String	16		The dialog width is either a number in pixels or default layout such as `large`, `medium`, or `small`.
`groupChat.taskInfo.height`	String	16		The dialog height is either a number in pixels or default layout such as `large`, `medium`, or `small`.
`groupChat.taskInfo.url`	String	2048 characters		Initial webview URL.

bots.commandLists

Optional – Array

A list of commands that your bot can recommend to users. The object is an array (maximum of three elements) with all elements of type object; you must define a separate command list for each scope that your bot supports. For more information, see Bot menus.

Name	Type	Maximum size	Required	Description
`scopes`	Array of enums	3	✔️	Specifies the scope for which the command list is valid. Options are `team`, `personal`, and `groupChat`.
`commands`	Array of objects	10	✔️	An array of commands the bot supports.

Note

Teams mobile client doesn't support the bot app when there is no value in the commandLists property.

bots.commandLists.commands

Required – Array

Name	Type	Maximum size	Required	Description
`title`	String	32	✔️	The bot command name.
`description`	String	128 characters	✔️	A simple text description or an example of the command syntax and its arguments.

connectors

Optional – Array

The connectors block defines a connector card for Microsoft 365 Groups for the app.

The object is an array (maximum of one element) with all elements of type object. This block is required only for solutions that provide a Connector.

Name	Type	Maximum size	Required	Description
`configurationUrl`	String	2048 characters	✔️	The https:// URL to use when configuring the connector using the inline configuration experience.
`scopes`	Array of enums	1	✔️	Specifies whether the Connector offers an experience in the context of a channel in a `team`, or an experience scoped to an individual user alone (`personal`). The `team` scope is only supported.
`connectorId`	String	64 characters	✔️	A unique identifier for the Connector that matches its ID in the Connectors Developer Dashboard.

composeExtensions

Optional – Array

Defines a message extension for the app.

Note

The name of the feature was changed from "compose extension" to "message extension" in November, 2017, but the app manifest name remains the same so that existing extensions continue to function.

The item is an array (maximum of one element) with all elements of type object. This block is required only for solutions that provide a message extension.

Name	Type	Maximum Size	Required	Description
`botId`	String			The unique Microsoft app ID for the bot that backs the message extension, as registered with the Bot Framework. The ID can be the same as the overall App ID.
`composeExtensionType`	String		✔️	Type of the compose extension. Enum values are `botBased` and `apiBased`.
`authorization`	Object	2		Authorization related information for the API-based message extension.
`authorization.authType`	String			Enum of possible authorization types. Supported values are `none`, `apiSecretServiceAuth`, and `microsoftEntra`.
`authorization.microsoftEntraConfiguration`	Object			Object capturing details needed to do microsoftEntra auth flow. Applicable only when auth type is `microsoftEntra`.
`authorization.microsoftEntraConfiguration.supportsSingleSignOn`	Boolean			A value indicating whether single sign-on is configured for the app.
`authorization.apiSecretServiceAuthConfiguration`	Object			Object capturing details needed to do service auth. Applicable only when auth type is `apiSecretServiceAuth`.
`authorization.apiSecretServiceAuthConfiguration.apiSecretRegistrationId`	String	128 characters		Registration ID returned when developer submits the API key through Developer Portal.
`apiSpecificationFile`	String	2048 characters		A relative file path to the API specification file in the manifest package.
`canUpdateConfiguration`	Boolean			A value indicating whether the configuration of a message extension can be updated by the user. Default value: `false`
`commands`	Array of objects	10	✔️	Array of commands the message extension supports.
`messageHandlers`	Array of objects	5		A list of handlers that allow apps to be invoked when certain conditions are met.
`messageHandlers.type`	String			The type of message handler. Must be `link`.
`messageHandlers.value.domains`	Array of strings	2048 characters		Array of domains that the link message handler can register for.
`messageHandlers.value.supportsAnonymizedPayloads`	Boolean			A boolean value that indicates whether the app's link message handler supports anonymous invoke flow. Default value: `false`

composeExtensions.commands

Your message extension must declare one or more commands with a maximum of 10 commands. Each command appears in Microsoft Teams as a potential interaction from the UI-based entry point.

Each command item is an object with the following structure:

Name	Type	Maximum size	Required	Description
`id`	String	64 characters	✔️	The ID for the command.
`type`	String			Type of the command. One of `query` or `action`. Default value: `query`
`samplePrompts`	Array	5		Property used by Microsoft 365 Copilot to display prompts supported by the plugin to the user.
`samplePrompts.text`	String	128 characters	✔️	Content of the sample prompt.
`apiResponseRenderingTemplateFile`	String	2048 characters		A relative file path for api response rendering template file used to format the JSON response from developer’s API to Adaptive Card response.
`context`	Array of strings	3		Defines where the message extension can be invoked from. Any combination of `compose`, `commandBox`, `message`. Default values: `compose, commandBox`
`title`	String	32 characters	✔️	The user-friendly command name.
`description`	String	128 characters		The description that appears to users to indicate the purpose of this command.
`semanticDescription`	String	5000 characters		Semantic description of the command for consumption by Microsoft 365 Copilot using Large Language Models (LLMs).
`initialRun`	Boolean			A Boolean value indicates whether the command runs initially with no parameters. Default value: `false`
`fetchTask`	Boolean			A Boolean value that indicates if it must fetch the dialog (referred as task module in TeamsJS v1.x) dynamically. Default value: `false`
`taskInfo`	Object			Specify the dialog to preload when using a message extension command.
`taskInfo.title`	String	64 characters		Initial dialog title.
`taskInfo.width`	String			Dialog width - either a number in pixels or default layout values such as `large`, `medium`, or `small`.
`taskInfo.height`	String			Dialog height - either a number in pixels or default layout values such as `large`, `medium`, or `small`.
`taskInfo.url`	String			Initial webview URL.
`parameters`	Array of objects	5		The list of parameters the command takes.
`parameters.name`	String	64 characters	✔️	The name of the parameter as it appears in the client. The parameter name is included in the user request.
`parameters.title`	String	32 characters	✔️	User-friendly title for the parameter.
`parameters.description`	String	128 characters		User-friendly string that describes this parameter’s purpose.
`parameters.semanticDescription`	String	2000 characters		Semantic description of the parameter for consumption by Microsoft 365 Copilot using Large Language Models (LLMs).
`parameters.value`	String	512 characters		Initial value for the parameter. The value isn't supported.
`parameters.inputType`	String			Defines the type of control displayed on a dialog for `fetchTask: false`. Input value can only be one of `text`, `textarea`, `number`, `date`, `time`, `toggle`, `choiceset`. Default value: `text`
`parameters.choices`	Array of objects	10 items		The choice options for the `choiceset`. Use only when `parameters.inputType` is `choiceset`.
`parameters.choices.title`	String	128 characters	✔️	Title of the choice.
`parameters.choices.value`	String	512 characters	✔️	Value of the choice.

permissions

Optional – Array of strings

An array of string, which specifies which permissions the app requests, which let end users know how the extension does. The following options are non-exclusive:

identity Requires user identity information.
messageTeamMembers Requires permission to send direct messages to team members.

Changing these permissions during app update, causes your users to repeat the consent process after they run the updated app. For more information, see Updating your app.

Note

Permissions are deprecated now.

devicePermissions

Optional – Array of strings

Provides the native features on a user's device that your app requests access to. Options are:

geolocation
media
notifications
midi
openExternal

validDomains

Optional (except Required where noted) – Array of strings

A list of valid domains for websites the app expects to load within the Teams client. Domain listings can include wildcards, for example, *.example.com. The valid domain matches exactly one segment of the domain; if you need to match a.b.example.com then use *.*.example.com. If your tab configuration or content UI navigates to any other domain other than tab configuration, that domain must be specified here.

Do not include the domains of identity providers you want to support in your app. For example, to authenticate using a Google ID, it's required to redirect to accounts.google.com, however, you must not include accounts.google.com in validDomains[].

Teams apps that require their own SharePoint URLs to function well, includes "{teamsitedomain}" in their valid domain list.

Important

Don't add domains that are outside your control, either directly or through wildcards (). For example,.yoursite.com is valid, but *.onmicrosoft.com isn't valid as it isn't under your control.

When using wildcards, the following rules apply:

If a subdomain segment includes a wildcard, it must be the only character in the segment.
Any segment preceding a wildcard segment must also be a wildcard segment.

For example, *.*.domain.com is valid, but foo.*.myteam.domain.com is not valid.

The object is an array with all elements of the type string. The maximum item of the object is 16 and maximum length is 2048 characters.

webApplicationInfo

Note

The webApplicationInfo property is related to a single domain and isn't supported for multiple domains. Therefore, if you've two apps hosted on different domains, you need to create separate app manifests for each app.

Optional – Object

Provide your Microsoft Entra App ID and Microsoft Graph information to help users seamlessly sign into your app. If your app is registered in Microsoft Entra ID, you must provide the App ID. Administrators can easily review permissions and grant consent in Teams admin center.

Name	Type	Maximum size	Required	Description
`id`	String		✔️	Microsoft Entra application ID of the app. This ID must be a GUID.
`resource`	String	2048 characters		Resource URL of app for acquiring auth token for SSO. NOTE: If you aren't using SSO, ensure that you enter a dummy string value in this field to your app manifest, for example, `https://example` to avoid an error response. The dummy URL string value mustn't contain domains or URLs that aren't in your control, either directly or through wildcards. For example, `yourapp.onmicrosoft.com` is valid, but `.onmicrosoft.com` isn't valid. The top-level domains are prohibited, for example, `.com`, `*.org`.

graphConnector

Optional – Object

Specify the app's Graph connector configuration. If this is present, then webApplicationInfo.id must also be specified.

Name	Type	Maximum size	Required	Description
`notificationUrl`	String	2048 characters	✔️	The url where Graph-connector notifications for the application should be sent.

showLoadingIndicator

Optional – Boolean

Indicates if or not to show the loading indicator when an app or tab is loading. Default is false.

Note

If you select showLoadingIndicator as true in your app manifest, to load the page correctly, modify the content pages of your tabs and dialogs as described in Show a native loading indicator document.
If you don't modify the content pages of your tab, the tab app doesn't load and shows the error There was a problem reaching this app.

isFullScreen

Optional – Boolean

Indicates if a personal app is rendered without a tab header bar (signifying full screen mode). Default value: false

Note

isFullScreen only works for apps published to your organization. Uploaded and published third-party apps can't use this property (it's ignored).
The isFullScreen=true parameter eliminates the header bar and title provided by Teams from personal apps and dialogs. However, it's recommended not to use the isFullScreen=true parameter with chat bot apps.

activities

Optional – Object

Define the properties your app uses to post a user activity feed.

Name	Type	Maximum size	Required	Description
`activityTypes`	Array of objects	128 items		Provide the types of activities that your app can post to a users activity feed.

activities.activityTypes

Name	Type	Maximum size	Required	Description
`type`	String	64 characters	✔️	The notification type.
`description`	String	128 characters	✔️	A brief description of the notification.
`templateText`	String	128 characters	✔️	Ex: "{actor} created task {taskId} for you"

{
   "activities":{
      "activityTypes":[
         {
            "type":"taskCreated",
            "description":"Task Created Activity",
            "templateText":"{actor} created task {taskId} for you"
         },
         {
            "type":"teamMention",
            "description":"Team Mention Activity",
            "templateText":"{actor} mentioned team"
         },
         {
            "type":"channelMention",
            "description":"Channel Mention Activity",
            "templateText":"{actor} mentioned channel"
         },
         {
            "type":"userMention",
            "description":"Personal Mention Activity",
            "templateText":"{actor} mentioned user"
         },
         {
            "type":"calendarForward",
            "description":"Forwarding a Calendar Event",
            "templateText":"{actor} sent user an invite on behalf of {eventOwner}"
         },
         {
            "type":"calendarForward",
            "description":"Forwarding a Calendar Event",
            "templateText":"{actor} sent user an invite on behalf of {eventOwner}"
         },
         {
            "type":"creatorTaskCreated",
            "description":"Created Task Created",
            "templateText":"The Creator created task {taskId} for you"
         }
      ]
   }
}

defaultInstallScope

Optional – String

Specifies the install scope defined for this app by default. The defined scope is the option displayed on the button when a user tries to add the app. Options are:

personal
team
groupChat
meetings

defaultGroupCapability

Optional – Object

When a group install scope is selected, it defines the default capability when the user installs the app.

Name	Type	Description
`team`	String	When the install scope selected is `team`, this field specifies the default capability available. Options: `tab`, `bot`, or `connector`.
`groupchat`	String	When the install scope selected is `groupChat`, this field specifies the default capability available. Options: `tab`, `bot`, or `connector`.
`meetings`	String	When the install scope selected is `meetings`, this field specifies the default capability available. Options: `tab`, `bot`, or `connector`.

configurableProperties

Optional – Array

The configurableProperties block defines the app properties that Teams admins can customize. For more information, see enable app customization. The app customization feature isn't supported in custom apps or custom apps built for your org (LOB apps).

Note

A minimum of one property must be defined. You can define a maximum of nine properties in this block.

You can define any of the following properties:

name: The app's display name.
shortDescription: The app's short description.
longDescription: The app's long description.
smallImageUrl: The app's outline icon.
largeImageUrl: The app's color icon.
accentColor: The color to use and a background for your outline icons.
developerUrl: The HTTPS URL of the developer's website.
privacyUrl: The HTTPS URL of the developer's privacy policy.
termsOfUseUrl: The HTTPS URL of the developer's terms of use.

supportedChannelTypes

Optional – Array

Enables your app in non-standard channels. If your app supports a team scope and this property is defined, Teams enables your app in each channel type accordingly. The supportedChannelTypes property only supports sharedChannels and privateChannels.

Note

If your app supports a team scope, it functions in the standard channels regardless of the values that are defined in this property.
Your app can account for the unique properties of each of the channel types to function properly. To enable your tab for private and shared channels, see retrieve context in private channels and get context in shared channels

defaultBlockUntilAdminAction

Optional – Boolean

When defaultBlockUntilAdminAction property is set to true, the app is hidden from users by default until admin allows it. If set to true, the app is hidden for all tenants and end users. The tenant admins can see the app in the Teams admin center and take action to allow or block the app. The default value is false. For more information on default app block, see Block apps by default for users until an admin approves.

publisherDocsUrl

Optional – String

Maximum size - 2048 characters

The value of the publisherDocsUrl parameter is a secure HTTPS URL to the app documentation and information page that app developers choose to provide. Tenant admins get documentation about the app at this URL. Teams admin center displays the URL in the app details page. The documentation may include the instructions for admins to facilitate app adoption and app rollout. In the app documentation, you can also include instructions or information about the app that is useful for the tenant admin, users, and other business stakeholders.

subscriptionOffer

Optional – Object

Specifies the SaaS offer associated with your app.

Name	Type	Maximum size	Required	Description
`offerId`	String	2048 characters	✔️	A unique identifier that includes your Publisher ID and Offer ID, which you can find in Partner Center. You must format the string as `publisherId.offerId`.

meetingExtensionDefinition

Optional – Object

Specify meeting extension definition. For more information, see custom Together Mode scenes in Teams.

Name	Type	Maximum size	Description
`scenes`	Array of objects	5 items	Meeting supported scenes.
`supportsStreaming`	Boolean		A value that indicates whether an app can stream the meeting's audio and video content to a real-time meeting protocol (RTMP) endpoint. Default value: `false`
`supportsAnonymousGuestUsers`	Boolean		A value that indicates whether an app supports access for anonymous users. Default value: `false`

Note

The supportsAnonymousGuestUsers property in the app manifest schema v1.16 is supported only in new Teams client.

meetingExtensionDefinition.scenes

Name	Type	Maximum size	Required	Description
`id`	String		✔️	The unique identifier for the scene. This id must be a GUID.
`name`	String	128 characters	✔️	The name of the scene.
`file`	String	2048 characters	✔️	The relative file path to the scenes' metadata json file.
`preview`	String	2048 characters	✔️	The relative file path to the scenes' PNG preview icon.
`maxAudience`	Integer	50	✔️	The maximum number of audiences supported in the scene.
`seatsReservedForOrganizersOrPresenters`	Integer	50	✔️	The number of seats reserved for organizers or presenters.

authorization

Optional – Object

Note

authorization is only supported for the app manifest version 1.12 or later.

Specify and consolidate authorization related information for the app.

Name	Type	Maximum size	Required	Description
`permissions`	Object			List of permissions that the app needs to function.

authorization.permissions

Name	Type	Maximum size	Required	Description
`resourceSpecific`	Array of objects	16 items		Permissions that guard data access on resource instance level.

authorization.permissions.resourceSpecific

Name	Type	Maximum size	Required	Description
`type`	String		✔️	The type of the resource-specific consent (RSC) permission. Options: `Application` and `Delegated`.
`name`	String	128 characters	✔️	The name of the RSC permission. For more information, see RSC application permissions and RSC delegated permissions

RSC application permissions

Application permissions allow the app to access data without a signed-in user. For information on application permissions, see RSC permissions for Microsoft Graph and Microsoft BotSDK.

RSC delegated permissions

Delegated permissions allow the app to access data on behalf of the signed-in user.

RSC delegated permissions for a team

Name	Description
`ChannelMeetingParticipant.Read.Group`	Allows the app to read participant information, including name, role, id, joined, and left times, of channel meetings associated with this team, on behalf of the signed-in user.
`ChannelMeetingIncomingAudio.Detect.Group`	Allows the app to detect incoming audio in channel meetings associated with the team.
`ChannelMeetingActiveSpeaker.Read.Group`	Allows the app to read the participants who are sending audio into the channel meetings associated with the team.
`ChannelMeetingAudioVideo.Stream.Group`	Allows the app to stream audio-video content from channel meetings associated with the team.
`InAppPurchase.Allow.Group`	Allows the app to show marketplace offers to users in the team and complete their purchases within the app, on behalf of the signed-in user.
`ChannelMeetingStage.Write.Group`	Allows the app to show content on the meeting stage in channel meetings associated with the team, on behalf of the signed-in user.
`LiveShareSession.ReadWrite.Group`	Allows the app to create and synchronize Live Share sessions for the team and get access related information, such as name and role, about the team's roster and any associated meetings, on behalf of the signed-in user.
`MeetingParticipantReaction.Read.Group`	Allows the app to read reactions of participants in channel meetings associated with the team.

RSC delegated permissions for chats or meetings

Name	Description
`InAppPurchase.Allow.Chat`	Allows the app to show marketplace offers to the users in the chat, and any associated meeting, and complete their purchases within the app, on behalf of the signed-in user.
`MeetingStage.Write.Chat`	Allows the app to show content on the meeting stage in meetings associated with the chat, on behalf of the signed-in user.
`OnlineMeetingParticipant.Read.Chat`	Allows the app to read participant information, including name, role, id, joined, and left times, of meeting associated with the chat, on behalf of the signed-in user.
`OnlineMeetingParticipant.ToggleIncomingAudio.Chat`	Allows the app to toggle incoming audio for participants in meetings associated with the chat, on behalf of the signed-in user.
`LiveShareSession.ReadWrite.Chat`	Allows the app to create and synchronize Live Share sessions for the chat and get access related information, such as name and role, about the chat's roster and any associated meetings, on behalf of the signed-in user.
`MeetingParticipantReaction.Read.Chat`	Allows the app to read reactions of participants in meetings associated with the chat.
`OnlineMeetingIncomingAudio.Detect.Chat`	Allows the app to detect changes in the status of incoming audio in meetings associated with the chat, on behalf of the signed-in user.
`OnlineMeetingActiveSpeaker.Read.Chat`	Allows the app to read participants who are sending audio into the meetings associated with the chat.
`OnlineMeetingAudioVideo.Stream.Chat`	Allows the app to stream audio-video content of meetings associated with the chat.

RSC delegated permissions for users

Name	Description
`CameraStream.Read.User`	Allows the app to read user's camera stream.
`InAppPurchase.Allow.User`	Allows the app to show the user marketplace offers and complete the user's purchases within the app, on behalf of the signed-in user.
`OutgoingVideoStream.Write.User`	Allows the app to modify the user's outgoing video.
`MicrophoneStream.Read.User`	Allows the app to read user's microphone stream.
`MeetingParticipantReaction.Read.User`	Allows the app to read user's reactions while participating in a meeting.

extensions

Optional – Object

The extensions property specifies Outlook Add-ins within an app manifest and simplifies the distribution and acquisition across the Microsoft 365 ecosystem. Each app supports only one extension.

Name	Type	Maximum size	Required	Description
`requirements`	Object			Specifies the set of client or host requirements for the extension.
`runtimes`	Array	20		Configures the set of runtimes and actions that can be used by each extension point. For more information, see runtimes in Office Add-ins.
`ribbons`	Array	20		Defines the ribbons extension point.
`autoRunEvents`	Array	10		Defines the event-based activation extension point.
`alternates`	Array		10	Specifies the relationship to alternate existing Microsoft 365 solutions. It's used to hide or prioritize add-ins from the same publisher with overlapping functionality.
`audienceClaimUrl`	String	2048 characters		Specifies the URL for your extension and is used to validate Exchange user identity tokens. For more information, see inside the Exchange identity token

For more information, see Office Add-ins manifest for Microsoft 365.

extensions.requirements

The extensions.requirements object specifies the scopes, form factors, and Office JavaScript Library requirement sets that must be supported on the Office client in order for the add-in to be installed. Requirements are also supported on the "ribbon", "runtime", "alternates", and "autoRunEvents" child properties to selectively filter out some features of the add-in. For more information, see Specify Office Add-in requirements in the unified manifest for Microsoft 365.

Name	Type	Maximum size	Required	Description
`capabilities`	Array	100		Identifies the requirement sets.
`capabilities.name`	String		✔️	Identifies the name of the requirement set.
`capabilities.minVersion`	String			Identifies the minimum version for the requirement set.
`capabilities.maxVersion`	String			Identifies the maximum version for the requirement set.
`scopes`	Array of enums	1		Identifies the scopes in which the add-in can run and defines the Microsoft 365 applications in which the extension can run. For example, `mail` (Outlook). Supported value: `mail`
`formFactors`	Array of enums			Identifies the form factors that support the add-in. Supported values: `mobile`, `desktop`

extensions.runtimes

Optional – Array

The extensions.runtimes array configures the sets of runtimes and actions that each extension point can use.

Name	Type	Maximum size	Required	Description
`id`	String	64 characters	✔️	Specifies the ID for runtime.
`type`	String enum		✔️	Specifies the type of runtime. The supported enum value for browser-based runtime is `general`.
`code`	Object		✔️	Specifies the location of code for the runtime. Based on `runtime.type`, add-ins can use either a JavaScript file or an HTML page with an embedded `script` tag that specifies the URL of a JavaScript file. Both URLs are necessary in situations where the `runtime.type` is uncertain.
`code.page`	String	2048 characters	✔️	Specifies the URL of the web page that contains an embedded `script` tag, which specifies the URL of a JavaScript file (to be loaded in a browser-based runtime).
`code.script`	String	2048 characters		Specifies the URL of the JavaScript file to be loaded in JavaScript-only runtime.
`lifetime`	String enum			Specifies the lifetime of the runtime. Runtimes with a `short` lifetime don’t preserve state across executions while runtimes with a `long` lifetime do. For more information, see Runtimes in Office Add-ins. Default value: `short`
`actions`	Array	20		Specifies the set of actions supported by the runtime. An action is either running a JavaScript function or opening a view such as a task pane.
`actions.id`	String	64 characters	✔️	Specifies the ID for the action, which is passed to the code file.
`actions.type`	String		✔️	Specifies the type of action. The `executeFunction` type runs a JavaScript function without waiting for it to finish and the `openPage` type opens a page in a given view.
`actions.displayName`	String	64 characters		Specifies the display name of the action and it isn't the label of a button or a menu item that invokes the action (which is configured with `tabs.groups.controls.label`).
`actions.pinnable`	Boolean			Specifies that a task pane supports pinning, which keeps the task pane open when the user changes the selection. Default value: `false`
`actions.view`	String	64 characters		Specifies the view where the page must be opened. It's used only when `actions.type` is `openPage`.
`actions.multiselect`	Boolean			Specifies whether the end user can select multiple items, such as multiple email messages, and apply the action to all of them. Default value: `false`
`actions.supportsNoItemContext`	Boolean			Allows task pane add-ins to activate without the reading pane enabled or a message selected. Default value: `false`
`requirements`	Object			Specifies the scopes, formFactors, and Office JavaScript Library requirement sets that must be supported on the Office client in order for the runtime to be included in the add-in. For more information, see Specify Office Add-in requirements in the unified manifest for Microsoft 365.
`requirements.capabilities`	Array			Identifies the requirement sets. Options: `name` (required), `minVersion`, `maxVersion`
`requirements.capabilities.name`	String		✔️	Identifies the name of the requirement set.
`requirements.capabilities.minVersion`	String			Identifies the minimum version for the requirement set.
`requirements.capabilities.maxVersion`	String			Identifies the maximum version for the requirement set.
`requirements.scopes`	Array of enums	1		Identifies the scopes in which the add-in can run and defines the Microsoft 365 applications in which the extension can run. For example, `mail` (Outlook). Supported value: `mail`
`requirements.formFactors`	Array of enums			Identifies the form factors that support the add-in. Supported values: `mobile`, `desktop`

To use extensions.runtimes, see create add-in commands, configure the runtime for a task pane, and configure the runtime for the function command.

extensions.ribbons

Optional – Array

The extensions.ribbons property provides the ability to add add-in commands (buttons and menu items) to the Microsoft 365 application's ribbon. The ribbon definition is selected from the array based on the requirements and first-of order.

Name	Type	Maximum size	Required	Description
`contexts`	Array	7		Specifies the Microsoft 365 application window in which the ribbon customization is available to the user. Each item in the array is a member of a string array. Supported values: `mailRead`, `mailCompose`, `meetingDetailsOrganizer`, `meetingDetailsAttendee`, `onlineMeetingDetailsOrganizer`, `logEventMeetingDetailsAttendee`, `default`
`requirements`	Object			Specifies the scopes, formFactors, and Office JavaScript Library requirement sets that must be supported on the Office client in order for the ribbon customization to appear. For more information, see Specify Office Add-in requirements in the unified manifest for Microsoft 365.
`requirements.capabilities`	Array			Identifies the requirement sets. Options: `name` (required), `minVersion`, `maxVersion`
`requirements.capabilities.name`	String		✔️	Identifies the name of the requirement set.
`requirements.capabilities.minVersion`	String			Identifies the minimum version for the requirement set.
`requirements.capabilities.maxVersion`	String			Identifies the maximum version for the requirement set.
`requirements.scopes`	Array of enums	1		Identifies the scopes in which the add-in can run and defines the Microsoft 365 applications in which the extension can run. For example, `mail` (Outlook). Supported value: `mail`
`requirements.formFactors`	Array of enums			Identifies the form factors that support the add-in. Supported values: `mobile`, `desktop`
`tabs`	Array	20	✔️	Configures the custom tabs on the Microsoft 365 application ribbon.
`tabs.id`	String	64 characters		Specifies the ID for the tab within the app.
`tabs.builtInTabId`	String	64 characters		Specifies the ID of a built-in Office ribbon tab. For more information on possible values, see find the IDs of built-in Office ribbon tabs. The only other child properties of the tab object that can be combined with this one are `groups` and `customMobileRibbonGroups`.
`tabs.label`	String	64 characters		Specifies the text displayed for the tab. Despite the maximum length of 64 characters, to correctly align the tab in the ribbon, we recommend you limit the label to 16 characters.
`tabs.position`	Object			Configures the position of the custom tab relative to other tabs on the ribbon.
`tabs.position.builtInTabId`	String	64 characters	✔️	Specifies the ID of the built-in tab that the custom tab should be positioned next to. For more information, see find the IDs of controls and control groups.
`tabs.position.align`	String enum		✔️	Defines the alignment of custom tab relative to the specified built-in tab. Supported values: `after`, `before`
`tabs.groups`	Array	10		Defines groups of controls on a ribbon tab on a non-mobile device. For mobile devices, see `tabs.customMobileRibbonGroups`.
`tabs.groups.id`	String	64 characters		Specifies the ID for the tab group within the app. It must be different from any built-in group ID in the Microsoft 365 application and any other custom group.
`tabs.groups.label`	String	64 characters		Specifies the text displayed for the group. Despite the maximum length of 64 characters, to correctly align the tab in the ribbon, we recommend you limit the label to 16 characters.
`tabs.groups.icons`	Array	3		Specifies the icons displayed for the group.
`tabs.groups.icons.size`	Number		✔️	Specifies the size of the icon in pixels, enumerated as `16`,`20`,`24`,`32`,`40`,`48`,`64`,`80`. Required image sizes: `16`, `32`, `80`.
`tabs.groups.icons.url`	String	2048 characters	✔️	Specifies the absolute URL of the icon.
`tabs.groups.controls`	Array			Configures the buttons and menus in the group.
`tabs.groups.controls.id`	String	64 characters	✔️	Specifies the ID for the control within the app. It must be different from any built-in control ID in the Microsoft 365 application and any other custom control.
`tabs.groups.controls.items`	Array			Configures the items for a menu control.
`tabs.groups.controls.items.id`	String		✔️	Specifies the ID for a menu item.
`tabs.groups.controls.items.type`	String enum		✔️	Defines the menu item's control type. Supported values: `button`
`tabs.groups.controls.items.label`	String	64 characters	✔️	Specifies the text displayed for the menu item.
`tabs.groups.controls.items.icons`	Array			Configures the icons for the menu item.
`tabs.groups.controls.items.icons.size`	Number		✔️	Specifies the size of the icon in pixels, enumerated as `16`,`20`,`24`,`32`,`40`,`48`,`64`,`80`. Required image sizes: `16`, `32`, `80`.
`tabs.groups.controls.items.icons.url`	URL		✔️	Specifies the absolute URL of the icon.
`tabs.groups.controls.items.supertip`			✔️	Configures a supertip for the menu item. A supertip is a UI feature that displays a brief box of help information about a control when the cursor hovers over it. The box may contain multiple lines of text.
`tabs.groups.controls.items.supertip.title`	String	64 characters	✔️	Specifies the title text of the supertip.
`tabs.groups.controls.items.supertip.description`	String	128 characters	✔️	Specifies the description of the supertip.
`tabs.groups.controls.items.actionId`	String	64 characters	✔️	Specifies the ID of the action that is taken when a user selects the control or menu item. The `actionId` must match with some `runtimes.actions.id` property value.
`tabs.groups.controls.items.enabled`	Boolean			Indicates whether the menu item is initially enabled. Default value: `true`
`tabs.groups.controls.items.overriddenByRibbonApi`	Boolean			Specifies whether the menu item is hidden on application and platform combinations which support the API (Office.ribbon.requestCreateControls). This API installs custom contextual tabs on the ribbon. Default value: `false`
`tabs.groups.controls.type`	String		✔️	Defines the control type. Supported values: `button`, `menu`
`tabs.groups.controls.builtInControlId`	String	64 characters	✔️	Specifies the ID of an existing Microsoft 365 control. For more information, see find the IDs of controls and control groups. This property can't be combined with any other child properties of the control object because built-in controls are not customizable by an add-in.
`tabs.groups.controls.label`	String	64 characters	✔️	Specifies the text displayed for the control. Despite the maximum length of 64 characters, to correctly align the tab in the ribbon, we recommend you limit the label to 16 characters.
`tabs.groups.controls.icons`	Array		✔️	Defines the icons for the control. There must be at least three child objects; one each with `size` properties of `16`, `32`, and `80` pixels.
`tabs.groups.controls.icons.size`	Number		✔️	Specifies the size of the icon in pixels, enumerated as `16`,`20`,`24`,`32`,`40`,`48`,`64`,`80`. Required image sizes: `16`, `32`, `80`
`tabs.groups.controls.icons.url`	URL			Specifies the absolute URL to the icon file.
`tabs.groups.controls.supertip`	Object		✔️	Configures a supertip for the control. A supertip is a UI feature that displays a brief box of help information about a control when the cursor hovers over it. The box may contain multiple lines of text.
`tabs.groups.controls.supertip.title`	String	64 characters	✔️	Specifies the title text of the supertip.
`tabs.groups.controls.supertip.description`	String	128 characters	✔️	Specifies the description of the supertip.
`tabs.groups.controls.actionId`	String	64 characters		Required if the control type is `button`. Don't use if the control type is `menu`. Specifies the ID of the action that is taken when a user selects the control. The `actionId` must match the `runtime.actions.id` property of an action in the `runtimes` object.
`tabs.groups.controls.enabled`	Boolean			Indicates whether the control is initially enabled. Default value: `true`
`tabs.groups.controls.overriddenByRibbonApi`	Boolean			Specifies whether the control is hidden on application and platform combinations which support the API (Office.ribbon.requestCreateControls). This API installs custom contextual tabs on the ribbon. Default value: `false`
`tabs.groups.builtInGroupId`	String	64 characters		Specifies the ID of a built-in group. For more information, see find the IDs of controls and control groups. This property can't be combined with any other child properties of the group object because built-in groups are not customizable by an add-in.
`tabs.customMobileRibbonGroups`	Array	10		Defines groups of controls on the default tab of the ribbon on a mobile device. This array property can only be present on tab objects that have a `tabs.builtInTabId` property that is set to `DefaultTab`. For non-mobile devices, see `tabs.groups` above.
`tabs.customMobileRibbonGroups.id`	String	250 characters	✔️	Specifies the ID of the group. It must be different from any built-in group ID in the Microsoft 365 application and any other custom group.
`tabs.customMobileRibbonGroups.label`	String	32 characters	✔️	Specifies the label on the group.
`tabs.customMobileRibbonGroups.controls`	Array	20	✔️	Defines the controls in the group. Only mobile buttons are supported.
`tabs.customMobileRibbonGroups.controls.id`	String	250 characters	✔️	Specifies the ID of the control such as `msgReadFunctionButton`.
`tabs.customMobileRibbonGroups.controls.type`	String enum		✔️	Specifies the type of control. Supported value: `MobileButton`
`tabs.customMobileRibbonGroups.controls.label`	String	32 characters	✔️	Specifies the label on the control.
`tabs.customMobileRibbonGroups.controls.actionId`	String	64 characters	✔️	Specifies the ID of the action that is taken when a user selects the control. The `actionId` must match the `runtime.actions.id` property of an action in the `runtimes` object.
`tabs.customMobileRibbonGroups.controls.icons`	Array	9	✔️	Specifies the icons that appear on the control depending on the dimensions and DPI of the mobile device screen. There must be exactly 9 icons.
`tabs.customMobileRibbonGroups.controls.icons.size`	Number enum		✔️	Size in pixels of the icon. The required sizes are 25, 32, and 48. There must be exactly one of each size for each possible value of the icons' `scale` property.
`tabs.customMobileRibbonGroups.controls.icons.url`	String	2048 characters	✔️	The full, absolute URL of the icon's image file.
`tabs.customMobileRibbonGroups.controls.icons.scale`	Number enum		✔️	Specifies the UIScreen.scale property for iOS devices. The possible values are 1, 2, and 3. There must be exactly one of each value for each possible value of the icons's `size` property.

To use extensions.ribbons, see create add-in commands, configure the UI for the task pane command, and configure the UI for the function command.

extensions.autoRunEvents

Optional – Array

The extensions.autoRunEvents property defines event-based activation extension points.

Name	Type	Maximum size	Required	Description
`events`	Array	20	✔️	Configures the event that cause actions in an Outlook Add-in to run automatically. For example, see use smart alerts and the `OnMessageSend` and `OnAppointmentSend` events in your Outlook Add-ins.
`events.type`	String	64 characters	✔️	Specifies the type of event. For supported types, see supported events.
`events.actionId`	String	64 characters	✔️	Identifies the action that is taken when the event fires. The `actionId` must match with `runtime.actions.id`.
`events.options`	Object			Configures how Outlook responds to the event.
`events.options.sendMode`	String		✔️	Specifies the actions to take during a mail send action. Supported values: `promptUser`, `softBlock`, `block`. For more information, see available send mode options.
`requirements`	Object			Specifies the scopes, formFactors, and Office JavaScript Library requirement sets that must be supported on the Office client in order for the event handling code to run. For more information, see Specify Office Add-in requirements in the unified manifest for Microsoft 365.
`requirements.capabilities`	Array			Identifies the requirement sets. Options: `name` (required), `minVersion`, `maxVersion`
`requirements.capabilities.name`	String		✔️	Identifies the name of the requirement set.
`requirements.capabilities.minVersion`	String			Identifies the minimum version for the requirement set.
`requirements.capabilities.maxVersion`	String			Identifies the maximum version for the requirement set.
`requirements.scopes`	Array of enums	1		Identifies the scopes in which the add-in can run and defines the Microsoft 365 applications in which the extension can run. For example, `mail` (Outlook). Supported value: `mail`
`requirements.formFactors`	Array of enums			Identifies the form factors that support the add-in. Supported values: `mobile`, `desktop`

extensions.alternates

Optional – Array

The extensions.alternates property is used to hide or prioritize specific in-market add-ins when you've published multiple add-ins with overlapping functionality.

Name	Type	Maximum size	Required	Description
`prefer`	Object			Specifies the backward compatibility with an equivalent COM add-in, XLL add-in, or both.
`prefer.comAddin`	Object			Specifies a COM add-in that must be used in place of the Microsoft 365 Web Add-in for Windows.
`prefer.comAddin.progId`	String	64 characters	✔️	Identifies the application type in which the extension can run.
`hide`	Object			Configures how to hide another add-in that you've published whenever the add-in is installed, so users don't see both in the Microsoft 365 UI. For example, use this property when you've previously published an add-in that uses the old XML app manifest and you're replacing it with a version that uses the new JSON app manifest.
`hide.storeOfficeAddin`	Object			Specifies a Microsoft 365 Add-in available in Microsoft AppSource.
`hide.storeOfficeAddin.officeAddinId`	String	64 characters	✔️	Specifies the ID of the in-market add-in to hide. The GUID is taken from the app manifest `id` property if the in-market add-in uses the JSON app manifest. The GUID is taken from the `<Id>` element if the in-market add-in uses the XML app manifest.
`hide.storeOfficeAddin.assetId`	String	64 characters	✔️	Specifies the AppSource asset ID of the in-market add-in to hide.
`hide.customOfficeAddin`	Object			Configures how to hide an in-market add-in that isn't distributed through AppSource.
`hide.customOfficeAddin.officeAddinId`	String	64 characters	✔️	Specifies the ID of the in-market add-in to hide. The GUID is taken from the app manifest `id` property if the in-market add-in uses the JSON app manifest. The GUID is taken from the `<Id>` element if the in-market add-in uses the XML app manifest.
`requirements`	Object			Specifies the scopes, formFactors, and Office JavaScript Library requirement sets that must be supported on the Office client in order for the "hide", "prefer", or "alternateIcons" properties to take effect. For more information, see Specify Office Add-in requirements in the unified manifest for Microsoft 365.
`requirements.capabilities`	Array			Identifies the requirement sets. Options: `name` (required), `minVersion`, `maxVersion`
`requirements.capabilities.name`	String		✔️	Identifies the name of the requirement set.
`requirements.capabilities.minVersion`	String			Identifies the minimum version for the requirement set.
`requirements.capabilities.maxVersion`	String			Identifies the maximum version for the requirement set.
`requirements.scopes`	Array of enums	1		Identifies the scopes in which the add-in can run and defines the Microsoft 365 applications in which the extension can run. For example, `mail` (Outlook). Supported value: `mail`
`requirements.formFactors`	Array of enums			Identifies the form factors that support the add-in. Supported values: `mobile`, `desktop`
`alternateIcons`	Object			Specifies the main icons that are used to represent the add-in on older versions of Office. This property is required if the Office add-in is to be installable in Office on Mac, perpetual Office licenses, and Microsoft 365 subscription versions of Office on Windows earlier than 2304 (Build 16320.00000).
`alternateIcons.icon`	Object		✔️	Specifies properties of the image file used to represent the add-in.
`alternateIcons.icon.size`	Number enum		✔️	Specifies the size of the icon in pixels, enumerated as `16`,`20`,`24`,`32`,`40`,`48`,`64`,`80`. Required image sizes: `16`, `32`, `80`.
`alternateIcons.icon.url`	String	2048 characters	✔️	Specifies the full, absolute URL of the image file that is used to represent the add-in. Icon image must be 64 x 64 pixels and use one of the following file formats: GIF, JPG, PNG, EXIF, BMP, TIFF.
`alternateIcons.highResolutionIcon`	Object		✔️	Specifies properties of the image file used to represent the add-in on high DPI screens.
`alternateIcons.highResolutionIcon.size`	Number enum		✔️	Specifies the size of the icon in pixels, enumerated as `16`,`20`,`24`,`32`,`40`,`48`,`64`,`80`. Required image sizes: `16`, `32`, `80`.
`alternateIcons.highResolutionIcon.url`	String	2048 characters	✔️	Specifies the full, absolute URL of the image file that is used to represent the add-in on high DPI screens. Icon image must be 128 x 128 pixels and use one of the following file formats: GIF, JPG, PNG, EXIF, BMP, TIFF.

dashboardCards

Optional – Array

Defines a list of cards that can be pinned to a dashboard, such as Microsoft Viva Connections, to provide a summarized view of app information. To learn more about creating cards for Viva Connections Dashboard, see Overview of Bot Powered Adaptive Card Extensions.

This item is an array of dashboardCard elements of type object.

dashboardCards.dashboardCard

Defines a single dashboard card and its properties.

Name	Type	Maximum size	Required	Description
`id`	String		✔️	A unique identifier for this dashboard card. ID must be a GUID.
`displayName`	String	255 characters	✔️	Display name of the card.
`description`	String	255 characters	✔️	Description of the card.
`pickerGroupId`	String		✔️	ID of the group in the card picker. ID must be a GUID.
`icon`	Object			Specifies icon for the card.
`contentSource`	Object		✔️	Specifies the source of the card's content
`defaultSize`	String		✔️	Rendering size for the dashboard card. Options: `medium` or `large`.

dashboardCards.dashboardCard.icon

Defines the icon properties of a given dashboard card.

Name	Type	Maximum size	Required	Description
`iconUrl`	String	2048 characters		Location of the icon for the card, to be displayed in the toolbox and card bar.
`officeUIFabricIconName`	String	255 characters		Office UI Fabric or Fluent UI icon's friendly name for the card. This value is used if `iconUrl` is not specified.

dashboardCards.dashboardCard.contentSource

Defines the content source of a given dashboard card.

Name	Type	Maximum size	Required	Description
`sourceType`	String			Represents the source of a card's content. Option: `bot`.
`botConfiguration`	Object			The configuration for the bot source. Required if the `sourceType` is set to `bot`.

dashboardCards.dashboardCard.contentSource.botConfiguration

Name	Type	Maximum size	Required	Description
`botId`	String			The unique Microsoft app ID for the bot as registered with the Bot Framework. ID must be a GUID.

Create an app manifest file

If your app doesn't have an app manifest file, you need to create it.

To create an app manifest file:

Use the sample app manifest schema to create a .json file.
Save it in the root of your project folder as manifest.json.

Here's an example of the app manifest schema for a tab app with SSO enabled:

Note

The app manifest example content shown here is only for a tab app. It uses example values for subdomain URI. For more information, see sample app manifest schema.

{ 
"$schema": "https://developer.microsoft.com/json-schemas/teams/v1.11/MicrosoftTeams.schema.json", 
"manifestVersion": "1.12", 
"version": "1.0.0", 
"id": "{new GUID for this Teams app - not the Microsoft Entra App ID}", 
"developer": { 
"name": "Microsoft", 
"websiteUrl": "https://www.microsoft.com", 
"privacyUrl": "https://www.microsoft.com/privacy", 
"termsOfUseUrl": "https://www.microsoft.com/termsofuse" 
}, 

"name": { 
  "short": "Teams Auth SSO", 
  "full": "Teams Auth SSO" 
}, 


"description": { 
  "short": "Teams Auth SSO app", 
  "full": "The Teams Auth SSO app" 
}, 

"icons": { 
  "outline": "outline.png", 
  "color": "color.png" 
}, 

"accentColor": "#60A18E", 
"staticTabs": [ 
  { 
   "entityId": "auth", 
   "name": "Auth", 
   "contentUrl": "https://subdomain.example.com/Home/Index", 
   "scopes": [ "personal" ] 
  } 
], 

"configurableTabs": [ 
  { 
   "configurationUrl": "https://subdomain.example.com/Home/Configure", 
   "canUpdateConfiguration": true, 
   "scopes": [ 
   "team" 
    ] 
  } 
], 
"permissions": [ "identity", "messageTeamMembers" ], 
"validDomains": [ 
 "{subdomain or ngrok url}" 
], 
"webApplicationInfo": { 
  "id": "{Microsoft Entra AppId}", 
  "resource": "api://subdomain.example.com/{Microsoft Entra AppId}" 
}
}

Udostępnij za pośrednictwem

App manifest

Sample app manifest

$schema

manifestVersion

version

ID

developer

name

description

localizationInfo

localizationInfo.additionalLanguages

icons

accentColor

copilotAgents

declarativeAgents

configurableTabs

staticTabs

bots

bots.configuration

bots.commandLists

bots.commandLists.commands

connectors

composeExtensions

composeExtensions.commands

permissions

devicePermissions

validDomains

webApplicationInfo

graphConnector

showLoadingIndicator

isFullScreen

activities

activities.activityTypes

defaultInstallScope

defaultGroupCapability

configurableProperties

supportedChannelTypes

defaultBlockUntilAdminAction

publisherDocsUrl

subscriptionOffer

meetingExtensionDefinition

meetingExtensionDefinition.scenes

authorization

authorization.permissions

authorization.permissions.resourceSpecific

RSC application permissions

RSC delegated permissions

extensions

extensions.requirements

extensions.runtimes

extensions.ribbons

extensions.autoRunEvents

extensions.alternates

dashboardCards

dashboardCards.dashboardCard

dashboardCards.dashboardCard.icon

dashboardCards.dashboardCard.contentSource

dashboardCards.dashboardCard.contentSource.botConfiguration

Create an app manifest file

See also

Dodatkowe zasoby