# mulesoft Microsoft Teams Connector - Full Documentation --- product: Microsoft Teams Connector version: 1.1 is-latest-version: true --- # Microsoft Teams Connector 1.1 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Microsoft Teams (Microsoft Teams Connector) gives you access to the Microsoft Teams APIs. This connector exposes the most commonly used operations provided by the Microsoft Teams APIs. For compatibility information and fixed issues, see the Microsoft Teams Connector Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The Microsoft Teams APIs - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - Creating a Mule app using Anypoint Studio or Anypoint Code Builder Before creating an app, you must have: - Credentials to access the target resource - Anypoint Studio or Anypoint Code Builder ## Common Use Cases for the Connector - Send notifications Users are notified in Microsoft Teams when a new resource is created or modified in another service, for example, when a new Salesforce case is created. - Onboard employees When a group of people are hired at the same time, and human resources has an email in Gmail or a spreadsheet in Google Sheets that contains information about the new hires, HR can use the email or spreadsheet to trigger different actions: - Add users to a workspace - Create a channel for all new hires and use it to instantly share important onboarding information with them - Archive the new hire channel after onboarding is completed After the onboarding process is completed, resources can be freed or reused for the next onboarding process. - Create new teams for business projects Create teams for new business projects to streamline and automate the management of team members, for example: - After a new team is created for a new business project, the client can quickly and automatically integrate this new team by using Microsoft Teams. - After teams are created, as each new employee is hired, the client can automatically execute a series of actions to integrate the new hire by using Microsoft Teams. - When a team member is either removed or moved to another team, the client can execute a series of automated steps to reflect this change within Microsoft Teams. - When the business project ends, the resources allocated for that business project in Microsoft Teams can be reused or removed. - If a manager is hired or replaced, the corresponding group owner of the team can be changed. ## Authentication Types Microsoft Teams Connector connections use the following OAuth 2.0 grant types: - OAuth 2.0 authorization code grant type, which uses an access token from the Microsoft identity platform for authentication - OAuth 2.0 client credentials grant type, which uses the identity of the application to access web-hosted resources ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Microsoft Teams Reference](https://docs.mulesoft.com/microsoft-teams-connector/latest/microsoft-teams-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- 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= config.oauth.authorization.code.consumerSecret= config.oauth.authorization.code.authorizationUrl= config.oauth.authorization.code.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= config.oauth.client.credentials.clientSecret= config.oauth.client.credentials.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:
FieldValueDescription

Name

OAuth_Authorization_Code_Config

Name of the configuration.

Consumer key

${config.oauth.authorization.code.consumerKey}

OAuth consumer key, as registered with the service provider.

Consumer secret

${config.oauth.authorization.code.consumerSecret}

OAuth consumer secret, as registered with the service provider.

Authorization url

${config.oauth.authorization.code.authorizationUrl}

URL of the service provider’s authorization endpoint.

Access token url

${config.oauth.authorization.code.accessTokenUrl}

URL of the service provider’s access token endpoint.

Scopes

Leave the default: https://graph.microsoft.com/.default

OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.

Listener config

auth

Configuration for the HTTP Listener that listens for requests on the access token callback endpoint.

Callback path

/callback

Path of the access token callback endpoint.

Authorize path

authorizePath

Path of the local HTTP endpoint that triggers the OAuth dance.

External callback url

http://localhost:8083/callback

URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.

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:
FieldValueDescription

Name

Microsoft_Teams_Client_Credentials_Config

Name of the configuration.

Client id

${config.oauth.client.credentials.clientId}

OAuth client ID, as registered with the service provider.

Client secret

${config.oauth.client.credentials.clientSecret}

OAuth client secret, as registered with the service provider.

Token url

${config.oauth.client.credentials.tokenUrl}

URL of the service provider’s token endpoint.

Scopes

Leave the default: https://graph.microsoft.com/.default

OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.

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:
FieldValue

Display Name

Create team

Connector Configuration

OAuth_Client_Credentials_Config

Message

payload

### 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:
FlowURLNotes

Create a new team

http://localhost:8081/createTeam?displayName={teamDisplayName}&description={teamDescription}&user={teamOwnerUser}

Retrieve the team properties and relationships

http://localhost:8081/getTeam?team={createdTeamId}

Retrieve the team channels

http://localhost:8081/listChannels

Returns only the default channel because this example does not create channels.

Onboard a new hire to the team

http://localhost:8081/newHireFlow?channelName={channelName}&team={createdTeamId}&userToOnboard={userToBeOnboarded}&channelOwner={channelOwner}

For the userToOnboard query parameter, specify a user who is not the channel owner. The JSON response contains the following welcome message:

"content": "Welcome to the team {channelName}"

Delete a team channel

http://localhost:8081/deleteChannel?team={teamId}&channel={channelId}

Remove a team member

http://localhost:8081/removeTeamMembers?team={teamId}&member={membershipId}

## 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 ``` --- product: Microsoft Teams Connector version: 1.1 is-latest-version: true --- # Microsoft Teams Connector 1.1 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Microsoft Teams (Microsoft Teams Connector) gives you access to the Microsoft Teams APIs. ## Configurations ### Authorization Code Config
NameTypeDescriptionDefault ValueRequired

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types that can be provided to this configuration.

x

