Microsoft Teams connection¶
Introduction¶
A Microsoft Teams connection, created using the Microsoft Teams connector, establishes access to Microsoft Teams. Once a connection is configured, you can create instances of Microsoft Teams activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).
Create or edit a Microsoft Teams connection¶
A new Microsoft Teams connection is created using the Microsoft Teams connector from one of these locations:
- The design component palette's Project endpoints and connectors tab (see Design component palette).
- The Global Connections page (see Create a global endpoint in Global Connections).
An existing Microsoft Teams connection can be edited from these locations:
- The design component palette's Project endpoints and connectors tab (see Design component palette).
- The project pane's Components tab (see Component actions menu in Project pane Components tab).
- The Global Connections page (see Edit a global endpoint in Global Connections).
Configure a Microsoft Teams connection¶
Each user interface element of the Microsoft Teams connection configuration screen is described below.
Tip
Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [
into the field or by clicking the variable icon to display a list of the existing variables to choose from.
-
Connection name: Enter a name to use to identify the connection. The name must be unique for each Microsoft Teams connection and must not contain forward slashes
/
or colons:
. This name is also used to identify the Microsoft Teams endpoint, which refers to both a specific connection and its activities. -
Tenant ID: Enter the tenant ID. The tenant ID can be obtained from logging into Microsoft Azure Active Directory.
-
Client ID: Enter the client ID. Both the client ID and client secret value are assigned when your app is registered following instructions at Microsoft Teams prerequisites.
-
Client secret: Enter the client secret value. Both the client ID and client secret value are assigned when your app is registered following instructions at Microsoft Teams prerequisites.
-
Username: Enter the username you use to log in to Microsoft Azure Active Directory.
-
Password: Enter the password you use to log in to Microsoft Azure Active Directory.
-
Optional settings: Click to expand these optional settings:
-
Scope: Enter the Microsoft Teams API permissions that are enabled for your app registration. By default, all 31 API permissions that are required to use all activities, as described in Prerequisites, are prepopulated in this field.
-
Use Proxy Settings (Private Agent Only): When using a private agent, this setting can be selected to use private agent proxy settings.
-
-
Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.
-
Save Changes: Click to save and close the connection configuration.
-
Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.
-
Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.
Next steps¶
After a Microsoft Teams connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).
Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.
These activity types are available:
-
List Channels: Retrieves a list of channels for a team at Microsoft Teams and is intended to be used as a target in an operation.
-
Add Members: Adds members to a channel in a team at Microsoft Teams and is intended to be used as a target in an operation.
-
Add Channels: Creates channels (with the option of adding members) in a team at Microsoft Teams and is intended to be used as a target in an operation.
-
Chat: Retrieves an existing chat or creates a new chat at Microsoft Teams and is intended to be used as a target in an operation.
-
Send Message: Sends a message to a specific team and channel at Microsoft Teams and is intended to be used as a target in an operation.