Table of contents

Microsoft Teams (preview) tab manifest schema reference

Richard Taylor|Last Updated: 2/7/2017
|
1 Contributor

Your manifest must conform to the schema hosted at: https://statics.teams.microsoft.com/sdk/v0.4/manifest/MicrosoftTeams.schema.json .

Tip Specify the schema at the beginning of your manifest to enable IntelliSense or similar support from your code editor:

"$schema": "https://statics.teams.microsoft.com/sdk/v0.4/manifest/MicrosoftTeams.schema.json",

The schema defines the following properties:

manifestVersion (string, required)

The version of the manifest schema this manifest is using.

version (string, required)

The app version. Changes to the app should cause a version change. This version string must follow the semver standard.

id (string)

A unique identifier for this app. The id must use reverse domain name notation.

developer (object, required)

Properties of the developer object:

name (string, required)

The display name for the developer.

websiteUrl (string, required)

The url to the developer's website.

privacyUrl (string, required)

The url to the developer's privacy policy.

termsOfUseUrl (string, required)

The url to the developer's terms of use.

tabs (array)

The object is an array with all elements of the type object.

The array object has the following properties:

id (string, required)

A unique identifier for this extension. The id must use reverse domain name notation.

name (string, required)

The display name of the extension.

description (object, required)

Properties of the description object:

short (string, required)

A short description of the extension used when space is limited. Maximum length is 80 characters.

full (string, required)

The full description of the extension. Maximum length is 256 characters.

icons (object, required)

Each icon image file must be a transparent PNG, with a white or light-colored background.

Properties of the icons object:

44 (string, required)

An icon for the extension sized to 44x44.

88 (string, required)

An icon for the extension sized to 88x88.

accentColor (string, required)

A color to use in conjunction with the extension's icons. The value must be a valid HTML color code starting with '#', for example #4464ee.

configUrl (string, required)

The url to use when configuring the extension.

canUpdateConfig (boolean)

A value indicating whether an instance of the extension's config can be updated by the user after creation.

Default: true

bots (array)

This field is reserved for future use

needsIdentity (boolean)

A value indicating whether the extension is requesting access to identity information

validDomains (array)

A list of valid domains from which the extension expects to load any content. Domain listings can include wildcards, for example *.example.com. If your tab configuration or content UI needs to navigate to any other domain besides the one use for tab configuration, that domain must be specified here.

The object is an array with all elements of the type string.

© 2017 Microsoft