Name

String

The identifier of this element used to reference it in other components

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Read Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer will wait for a response before it times out.

60

Read Timeout Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The time unit value used by the Read Timeout parameter.

SECONDS

### Connection Types ### OAuth 2.0 Authorization Code Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth).
NameTypeDescriptionDefault ValueRequired

Proxy configuration

Proxy configuration for the connector.

Response Type

String

Specifies the method to use to send the resulting token back to your app. It must be query.

query

TLS configuration (DEPRECATED)

Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the keystore in the tls:context child element of the listener-config.

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Consumer Key

String

OAuth consumerKey as registered with the service provider

x

Consumer Secret

String

OAuth consumerSecret as registered with the service provider

x

Authorization Url

String

The service provider’s authorization endpoint URL

https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize

Access Token Url

String

The service provider’s accessToken endpoint URL

https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token

Scopes

String

The OAuth scopes to request during the OAuth dance. If not provided, this value defaults to those in the annotation.

Resource Owner Id

String

The resourceOwnerId that each component should use if it is not otherwise referenced.

Before

String

Name of a flow to execute immediately before starting the OAuth dance.

After

String

Name of a flow to execute immediately after an accessToken is received.

Listener Config

String

A reference to a <http:listener-config /> to use to create the listener that receives the access token callback endpoint.

x

Callback Path

String

Path of the access token callback endpoint.

x

Authorize Path

String

Path of the local HTTP endpoint that triggers the OAuth dance.

x

External Callback Url

String

If the callback endpoint is behind a proxy or must be accessed through a non direct URL, use this parameter to tell the OAuth provider the URL to use to access the callback.

Object Store

String

A reference to the object store to use to store each resource owner ID’s data. If not specified, Mule automatically provisions the default object store.

#### Associated Operations - [Add Channel Member](#AddChannelMember) - [Add Group Members](#AddGroupMembers) - [Add Team Member](#AddTeamMember) - [Create Channel](#CreateChannel) - [Create Message](#CreateMessage) - [Create Team](#CreateTeam) - [Delete Channel](#DeleteChannel) - [Delete Team](#DeleteTeam) - [Get Channel](#GetChannel) - [Get Team](#GetTeam) - [List Channel Members](#ListChannelMembers) - [List Channels](#ListChannels) - [List Group Members](#ListGroupMembers) - [List Team Members](#ListTeamMembers) - [Remove Channel Member](#RemoveChannelMember) - [Remove Group Member](#RemoveGroupMember) - [Remove Team Member](#RemoveTeamMember) - [Unauthorize](#Unauthorize) - [Update Channel](#UpdateChannel) - [Update Team](#UpdateTeam) ### Client Credentials Config #### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The supported connection types for this configuration.

x

Name

String

The identifier of this element that other components use to reference it.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Read Timeout

Number

Specifies the amount of time, in milliseconds, that the consumer waits for a response before it times out.

60

Read Timeout Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The time unit value used by the Read Timeout parameter.

SECONDS

### Connection Types ### OAuth 2.0 Client Credentials Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). #### Parameters
NameTypeDescriptionDefault ValueRequired

Proxy configuration

Proxy configuration for the connector.

TLS configuration (DEPRECATED)

Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol, then, at a minimum, the user must configure the keystore in the tls:context child element of the listener-config.

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Client Id

String

OAuth client ID as registered with the service provider.

x

Client Secret

String

OAuth client secret as registered with the service provider.

x

Token Url

String

The service provider’s token endpoint URL.

https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token

Scopes

String

OAuth scopes to request during the OAuth dance. If not provided, the value defaults to those in the annotation.

Object Store

String

A reference to the object store to use to store each resource owner ID’s data. If not specified, Mule automatically provisions the default object store.

#### Associated Operations - [Add Channel Member](#AddChannelMember) - [Add Group Members](#AddGroupMembers) - [Add Team Member](#AddTeamMember) - [Create Channel](#CreateChannel) - [Create Team](#CreateTeam) - [Delete Channel](#DeleteChannel) - [Delete Team](#DeleteTeam) - [Get Channel](#GetChannel) - [Get Team](#GetTeam) - [List Channel Members](#ListChannelMembers) - [List Channels](#ListChannels) - [List Group Members](#ListGroupMembers) - [List Team Members](#ListTeamMembers) - [Remove Channel Member](#RemoveChannelMember) - [Remove Group Member](#RemoveGroupMember) - [Remove Team Member](#RemoveTeamMember) - [Unauthorize](#Unauthorize) - [Update Channel](#UpdateChannel) - [Update Team](#UpdateTeam) ## Operations ## Add Channel Member `` The following table shows the required permissions for this operation:
Permission TypePermissions (from least privileged to most privileged)

Delegated (work or school account)

ChannelMember.ReadWrite.All

Delegated (personal Microsoft account)

Not supported.

Application

ChannelMember.ReadWrite.All

### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Team Id

String

Team Id that has a channel with the Id specified in Channel Id parameter

x

Channel Id

String

The channel id where the user should be added

x

User Id

String

Corresponding user id to be added as member

x

Owner

Boolean

True if this user should be the owner of the channel.

false

Read Timeout

Number

Read timeout value.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The time unit value used by the Read Timeout parameter.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Binary

Attributes Type

Binary

