teamsApp resource type

An app in the Microsoft Teams app catalog.

Users can see these apps in the Microsoft Teams Store, and these apps can be installed in teams using the Add app to team method.

Methods

Method Return Type Description
List published apps teamsApp collection List published apps from the Microsoft Teams apps catalog.
Publish an app teamsApp Publish an app to your organization's app catalog.
Update a published app teamsApp Update a published app in your organization's app catalog.
Remove a published app None Remove a published app from your organization's app catalog.

Properties

Property Type Description
id string The catalog app's generated app ID (different from the developer-provided ID in the Microsoft Teams zip app package.
externalId string The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
displayName string The name of the catalog app provided by the app developer in the Microsoft Teams zip app package.
distributionMethod teamsAppDistributionMethod The method of distribution for the app.

teamsAppDistributionMethod values

Member Value Description
store 0 The app is available to all tenants through the Microsoft Teams app store.
organization 1 The app is available only in this tenant.
sideloaded 2 The app is available only to the user/team its installed to.

Relationships

Relationship Type Description
appDefinitions teamsAppDefinition collection The details for each version of the app.

JSON representation

{
  "id": "string",
  "externalId": "string",
  "displayName": "Test App",
  "distributionMethod": "Organization"
}

See also