Edit

teamsApp resource type

  • Article

Namespace: microsoft.graph

Represents 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 apps in catalog teamsApp collection List all the apps in the Microsoft Teams apps catalog.
Upload app to catalog teamsApp Upload an app to your organization's app catalog.
Update app in catalog teamsApp Update an app in your organization's app catalog.
Delete app from catalog None Remove an app from your organization's app catalog.
Get bot associated with app in catalog teamworkbot Get the bot associated with the Teams app.

Properties

Property Type Description
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. Read-only.
externalId string The ID of the catalog provided by the app developer in the Microsoft Teams zip app package.
id string The app ID generated for the catalog is different from the developer-provided ID found within the Microsoft Teams zip app package. The externalId value is empty for apps with a distributionMethod type of store. When apps are published to the global store, the id of the app matches the id in the app manifest.

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

The following JSON representation shows the resource type.

{
  "externalId": "string",
  "displayName": "string",
  "distributionMethod": "string",
  "id": "string"
}

Related content