### For Configurations - [Authorization Code Config](#AuthorizationCodeConfig) - [Client Credentials Config](#ClientCredentialsConfig) ### Throws - MICROSOFTTEAMS:BAD\_REQUEST - MICROSOFTTEAMS:CONNECTIVITY - MICROSOFTTEAMS:FORBIDDEN - MICROSOFTTEAMS:INVALID\_CONNECTION - MICROSOFTTEAMS:INVALID\_CREDENTIALS - MICROSOFTTEAMS:NOT\_FOUND - MICROSOFTTEAMS:RETRY\_EXHAUSTED - MICROSOFTTEAMS:SERVER\_ERROR - MICROSOFTTEAMS:TIMEOUT ## Add Group Members `` The following table shows the required permissions for this operation:
Permission TypePermissions (from least privileged to most privileged)

Delegated (work or school account)

GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.ReadWrite.All

Delegated (personal Microsoft account)

Not supported.

Application

GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.ReadWrite.All

### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Group Id

String

Group id where the members should be added

x

Member Ids

Array of String

A list of user IDs to add as members in the specified group.

#[payload]

Read Timeout

Number

Read Timeout value.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value used by the Read Timeout parameter.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

Retry strategy in case of connectivity errors.

### For Configurations - [Authorization Code Config](#AuthorizationCodeConfig) - [Client Credentials Config](#ClientCredentialsConfig) ### Throws - MICROSOFTTEAMS:BAD\_REQUEST - MICROSOFTTEAMS:CONNECTIVITY - MICROSOFTTEAMS:FORBIDDEN - MICROSOFTTEAMS:INVALID\_CONNECTION - MICROSOFTTEAMS:INVALID\_CREDENTIALS - MICROSOFTTEAMS:NOT\_FOUND - MICROSOFTTEAMS:RETRY\_EXHAUSTED - MICROSOFTTEAMS:SERVER\_ERROR - MICROSOFTTEAMS:TIMEOUT ## Add Team Member `` The following table shows the required permissions for this operation:
Permission TypePermissions (from least privileged to most privileged)

Delegated (work or school account)

TeamMember.ReadWrite.All

Delegated (personal Microsoft account)

Not supported.

Application

TeamMember.ReadWrite.All

### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Team Id

String

Team Id where the user should be added

x

User Id

String

User ID of the user to add as a member of the specified team.

x

Owner

Boolean

Set to true to designate the user as the owner of the team.

false

Read Timeout

Number

Read timeout value.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The time unit value used by the Read Timeout parameter.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Binary

Attributes Type

Binary

### For Configurations - [Authorization Code Config](#AuthorizationCodeConfig) - [Client Credentials Config](#ClientCredentialsConfig) ### Throws - MICROSOFTTEAMS:BAD\_REQUEST - MICROSOFTTEAMS:CONNECTIVITY - MICROSOFTTEAMS:FORBIDDEN - MICROSOFTTEAMS:INVALID\_CONNECTION - MICROSOFTTEAMS:INVALID\_CREDENTIALS - MICROSOFTTEAMS:NOT\_FOUND - MICROSOFTTEAMS:RETRY\_EXHAUSTED - MICROSOFTTEAMS:SERVER\_ERROR - MICROSOFTTEAMS:TIMEOUT ## Create Channel `` The following table shows the required permissions for this operation:
Permission TypePermissions (from least privileged to most privileged)

Delegated (work or school account)

Channel.Create

Delegated (personal Microsoft account)

Not supported.

Application

Channel.Create.Group, Channel.Create, Teamwork.Migrate.All

### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Team id

String

Team Id where the channel should be created

x

Attributes

Object

Information regarding the channel to be created

#[payload]

Read Timeout

Number

Read timeout value.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The time unit value used by the Read Timeout parameter.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Binary

Attributes Type

Binary

### For Configurations - [Authorization Code Config](#AuthorizationCodeConfig) - [Client Credentials Config](#ClientCredentialsConfig) ### Throws - MICROSOFTTEAMS:BAD\_REQUEST - MICROSOFTTEAMS:CONNECTIVITY - MICROSOFTTEAMS:FORBIDDEN - MICROSOFTTEAMS:INVALID\_CONNECTION - MICROSOFTTEAMS:INVALID\_CREDENTIALS - MICROSOFTTEAMS:NOT\_FOUND - MICROSOFTTEAMS:RETRY\_EXHAUSTED - MICROSOFTTEAMS:SERVER\_ERROR - MICROSOFTTEAMS:TIMEOUT ## Create Message `` The following table shows the required permissions for this operation:
Permission TypePermissions (from least privileged to most privileged)

Delegated (work or school account)

ChannelMessage.Send

Delegated (personal Microsoft account)

Not supported.

### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Team id

String

Team Id where the channel is present

x

Channel id

String

Channel Id where the message should be published

x

Message

Object

The message to be published

#[payload]

Read Timeout

Number

Read timeout value.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The time unit value used by the Read Timeout parameter.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Any

Attributes Type

Binary

