TeamTemplates.Read | Graph Permissions

Permission Details

Delegated Permission

Read available Teams templates

Allows the app to read the available Teams templates, on behalf of the signed-in user.

Permission ID: cd87405c-5792-4f15-92f7-debc0db6d1d6

Properties

Microsoft Graph v1.0 endpoint-derived-docs

Properties is shown from stable Microsoft Graph v1.0 metadata.

Property	Type	Description
`id`	`string`	The default teamwork identifier.
`isTeamsEnabled`	`Boolean`	Indicates whether Microsoft Teams is enabled for the organization.
`region`	`string`Nullable	Represents the region of the organization or the tenant. The region value can be any region supported by the Teams payload. The possible values are: Americas, Europe and MiddleEast, Asia Pacific, UAE, Australia, Brazil, Canada, Switzerland, Germany, France, India, Japan, South Korea, Norway, Singapore, United Kingdom, South Africa, Sweden, Qatar, Poland, Italy, Israel, Spain, Mexico, USGov Community Cloud, USGov Community Cloud High, USGov Department of Defense, and China.
`deletedChats`	`deletedChat collection`	A collection of deleted chats.
`deletedTeams`	`deletedTeam collection`	The deleted team.
`teamsAppSettings`	`object`	Represents tenant-wide settings for all Teams apps in the tenant.
`workforceIntegrations`	`workforceIntegration collection`

JSON Representation

Microsoft Graph v1.0 endpoint-derived-docs

JSON representation is shown from stable Microsoft Graph v1.0 metadata.

JSON representation

{
  "@odata.type": "#microsoft.graph.teamwork",
  "id": "String",
  "isTeamsEnabled": "boolean",
  "region": "String"
}

Relationships

Microsoft Graph v1.0 endpoint-derived-docs

Relationships is shown from stable Microsoft Graph v1.0 metadata.

Relationship	Type	Description
`deletedTeams`	`deletedTeam collection`	The deleted team.
`deletedChats`	`deletedChat collection`	A collection of deleted chats.
`teamsAppSettings`	`teamsAppSettings`	Represents tenant-wide settings for all Teams apps in the tenant.
`workforceIntegrations`	`workforceIntegration collection`	Related workforceIntegrations data exposed by this resource.
`devices`	`teamworkDevice collection`	The Teams devices provisioned for the tenant.
`teamTemplates`	`teamTemplate collection`	The templates associated with a team.

Graph Methods

Delegated access App-only access

Exact Microsoft Learn match

Microsoft Graph v1.0 endpoints are mapped directly from refreshed Microsoft Learn permissions tables.

No API methods available for this version.

Exact Microsoft Learn match

Microsoft Graph beta endpoints are mapped directly from refreshed Microsoft Learn permissions tables.

Methods
GET `/teamwork/teamTemplates`
GET `/teamwork/teamTemplates?$expand=definitions`
GET `/teamwork/teamTemplates/{teamTemplateId}/definitions/{teamTemplateDefinitionID}`
GET `/teamwork/teamTemplates/{teamTemplateId}/definitions/{teamTemplateDefinitionId}/teamDefinition`

Exact Microsoft Learn PowerShell match

Microsoft Graph PowerShell v1.0 commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.

No deterministic PowerShell command map is available for this permission.

Browse PowerShell docs

Exact Microsoft Learn PowerShell match

Microsoft Graph PowerShell beta commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.

Commands
`Get-MgBetaTeamworkTeamTemplate` /teamwork/teamTemplates List teamTemplates
`Get-MgBetaTeamworkTeamTemplate` /teamwork/teamTemplates?$expand=definitions List definitions
`Get-MgBetaTeamworkTeamTemplateDefinition` /teamwork/teamTemplates/{teamTemplateId}/definitions/{teamTemplateDefinitionID} Get teamTemplateDefinition

Code Examples

C# / .NET SDK

Get teamDefinition

View official example on Microsoft Learn

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Teamwork.TeamTemplates["{teamTemplate-id}"].Definitions["{teamTemplateDefinition-id}"].TeamDefinition.GetAsync();

JavaScript

Get teamDefinition

View official example on Microsoft Learn

const options = {
	authProvider,
};

const client = Client.init(options);

let team = await client.api('/teamwork/teamTemplates/com.microsoft.teams.template.ManageAProject/definitions/Y29tLm1pY3Jvc29mdC50ZWFtcy50ZW1wbGF0ZS5NYW5hZ2VBUHJvamVjdCMjUHVibGljIyNlbi1VUw==/teamDefinition')
	.version('beta')
	.get();

PowerShell

Get teamTemplateDefinition

View official example on Microsoft Learn

Import-Module Microsoft.Graph.Beta.Teams

Get-MgBetaTeamworkTeamTemplateDefinition -TeamTemplateId $teamTemplateId -TeamTemplateDefinitionId $teamTemplateDefinitionId

Python

Get teamDefinition

View official example on Microsoft Learn

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.teamwork.team_templates.by_team_template_id('teamTemplate-id').definitions.by_team_template_definition_id('teamTemplateDefinition-id').team_definition.get()

App Registration

1

Navigate to Azure Portal

Go to App registrations in Microsoft Entra admin center

2

Add API Permission

Select your app → API permissions → Add a permission → Microsoft Graph

3

Select Permission Type

Choose Delegated permissions and search for TeamTemplates.Read

4

Grant Admin Consent

Users can consent to this permission during sign-in.