---
schema_version: "1"
id: a90f252c5699b372c1047067f01ac3de3641e675cc618bada14ec7bf99a2f30a
title: Microsoft Teams Connector 1.1 Examples
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/microsoft-teams-connector/latest/microsoft-teams-connector-examples.md
canonical_url: https://docs.mulesoft.com/microsoft-teams-connector/latest/microsoft-teams-connector-examples
source_site: docs.mulesoft.com
content_type: documentation
content_hash: ef1ed9ed152fad81340e41a31afd05e85433a9813128fdc78286a68f1d4291ed
description: MuleSoft Documentation Site
release: "1.1"
latest: true
---
---
product: Microsoft Teams Connector
version: 1.1
is-latest-version: true
---

# Microsoft Teams Connector 1.1 Examples

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

These examples show you how to use Microsoft Teams Connector to perform the following actions:

- [Create a new team](#create-new-team)

- [Retrieve team properties and relationships](#retrieve-team)

- [Retrieve a list of team members](#retrieve-members)

- [Retrieve a list of team channels](#retrieve-channel-list)

- [Onboard a new hire to the team](#onboard-new-hire)

- [Delete a team channel](#delete-channel)

- [Remove a team member](#remove-team-member)

## Configure OAuth Authorization

Because this connector uses OAuth to secure connections, you must specify OAuth field values, such
as client credentials, keys, and OAuth-related URLs. To do this:

- Create a configuration file for the OAuth connection

- Configure the OAuth-related global elements

- Configure a global element for the properties file

### Create a Configuration File for the OAuth Connection

Create a configuration file for the OAuth connection that includes properties for the
`Authorization Code` and `Client Credentials` grant types:

1.  Create a file named `mule-app.properties` in the `/src/main/resources/` folder.

2.  In the `mule-app.properties` file, create a set of properties for the `Authorization Code` grant
    type, similar to the ones that follow, replacing the bracketed text (including the brackets)
    with the correct values for your OAuth configuration:

    config.oauth.authorization.code.consumerKey=<consumerKey>
    config.oauth.authorization.code.consumerSecret=<consumerSecret>
    config.oauth.authorization.code.authorizationUrl=<authorizationUrl>
    config.oauth.authorization.code.accessTokenUrl=<accessTokenUrl>

3.  In the `mule-app.properties` file, create a set of properties for the `Client Credentials` grant
    type, similar to the one that follows, replacing the bracketed text (including the brackets)
    with the correct values for your OAuth configuration:

    config.oauth.client.credentials.clientId=<clientId>
    config.oauth.client.credentials.clientSecret=<clientSecret>
    config.oauth.client.credentials.tokenUrl=<tokenUrl>

For more information about creating a properties file, see
[Configuring Property Placeholders](https://docs.mulesoft.com/mule-runtime/latest/mule-app-properties-to-configure).

### Configure the OAuth Global Elements

Configure global elements for the `OAuth_Authorization_Code_Config` and
`OAuth_Client_Credentials_Config` files:

1.  Create a new Mule project.

2.  In the **Mule Palette** view, click **Search in Exchange** and enter `microsoft teams`.

3.  Add **Microsoft Teams Connector** to the **Selected modules** section and click **Finish**.

4.  Click the **Global Elements** tab and click **Create**.

5.  Select **Connector Configuration > Microsoft Teams Authorization Code Config** and click **OK**.

6.  Enter the following values:

    <table><colgroup><col> <col> <col></colgroup><thead><tr><th>Field</th><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p><code>OAuth_Authorization_Code_Config</code></p></td><td><p>Name of the configuration.</p></td></tr><tr><td><p>Consumer key</p></td><td><p><code>${config.oauth.authorization.code.consumerKey}</code></p></td><td><p>OAuth consumer key, as registered with the service provider.</p></td></tr><tr><td><p>Consumer secret</p></td><td><p><code>${config.oauth.authorization.code.consumerSecret}</code></p></td><td><p>OAuth consumer secret, as registered with the service provider.</p></td></tr><tr><td><p>Authorization url</p></td><td><p><code>${config.oauth.authorization.code.authorizationUrl}</code></p></td><td><p>URL of the service provider’s authorization endpoint.</p></td></tr><tr><td><p>Access token url</p></td><td><p><code>${config.oauth.authorization.code.accessTokenUrl}</code></p></td><td><p>URL of the service provider’s access token endpoint.</p></td></tr><tr><td><p>Scopes</p></td><td><p>Leave the default: <code>https://graph.microsoft.com/.default</code></p></td><td><p>OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.</p></td></tr><tr><td><p>Listener config</p></td><td><p><code>auth</code></p></td><td><p>Configuration for the HTTP Listener that listens for requests on the access token callback endpoint.</p></td></tr><tr><td><p>Callback path</p></td><td><p><code>/callback</code></p></td><td><p>Path of the access token callback endpoint.</p></td></tr><tr><td><p>Authorize path</p></td><td><p><code>authorizePath</code></p></td><td><p>Path of the local HTTP endpoint that triggers the OAuth dance.</p></td></tr><tr><td><p>External callback url</p></td><td><p><code>http://localhost:8083/callback</code></p></td><td><p>URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.</p></td></tr></tbody></table>

7.  Click **OK**.

8.  Click the **Global Elements** tab and click **Create**.

9.  Select **Connector Configuration > Microsoft Teams Client Credentials Config** and click **OK**.

10. Enter the following values:

    <table><colgroup><col> <col> <col></colgroup><thead><tr><th>Field</th><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p><code>Microsoft_Teams_Client_Credentials_Config</code></p></td><td><p>Name of the configuration.</p></td></tr><tr><td><p>Client id</p></td><td><p><code>${config.oauth.client.credentials.clientId}</code></p></td><td><p>OAuth client ID, as registered with the service provider.</p></td></tr><tr><td><p>Client secret</p></td><td><p><code>${config.oauth.client.credentials.clientSecret}</code></p></td><td><p>OAuth client secret, as registered with the service provider.</p></td></tr><tr><td><p>Token url</p></td><td><p><code>${config.oauth.client.credentials.tokenUrl}</code></p></td><td><p>URL of the service provider’s token endpoint.</p></td></tr><tr><td><p>Scopes</p></td><td><p>Leave the default: <code>https://graph.microsoft.com/.default</code></p></td><td><p>OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.</p></td></tr></tbody></table>

11. Click **OK**.

### Configure a Global Element for the Properties File

Configure a global element for the `mule-app.properties` file so that Mule knows where to find it:

1.  Click the **Global Elements** tab and click **Create**.

2.  In the **Choose Global Type** dialog, select **Configuration properties** and click **OK**.

3.  In the **File** field, enter `mule.app.properties`.

4.  Click **OK**.

## Create a New Team

The following screenshot shows the Studio app flow for creating a new team:

![Create a new team flow](/mulesoft/current/en-us/microsoft-teams-connector/latest/_images/ms-teams-create-team.png)

Figure 1. Use a flow like this one to create a new team.

Creating a new team involves configuring an HTTP **Listener** component, a **Transform Message**
component, a **Create Team** operation, and a second **Transform Message** component.

To create the flow:

1.  Create a new Mule project in Studio.

2.  In the Mule Palette view, search for **HTTP** and select the **Listener** operation.

3.  Drag the **Listener** operation onto the canvas.

4.  In the **Listener** configuration, click **+** next to the **Connector configuration** field to
    add a global element.

5.  Accept the defaults.

6.  In the HTTP properties window, set the **Path** field to `/createTeam`.

### Add the First Transform Message Component

The first **Transform Message** component creates a template for the input used to create the team:

1.  In the Mule Palette view, search for **transform message**.

2.  Drag the **Transform Message** component onto the canvas, to the right of the **Listener**
    component.

3.  In the **Transform Message** configuration, overlay the brackets in the **Output** section with
    this XML:

    ```dataweave
    {
    	"template@odata.bind": "https://graph.microsoft.com/v1.0/teamsTemplates('standard')",
    	description: message.attributes.queryParams.description,
    	displayName: message.attributes.queryParams.displayName,
    	"members":[
          {
            "@odata.type":"#microsoft.graph.aadUserConversationMember",
            "user@odata.bind":"https://graph.microsoft.com/v1.0/users('" ++ message.attributes.queryParams.user as String ++ "')",
             "roles":[
                "owner"
             ]
          }
    }
    ```

### Add the Create Team Operation

The **Create team** operation creates a new team based on user input:

1.  Drag the **Create team** operation onto the canvas, to the right of the **Transform Message**
    component.

2.  In the Create team configuration, click the **Connector configuration** dropdown and select
    **Microsoft-Teams-Client-Config**.

3.  Select **Microsoft\_Teams\_Client\_Credentials\_Config** as the global element type and click
    **OK**.

4.  Configure the following fields in the Create team properties window:

    <table><colgroup><col> <col></colgroup><thead><tr><th>Field</th><th>Value</th></tr></thead><tbody><tr><td><p>Display Name</p></td><td><p><code>Create team</code></p></td></tr><tr><td><p>Connector Configuration</p></td><td><p><code>OAuth_Client_Credentials_Config</code></p></td></tr><tr><td><p>Message</p></td><td><p><code>payload</code></p></td></tr></tbody></table>

### Add the Second Transform Message Component

This **Transform Message** component converts the output of the **Create team** operation to JSON
format.

1.  In the Mule **Palette** view, search for `transform message`:

2.  Drag the **Transform Message** component onto the canvas, to the right of the **Listener**
    component.

3.  Click the **Transform Message** component and set the output to `application/json`:

    ```dataweave
    %dw 2.0
    output application/json
    ```

## Retrieve the Team Properties and Relationships

Create a second flow to retrieve the properties and relationships for the new team. Use the **Get
Team** operation in this flow:

![Retrieve the team flow](/mulesoft/current/en-us/microsoft-teams-connector/latest/_images/ms-teams-get-team.png)

Figure 2. Use a flow like this one to retrieve the new team’s properties and relationships.

## Retrieve the Team Members

Create a third flow to retrieve information about the members of the new team. Use the **List team
members** operation in this flow:

![Retrieve the team members flow](/mulesoft/current/en-us/microsoft-teams-connector/latest/_images/ms-teams-get-members.png)

Figure 3. Use a flow like this one to retrieve information about team members.

## Retrieve the Team Channels

Create a fourth flow to retrieve information about the channels used by the team. Use the **List
channels** operation in this flow:

![Retrieve the team channels flow](/mulesoft/current/en-us/microsoft-teams-connector/latest/_images/ms-teams-list-channels.png)

Figure 4. Use a flow like this one to retrieve the channels used by the new team.

## Onboard a New Hire to the Team

Create a fifth flow to onboard a new hire to the team. Use the following operations in this flow:

- **Add team member** to add a new member to the team

- **Create channel** to create a new channel

- **Add channel member** to add the new member to the newly created channel

- **Create message** to create the welcome message

![Onboarding a new hire flow](/mulesoft/current/en-us/microsoft-teams-connector/latest/_images/ms-teams-onboarding.png)

Figure 5. Use a flow like this one to onboard a new user.

## Delete a Team Channel

Create a sixth flow to delete a channel. Use the **Delete channel** operation in this flow.

![Delete a channel flow](/mulesoft/current/en-us/microsoft-teams-connector/latest/_images/ms-teams-delete-channel.png)

Figure 6. Use a flow like this one to delete a channel.

## Remove a Team Member

Create a seventh flow to remove a member from a team. Use the **Remove team member** operation in
this flow.

![Remove a team member flow](/mulesoft/current/en-us/microsoft-teams-connector/latest/_images/ms-teams-remove-member.png)

Figure 7. Use a flow like this one to remove a team member.

## Run the App

To run the app:

1.  Right-click the project in Package Explorer and select **Run As > Mule Application**.

2.  After the app deploys, open a web browser.

3.  Enter the following URL to start the OAuth dance: `http://localhost:8081/authorize`.

4.  In the login screen, enter the login information used to access Microsoft Teams and click
    **Login**.

5.  Click **Allow**.

6.  Initiate a flow by entering the associated URL, as shown in the following table. If the URL has
    query parameters, ensure that you include the parameter values:

    <table><colgroup><col> <col> <col></colgroup><thead><tr><th>Flow</th><th>URL</th><th>Notes</th></tr></thead><tbody><tr><td><p>Create a new team</p></td><td><p><code>http://localhost:8081/createTeam?displayName={teamDisplayName}&amp;description={teamDescription}&amp;user={teamOwnerUser}</code></p></td><td></td></tr><tr><td><p>Retrieve the team properties and relationships</p></td><td><p><code>http://localhost:8081/getTeam?team={createdTeamId}</code></p></td><td></td></tr><tr><td><p>Retrieve the team channels</p></td><td><p><code>http://localhost:8081/listChannels</code></p></td><td><p>Returns only the default channel because this example does not create channels.</p></td></tr><tr><td><p>Onboard a new hire to the team</p></td><td><p><code>http://localhost:8081/newHireFlow?channelName={channelName}&amp;team={createdTeamId}&amp;userToOnboard={userToBeOnboarded}&amp;channelOwner={channelOwner}</code></p></td><td><div><div><p>For the <code>userToOnboard</code> query parameter, specify a user who is not the channel owner. The JSON response contains the following welcome message:</p></div><div><p><code>"content": "Welcome to the team {channelName}"</code></p></div></div></td></tr><tr><td><p>Delete a team channel</p></td><td><p><code>http://localhost:8081/deleteChannel?team={teamId}&amp;channel={channelId}</code></p></td><td></td></tr><tr><td><p>Remove a team member</p></td><td><p><code>http://localhost:8081/removeTeamMembers?team={teamId}&amp;member={membershipId}</code></p></td><td></td></tr></tbody></table>

## XML for the Examples

Paste this XML code into the **Configuration XML** tab in your project to experiment with the flows
described in the previous sections. When you paste this code, click **Yes** on the **Regenerate
'doc:id' Values** dialog.

```xml
<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:ee="http://www.mulesoft.org/schema/mule/ee/core" xmlns:http="http://www.mulesoft.org/schema/mule/http"
	xmlns:microsoftTeams="http://www.mulesoft.org/schema/mule/microsoftTeams"
	xmlns="http://www.mulesoft.org/schema/mule/core" xmlns:doc="http://www.mulesoft.org/schema/mule/documentation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/microsoftTeams http://www.mulesoft.org/schema/mule/microsoftTeams/current/mule-microsoftTeams.xsd
http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/ee/core http://www.mulesoft.org/schema/mule/ee/core/current/mule-ee.xsd">
	<configuration-properties file="mule-app.properties"/>
	<microsoftTeams:client-credentials-config name="OAuth_Client_Credentials_Config" doc:name="Microsoft Teams Client Credentials Config">
		<microsoftTeams:oauth-client-credentials-connection >
			<microsoftTeams:oauth-client-credentials clientId="${config.oauth.client.credentials.clientId}" clientSecret="${config.oauth.client.credentials.clientSecret}" tokenUrl="${config.oauth.client.credentials.tokenUrl}" scopes="https://graph.microsoft.com/.default" />
		</microsoftTeams:oauth-client-credentials-connection>
	</microsoftTeams:client-credentials-config>
	<http:listener-config name="HTTP_Listener_config" doc:name="HTTP Listener config">
		<http:listener-connection host="0.0.0.0" port="8081" />
	</http:listener-config>
	<http:listener-config name="auth" doc:name="HTTP Listener config" >
		<http:listener-connection host="0.0.0.0" port="8083" />
	</http:listener-config>
	<microsoftTeams:authorization-code-config name="OAuth_Authorization_Code_Config" doc:name="Microsoft Teams Authorization Code Config" >
		<microsoftTeams:oauth-authorization-code-connection >
			<microsoftTeams:oauth-authorization-code consumerKey="${config.oauth.authorization.code.consumerKey}" consumerSecret="${config.oauth.authorization.code.consumerSecret}" authorizationUrl="${config.oauth.authorization.code.authorizationUrl}" accessTokenUrl="${config.oauth.authorization.code.accessTokenUrl}" scopes="https://graph.microsoft.com/.default" />
			<microsoftTeams:oauth-callback-config listenerConfig="auth" callbackPath="/callback" authorizePath="/authorize" externalCallbackUrl="http://localhost:8083/callback" />
		</microsoftTeams:oauth-authorization-code-connection>
	</microsoftTeams:authorization-code-config>
	<flow name="1.CREATE-TEAM" >
		<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="/createTeam"/>
		<ee:transform doc:name="Transform Message">
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
{
	"template@odata.bind": "https://graph.microsoft.com/v1.0/teamsTemplates('standard')",
	description: message.attributes.queryParams.description,
	displayName: message.attributes.queryParams.displayName,
	"members":[
      {
        "@odata.type":"#microsoft.graph.aadUserConversationMember",
        "user@odata.bind":"https://graph.microsoft.com/v1.0/users('" ++ message.attributes.queryParams.user as String ++ "')",
         "roles":[
            "owner"
         ]
      }
   ]
}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<microsoftTeams:create-team doc:name="Create team" config-ref="OAuth_Client_Credentials_Config"/>
		<ee:transform doc:name="Transform Message">
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload]]></ee:set-payload>
			</ee:message>
		</ee:transform>
	</flow>
	<flow name="2.GET-CREATED-TEAM">
		<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="/getTeam" />
		<microsoftTeams:get-team doc:name="Get team" teamId="#[message.attributes.queryParams.team]" select="#[message.attributes.queryParams.select]" config-ref="OAuth_Client_Credentials_Config">
			<microsoftTeams:advanced-query-params >
			</microsoftTeams:advanced-query-params>
		</microsoftTeams:get-team>
		<ee:transform doc:name="Transform Message">
			<ee:message>
				<ee:set-payload><![CDATA[%dw 2.0
output application/json
---
payload]]></ee:set-payload>
			</ee:message>
		</ee:transform>
	</flow>
	<flow name="3.LIST-TEAM-MEMBERS-FROM-THE-NEW-TEAM">
		<http:listener doc:name="Listener" path="/listTeamMembers" config-ref="HTTP_Listener_config"/>
		<microsoftTeams:list-team-members doc:name="List team members" teamId="#[message.attributes.queryParams.team]" config-ref="OAuth_Client_Credentials_Config"/>
		<ee:transform doc:name="Transform Message">
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload]]></ee:set-payload>
			</ee:message>
		</ee:transform>
	</flow>
	<flow name="4.LIST-EXISTING-CHANNELS-FROM-THE-NEW-TEAM">
		<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="/listChannels"/>
		<microsoftTeams:list-channels doc:name="List channels" doc:id="e260eb05-4be8-4da9-9cfa-e220ecb4a49a" teamId="#[message.attributes.queryParams.team]" config-ref="OAuth_Client_Credentials_Config">
			<microsoftTeams:advanced-query-params >
			</microsoftTeams:advanced-query-params>
		</microsoftTeams:list-channels>
		<ee:transform doc:name="Transform Message">
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
message]]></ee:set-payload>
			</ee:message>
		</ee:transform>
	</flow>
	<flow name="5.NEW-HIRE-TEAM-ONBOARDING">
		<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="/newHireFlow"/>
		<set-variable value="#[message.attributes.queryParams.channelOwner]" doc:name="Set Variable" variableName="channelOwner"/>
		<set-variable value="#[message.attributes.queryParams.channelName]" doc:name="Set Variable" variableName="name"/>
		<set-variable value="#[message.attributes.queryParams.userToOnboard]" doc:name="Set Variable" variableName="userToOnboard"/>
		<set-variable value="#[message.attributes.queryParams.team]" doc:name="Set Variable" variableName="team"/>
		<microsoftTeams:add-team-member doc:name="Add team member" teamId="#[vars.team]" userId="#[vars.userToOnboard]" config-ref="OAuth_Client_Credentials_Config"/>
		<ee:transform doc:name="Transform Message" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/java
---
{
	description: "This channel will be used to onboard new hire " ++ vars.name as String,
	displayName: "Welcome " ++ vars.name as String ++ uuid()[0 to 5],
	membershipType: "private",
	"members":
     [
        {
           "@odata.type":"#microsoft.graph.aadUserConversationMember",
           "user@odata.bind":"https://graph.microsoft.com/v1.0/users('" ++ vars.channelOwner as String ++ "')",
           "roles":["owner"]
        }
     ]
}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<microsoftTeams:create-channel doc:name="Create channel" teamId="#[vars.team]" config-ref="OAuth_Client_Credentials_Config"/>
		<set-variable value="#[payload.id]" doc:name="Set Variable" variableName="channel"/>
		<microsoftTeams:add-channel-member doc:name="Add channel member" channelId="#[vars.channel]" teamId="#[vars.team]" userId="#[vars.userToOnboard]" owner="true" config-ref="OAuth_Client_Credentials_Config"/>
		<ee:transform doc:name="Transform Message" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
{
	body: {
		content: "Welcome to the team " ++ vars.name as String
	}
}]]></ee:set-payload>
			</ee:message>
		</ee:transform>
		<microsoftTeams:create-message doc:name="Create message" config-ref="OAuth_Authorization_Code_Config" teamId="#[vars.team]" channelId="#[vars.channel]"/>
		<ee:transform doc:name="Transform Message" >
			<ee:message >
				<ee:set-payload ><![CDATA[%dw 2.0
output application/json
---
payload]]></ee:set-payload>
			</ee:message>
		</ee:transform>
	</flow>
	<flow name="6.DELETE-CHANNEL-FROM-TEAM">
		<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="/deleteChannel" />
		<microsoftTeams:delete-channel doc:name="Delete channel" teamId="#[message.attributes.queryParams.team]" channelId="#[message.attributes.queryParams.channel]" config-ref="OAuth_Client_Credentials_Config"/>
	</flow>
	<flow name="7.REMOVE-TEAM-MEMBER">
		<http:listener doc:name="Listener" config-ref="HTTP_Listener_config" path="/removeTeamMember" />
		<microsoftTeams:remove-team-member doc:name="Remove team member" teamId="#[message.attributes.queryParams.team]" membershipId="#[message.attributes.queryParams.member]" config-ref="OAuth_Client_Credentials_Config"/>
	</flow>
</mule>
```