### For Configurations - [Authorization Code Config](#AuthorizationCodeConfig) ### Throws - MICROSOFTTEAMS:BAD\_REQUEST - MICROSOFTTEAMS:CONNECTIVITY - MICROSOFTTEAMS:FORBIDDEN - MICROSOFTTEAMS:INVALID\_CONNECTION - MICROSOFTTEAMS:INVALID\_CREDENTIALS - MICROSOFTTEAMS:NOT\_FOUND - MICROSOFTTEAMS:RETRY\_EXHAUSTED - MICROSOFTTEAMS:SERVER\_ERROR - MICROSOFTTEAMS:TIMEOUT ## Create Team `` The following table shows the required permissions for this operation:
Permission TypePermissions (from least to most privileged)

Delegated (work or school account)

Team.Create

Delegated (personal Microsoft account)

Not supported.

Application

Team.Create, Teamwork.Migrate.All

### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Attributes

Object

Information regarding the team to be created

#[payload]

Read Timeout

Number

Read timeout value.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The time unit value used by the Read Timeout parameter.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Binary

Attributes Type

Binary

### For Configurations - [Authorization Code Config](#AuthorizationCodeConfig) - [Client Credentials Config](#ClientCredentialsConfig) ### Throws - MICROSOFTTEAMS:BAD\_REQUEST - MICROSOFTTEAMS:CONNECTIVITY - MICROSOFTTEAMS:FORBIDDEN - MICROSOFTTEAMS:INVALID\_CONNECTION - MICROSOFTTEAMS:INVALID\_CREDENTIALS - MICROSOFTTEAMS:NOT\_FOUND - MICROSOFTTEAMS:RETRY\_EXHAUSTED - MICROSOFTTEAMS:SERVER\_ERROR - MICROSOFTTEAMS:TIMEOUT ## Delete Channel `` The following table shows the required permissions for this operation:
Permission TypePermissions (from least privileged to most privileged)

Delegated (work or school account)

Channel.Delete.All

Delegated (personal Microsoft account)

Not supported.

Application

Channel.Delete.All, Channel.Delete.Group

### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Team id

String

Team Id where the channel is present

x

Channel id

String

Channel id to be deleted

x

Read Timeout

Number

Read timeout value.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The time unit value used by the Read Timeout parameter.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

A retry strategy in case of connectivity errors

### For Configurations - [Authorization Code Config](#AuthorizationCodeConfig) - [Client Credentials Config](#ClientCredentialsConfig) ### Throws - MICROSOFTTEAMS:BAD\_REQUEST - MICROSOFTTEAMS:CONNECTIVITY - MICROSOFTTEAMS:FORBIDDEN - MICROSOFTTEAMS:INVALID\_CONNECTION - MICROSOFTTEAMS:INVALID\_CREDENTIALS - MICROSOFTTEAMS:NOT\_FOUND - MICROSOFTTEAMS:RETRY\_EXHAUSTED - MICROSOFTTEAMS:SERVER\_ERROR - MICROSOFTTEAMS:TIMEOUT ## Delete Team `` The following table shows the required permissions for this operation:
Permission TypePermissions (from least privileged to most privileged)

Delegated (work or school account)

Group.ReadWrite.All

Delegated (personal Microsoft account)

Not supported.

Application

Group.ReadWrite.All

### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Team Id

String

Team id to be removed

x

Read Timeout

Number

Read timeout value.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The time unit value used by the read timeout.

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x

Reconnection Strategy

A retry strategy in case of connectivity errors

### For Configurations - [Authorization Code Config](#AuthorizationCodeConfig) - [Client Credentials Config](#ClientCredentialsConfig) ### Throws - MICROSOFTTEAMS:BAD\_REQUEST - MICROSOFTTEAMS:CONNECTIVITY - MICROSOFTTEAMS:FORBIDDEN - MICROSOFTTEAMS:INVALID\_CONNECTION - MICROSOFTTEAMS:INVALID\_CREDENTIALS - MICROSOFTTEAMS:NOT\_FOUND - MICROSOFTTEAMS:RETRY\_EXHAUSTED - MICROSOFTTEAMS:SERVER\_ERROR - MICROSOFTTEAMS:TIMEOUT ## Get Channel `` The following table shows the required permissions for this operation:
Permission TypePermissions (from least privileged to most privileged)

Delegated (work or school account)

Channel.ReadBasic.All, ChannelSettings.Read.All, ChannelSettings.ReadWrite.All

Delegated (personal Microsoft account)

Not supported.

Application

ChannelSettings.Read.Group, ChannelSettings.ReadWrite.Group, Channel.ReadBasic.All, ChannelSettings.Read.All, ChannelSettings.ReadWrite.All

### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Team id

String

Team Id where the channel is present

x

Channel id

String

Channel Id to be retrieved

x

Select

String

Properties to be retrieved in the response

Expand

String

The response will include information regarding the specified relationship

Filter

String

Use the filter query parameter to retrieve just a subset of a collection.

Advanced Query Params

Object

Read Timeout

Number

Read timeout value.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The time unit value used by the Read Timeout parameter.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Binary

Attributes Type

Binary

### For Configurations - [Authorization Code Config](#AuthorizationCodeConfig) - [Client Credentials Config](#ClientCredentialsConfig) ### Throws - MICROSOFTTEAMS:BAD\_REQUEST - MICROSOFTTEAMS:CONNECTIVITY - MICROSOFTTEAMS:FORBIDDEN - MICROSOFTTEAMS:INVALID\_CONNECTION - MICROSOFTTEAMS:INVALID\_CREDENTIALS - MICROSOFTTEAMS:NOT\_FOUND - MICROSOFTTEAMS:RETRY\_EXHAUSTED - MICROSOFTTEAMS:SERVER\_ERROR - MICROSOFTTEAMS:TIMEOUT ## Get Team `` The following table shows the required permissions for this operation:
Permission TypePermissions (from least privileged to most privileged)

Delegated (work or school account)

Team.ReadBasic.All, TeamSettings.Read.All, TeamSettings.ReadWrite.All

Delegated (personal Microsoft account)

Not supported.

Application

TeamSettings.Read.Group, TeamSettings.ReadWrite.Group, Team.ReadBasic.All, TeamSettings.Read.All, TeamSettings.ReadWrite.All

### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Team id

String

Team Id to be retrieved

x

Select

String

Properties to be retrieved in the response

Expand

String

The response will include information regarding the specified relationship

Advanced Query Params

Object

Read Timeout

Number

Read timeout value.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The time unit value used by the Read Timeout parameter.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Binary

Attributes Type

Binary

### For Configurations - [Authorization Code Config](#AuthorizationCodeConfig) - [Client Credentials Config](#ClientCredentialsConfig) ### Throws - MICROSOFTTEAMS:BAD\_REQUEST - MICROSOFTTEAMS:CONNECTIVITY - MICROSOFTTEAMS:FORBIDDEN - MICROSOFTTEAMS:INVALID\_CONNECTION - MICROSOFTTEAMS:INVALID\_CREDENTIALS - MICROSOFTTEAMS:NOT\_FOUND - MICROSOFTTEAMS:RETRY\_EXHAUSTED - MICROSOFTTEAMS:SERVER\_ERROR - MICROSOFTTEAMS:TIMEOUT ## List Channel Members `` The following table shows the required permissions for this operation:
Permission TypePermissions (from least privileged to most privileged)

Delegated (work or school account)

ChannelMember.Read.All, ChannelMember.ReadWrite.All

Delegated (personal Microsoft account)

Not supported.

Application

ChannelMember.Read.All, ChannelMember.ReadWrite.All

### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Team Id

String

Team Id where the channel is present

x

Channel Id

String

Channel Id to list its members

x

Read Timeout

Number

Read timeout value.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The time unit value used by the Read Timeout parameter.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Binary

Attributes Type

Binary

### For Configurations - [Authorization Code Config](#AuthorizationCodeConfig) - [Client Credentials Config](#ClientCredentialsConfig) ### Throws - MICROSOFTTEAMS:BAD\_REQUEST - MICROSOFTTEAMS:CONNECTIVITY - MICROSOFTTEAMS:FORBIDDEN - MICROSOFTTEAMS:INVALID\_CONNECTION - MICROSOFTTEAMS:INVALID\_CREDENTIALS - MICROSOFTTEAMS:NOT\_FOUND - MICROSOFTTEAMS:RETRY\_EXHAUSTED - MICROSOFTTEAMS:SERVER\_ERROR - MICROSOFTTEAMS:TIMEOUT ## List Channels `` The following table shows the required permissions for this operation:
Permission TypePermissions (from least privileged to most privileged)

Delegated (work or school account)

Channel.ReadBasic.All, ChannelSettings.Read.All, ChannelSettings.ReadWrite.All

Delegated (personal Microsoft account)

Not supported.

Application

ChannelSettings.Read.Group, ChannelSettings.ReadWrite.Group, Channel.ReadBasic.All, ChannelSettings.Read.All, ChannelSettings.ReadWrite.All

### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Team Id

String

Team Id to list its channels

x

Select

String

Properties to be retrieved in the response

Filter

String

Use the filter query parameter to retrieve just a subset of a collection.

Advanced Query Params

Object

Read Timeout

Number

Read timeout value.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The time unit value used by the Read Timeout parameter.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Binary

Attributes Type

Binary

### For Configurations - [Authorization Code Config](#AuthorizationCodeConfig) - [Client Credentials Config](#ClientCredentialsConfig) ### Throws - MICROSOFTTEAMS:BAD\_REQUEST - MICROSOFTTEAMS:CONNECTIVITY - MICROSOFTTEAMS:FORBIDDEN - MICROSOFTTEAMS:INVALID\_CONNECTION - MICROSOFTTEAMS:INVALID\_CREDENTIALS - MICROSOFTTEAMS:NOT\_FOUND - MICROSOFTTEAMS:RETRY\_EXHAUSTED - MICROSOFTTEAMS:SERVER\_ERROR - MICROSOFTTEAMS:TIMEOUT ## List Group Members `` The following table shows the required permissions for this operation:
Permission TypePermissions (from least privileged to most privileged)

Delegated (work or school account)

GroupMember.Read.All, Group.Read.All, GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.Read.All

Delegated (personal Microsoft account)

Not supported.

Application

GroupMember.Read.All, Group.Read.All, GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.Read.All

### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Group Id

String

Group id to list its members

x

Select

String

Properties to be retrieved in the response

Expand

String

The response will include information regarding the specified relationship

Filter

String

Use the filter query parameter to retrieve just a subset of a collection.

Order By

String

Use the orderby parameter to specify the sort order of the items returned

Search

String

Use the search parameter to restrict the results of a request to match a search criterion

Skip

Number

Use the skip parameter to set the number of items to skip at the start of a collection.

Top

Number

Use the top query parameter to specify the page size of the result set.

Count

Boolean

Retrieves the total count of matching resources.

false

Advanced Query Params

Object

Read Timeout

Number

Read timeout value.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The time unit value used by the Read Timeout parameter.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Array of Object

### For Configurations - [Authorization Code Config](#AuthorizationCodeConfig) - [Client Credentials Config](#ClientCredentialsConfig) ### Throws - MICROSOFTTEAMS:BAD\_REQUEST - MICROSOFTTEAMS:FORBIDDEN - MICROSOFTTEAMS:INVALID\_CONNECTION - MICROSOFTTEAMS:INVALID\_CREDENTIALS - MICROSOFTTEAMS:NOT\_FOUND - MICROSOFTTEAMS:SERVER\_ERROR - MICROSOFTTEAMS:TIMEOUT ## List Team Members `` The following table shows the required permissions for this operation:
Permission TypePermissions (from least privileged to most privileged)

Delegated (work or school account)

TeamMember.Read.All, TeamMember.ReadWrite.All

Delegated (personal Microsoft account)

Not supported.

Application

TeamMember.Read.Group, TeamMember.Read.All, TeamMember.ReadWrite.All

### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Team id

String

Team Id to list its members

x

Select

String

Properties to be retrieved in the response

Filter

String

Advanced Query Params

Object

Read Timeout

Number

Read timeout value.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The time unit value used by the Read Timeout parameter.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

### Output

Type

Binary

Attributes Type

Binary

### For Configurations - [Authorization Code Config](#AuthorizationCodeConfig) - [Client Credentials Config](#ClientCredentialsConfig) ### Throws - MICROSOFTTEAMS:BAD\_REQUEST - MICROSOFTTEAMS:CONNECTIVITY - MICROSOFTTEAMS:FORBIDDEN - MICROSOFTTEAMS:INVALID\_CONNECTION - MICROSOFTTEAMS:INVALID\_CREDENTIALS - MICROSOFTTEAMS:NOT\_FOUND - MICROSOFTTEAMS:RETRY\_EXHAUSTED - MICROSOFTTEAMS:SERVER\_ERROR - MICROSOFTTEAMS:TIMEOUT ## Remove Channel Member `` The following table shows the required permissions for this operation:
Permission TypePermissions (from least privileged to most privileged)

Delegated (work or school account)

ChannelMember.ReadWrite.All

Delegated (personal Microsoft account)

Not supported.

Application

ChannelMember.ReadWrite.All

### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Team Id

String

Team Id where the channel is present

x

Channel Id

String

Channel Id that contains the member to be removed

x

Membership Id

String

The id of the member to be deleted

x

Read Timeout

Number

Read timeout value.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The time unit value used by the Read Timeout parameter.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

A retry strategy in case of connectivity errors

### For Configurations - [Authorization Code Config](#AuthorizationCodeConfig) - [Client Credentials Config](#ClientCredentialsConfig) ### Throws - MICROSOFTTEAMS:BAD\_REQUEST - MICROSOFTTEAMS:CONNECTIVITY - MICROSOFTTEAMS:FORBIDDEN - MICROSOFTTEAMS:INVALID\_CONNECTION - MICROSOFTTEAMS:INVALID\_CREDENTIALS - MICROSOFTTEAMS:NOT\_FOUND - MICROSOFTTEAMS:RETRY\_EXHAUSTED - MICROSOFTTEAMS:SERVER\_ERROR - MICROSOFTTEAMS:TIMEOUT ## Remove Group Member `` The following table shows the required permissions for this operation:
Permission TypePermissions (from least privileged to most privileged)

Delegated (work or school account)

GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.ReadWrite.All

Delegated (personal Microsoft account)

Not supported.

Application

GroupMember.ReadWrite.All, Group.ReadWrite.All, Directory.ReadWrite.All

### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Group Id

String

Group id where the member to be removed is present

x

Member Id

String

User id that is member in this group

x

Read Timeout

Number

Read timeout value.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The time unit value used by the Read Timeout parameter.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

A retry strategy in case of connectivity errors

### For Configurations - [Authorization Code Config](#AuthorizationCodeConfig) - [Client Credentials Config](#ClientCredentialsConfig) ### Throws - MICROSOFTTEAMS:BAD\_REQUEST - MICROSOFTTEAMS:CONNECTIVITY - MICROSOFTTEAMS:FORBIDDEN - MICROSOFTTEAMS:INVALID\_CONNECTION - MICROSOFTTEAMS:INVALID\_CREDENTIALS - MICROSOFTTEAMS:NOT\_FOUND - MICROSOFTTEAMS:RETRY\_EXHAUSTED - MICROSOFTTEAMS:SERVER\_ERROR - MICROSOFTTEAMS:TIMEOUT ## Remove Team Member `` The following table shows the required permissions for this operation:
Permission TypePermissions (from least privileged to most privileged)

Delegated (work or school account)

TeamMember.ReadWrite.All

Delegated (personal Microsoft account)

Not supported.

Application

TeamMember.ReadWrite.All

### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Team id

String

Team Id that contains the member to be removed

x

Membership Id

String

The id of the member to be removed

x

Read Timeout

Number

Read timeout value.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The time unit value used by the Read Timeout parameter.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

A retry strategy in case of connectivity errors

### For Configurations - [Authorization Code Config](#AuthorizationCodeConfig) - [Client Credentials Config](#ClientCredentialsConfig) ### Throws - MICROSOFTTEAMS:BAD\_REQUEST - MICROSOFTTEAMS:CONNECTIVITY - MICROSOFTTEAMS:FORBIDDEN - MICROSOFTTEAMS:INVALID\_CONNECTION - MICROSOFTTEAMS:INVALID\_CREDENTIALS - MICROSOFTTEAMS:NOT\_FOUND - MICROSOFTTEAMS:RETRY\_EXHAUSTED - MICROSOFTTEAMS:SERVER\_ERROR - MICROSOFTTEAMS:TIMEOUT ## Unauthorize `` Deletes all the access token information of a given resource owner id so that it’s impossible to execute any operation for that user without doing the authorization dance again ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Resource Owner Id

String

The ID of the resource owner for whom to invalidate access.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

### For Configurations - [Authorization Code Config](#AuthorizationCodeConfig) - [Client Credentials Config](#ClientCredentialsConfig) ## Update Channel `` The following table shows the required permissions for this operation:
Permission TypePermissions (from least privileged to most privileged)

Delegated (work or school account)

ChannelSettings.ReadWrite.All,

Delegated (personal Microsoft account)

Not supported.

Application

ChannelSettings.ReadWrite.Group, ChannelSettings.ReadWrite.All

### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Team Id

String

Team ID where the channel is present

x

Channel Id

String

Channel Id to be updated

x

Attributes

Object

Information regarding the channel to be updated

#[payload]

Read Timeout

Number

Read timeout value.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The time unit value used by the Read Timeout parameter.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Reconnection Strategy

A retry strategy in case of connectivity errors

### For Configurations - [Authorization Code Config](#AuthorizationCodeConfig) - [Client Credentials Config](#ClientCredentialsConfig) ### Throws - MICROSOFTTEAMS:BAD\_REQUEST - MICROSOFTTEAMS:CONNECTIVITY - MICROSOFTTEAMS:FORBIDDEN - MICROSOFTTEAMS:INVALID\_CONNECTION - MICROSOFTTEAMS:INVALID\_CREDENTIALS - MICROSOFTTEAMS:NOT\_FOUND - MICROSOFTTEAMS:RETRY\_EXHAUSTED - MICROSOFTTEAMS:SERVER\_ERROR - MICROSOFTTEAMS:TIMEOUT ## Update Team `` The following table shows the required permissions for this operation:
Permission TypePermissions (from least privileged to most privileged)

Delegated (work or school account)

TeamSettings.ReadWrite.All

Delegated (personal Microsoft account)

Not supported.

Application

TeamSettings.ReadWrite.Group, TeamSettings.ReadWrite.All

### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use

x

Team id

String

ID of the team to update

x

Attributes

Object

Information to update

#[payload]

Read Timeout

Number

Read timeout value

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value used by the Read Timeout parameter

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component

x

Reconnection Strategy

Retry strategy in case of connectivity errors

### For Configurations - [Authorization Code Config](#AuthorizationCodeConfig) - [Client Credentials Config](#ClientCredentialsConfig) ### Throws - MICROSOFTTEAMS:BAD\_REQUEST - MICROSOFTTEAMS:CONNECTIVITY - MICROSOFTTEAMS:FORBIDDEN - MICROSOFTTEAMS:INVALID\_CONNECTION - MICROSOFTTEAMS:INVALID\_CREDENTIALS - MICROSOFTTEAMS:NOT\_FOUND - MICROSOFTTEAMS:RETRY\_EXHAUSTED - MICROSOFTTEAMS:SERVER\_ERROR - MICROSOFTTEAMS:TIMEOUT ## Types ### Proxy Configuration
FieldTypeDescriptionDefault ValueRequired

Host

String

Host where the proxy requests will be sent.

x

Port

Number

Port where the proxy requests will be sent.

x

Username

String

The username to authenticate against the proxy.

Password

String

The password to authenticate against the proxy.

### Tls
FieldTypeDescriptionDefault ValueRequired

Enabled Protocols

String

A comma separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma separated list of cipher suites enabled for this context.

Trust Store

Key Store

Revocation Check

### Trust Store
FieldTypeDescriptionDefault ValueRequired

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

### Key Store
FieldTypeDescriptionDefault ValueRequired

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

### Standard Revocation Check
FieldTypeDescriptionDefault ValueRequired

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

### Custom Ocsp Responder
FieldTypeDescriptionDefault ValueRequired

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

### Crl File
FieldTypeDescriptionDefault ValueRequired

Path

String

The path to the CRL file.

### Reconnection
FieldTypeDescriptionDefault ValueRequired

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use

### Reconnect
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often (in ms) to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

Count

Number

How many reconnection attempts to make

### Reconnect Forever
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often (in ms) to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

### Expiration Policy
FieldTypeDescriptionDefault ValueRequired

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

### Repeatable In Memory Stream
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

### Repeatable File Store Stream
FieldTypeDescriptionDefault ValueRequired

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

### Repeatable In Memory Iterable
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

This is the amount of instances that will be initially be allowed to be kept in memory in order to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then it will be expanded according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much will the buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

### Repeatable File Store Iterable
FieldTypeDescriptionDefault ValueRequired

In Memory Objects

Number

This is the maximum amount of instances that will be kept in memory. If more than that is required, then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

## See Also - [Salesforce Help](https://help.salesforce.com) --- product: Microsoft Teams Connector version: 1.1 is-latest-version: true --- # Microsoft Teams Connector 1.1 XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio: - If you manually code a Mule runtime engine (Mule) app in XML either from the Anypoint Studio XML editor or from a text editor, you can access the connector from your app by adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file. - If you add the connector in Studio, Studio automatically populates the XML code with the connector’s namespace and schema location and it also adds a dependency to the `pom.xml` file. ## Add a Namespace for the Connector Paste the following code inside the `mule` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/microsoft-teams http://www.mulesoft.org/schema/mule/microsoft-teams/current/mule4-microsoft-teams.xsd ``` This example shows how the namespace statements are placed in the XML: ```xml ``` ## Add a POM File Dependency The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector: ```xml com.mulesoft.connectors mule4-microsoft-teams-connector 1.0.0 mule-plugin ``` Replace `` with the version that corresponds to the connector you are using. To obtain the most up-to-date `pom.xml` file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `microsoft teams`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Microsoft Teams Connector version: 1.1 is-latest-version: true --- # Using Anypoint Studio to Configure Microsoft Teams Connector 1.1 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure a source for the connector’s flow](#configure-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). 6. [Configure the other connector fields](#configure-other-fields). When you run the connector, you can view the app log to check for problems in real time, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If, after reading this topic, you need additional information about the connector fields, see the [Microsoft Teams Reference](https://docs.mulesoft.com/microsoft-teams-connector/latest/microsoft-teams-connector-reference). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. In Studio, select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add Microsoft Teams Connector to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In the **Add Dependencies to Project** window, type `microsoft teams` in the search field. 3. Click Microsoft Teams in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure a Source A source initiates a flow when a specified condition is met. You can configure one of these sources to use with Microsoft Teams Connector: - HTTP Listener Initiates a flow each time it receives a request on the configured host and port - Scheduler Initiates a flow when a time-based condition is met For example, to configure an HTTP Listener source, follow these steps: 1. In the **Mule Palette** view, select **HTTP > Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (**+**) next to the **Connector configuration** field to configure a global element that can be used by all instances of the HTTP Listener source in the app. 6. On the **General** tab, specify connection information for the connector. 7. On the **TLS** tab, optionally specify the TLS information for the connector. 8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you are specifying an action for that connector to perform. To add an operation for Microsoft Teams Connector, follow these steps: 1. In the **Mule Palette** view, select **Microsoft Teams** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the input source. ## Configure a Global Element for the Connector When you configure a connector, configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target Microsoft Teams system. Microsoft Teams Connector supports OAuth 2.0 Authorization Code and OAuth 2.0 client credentials authentication methods. To configure the global element for Microsoft Teams Connector, follow these steps: 1. Select the operation in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (**+**) next to the **Connector configuration** field to access the global element configuration fields. 3. On the **General** tab, On the **General** tab, in **Connection**, select the authentication method to configure: - [OAuth 2.0 Authorization Code](#oauth2-authorization) - [OAuth 2.0 Client Credentials](#oauth2-client-credentials-authentication) You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, see [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). 4. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 5. Click **Test Connection** to confirm that Mule can connect with the specified server. 6. Click **OK**. ### OAuth 2.0 Authorization Code Authentication Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). Enter the following information on the **General** tab of the **Global Element Properties** screen to configure OAuth 2.0 Authorization Code authentication:
Field

User Action

Name

Enter the configuration name.

Connection

Select OAuth 2.0 Authorization Code.

Consumer Key

OAuth consumer key as registered with the Microsoft identity platform.

Consumer Secret

OAuth consumer secret that corresponds to the consumer key.

Listener Config

A reference to a <http:listener-config /> to use to create the listener that receives the access token callback endpoint.

Callback Path

Path of the access token callback endpoint.

Authorize Path

Path of the local HTTP endpoint that triggers the OAuth dance.

### OAuth 2.0 Client Credentials Authentication Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). Enter the following information on the **General** tab of the global element configuration screen to configure Role authentication: %header,cols=30s,70a\]

Field

User Action

Name

Enter the configuration name.

Connection

Select OAuth 2.0 Client Credentials.

Client ID

OAuth client ID as registered with the service provider.

Client Secret

OAuth client secret that corresponds to the client ID.

## Configure Additional Connector Fields After you configure a global element for Microsoft Teams Connector, configure the other required fields for the connector. The required fields vary depending on which connector operation you use. ## View the App Log To check for problems, you can view the app log as follows: - If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log output is visible in your OS console. Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the app log in the default location `MULE_HOME/logs/.log`. You can configure the location of the log path in the app log file `log4j2.xml`. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio) - [Microsoft Teams Connector Reference](https://docs.mulesoft.com/microsoft-teams-connector/latest/microsoft-teams-connector-reference) - [Salesforce Help](https://help.salesforce.com)