Microsoft Teams
Microsoft Teams is a messaging service from Microsoft.
Supported Actions and Example Prompts
The following table lists the supported actions and prompt examples for an action:
Action Name | Description | Prompt Example |
|---|---|---|
Get Channels Using Team Name | This action retrieves all the team channels. For more information, see Action: Get Channels Using Team Name. | Get channels of the team ID 0efcc002-6001-4a21-991b-8ba10bac0613 from Microsoft Teams. |
Get Teams | This action retrieves the IDs of all teams. For more information, see Action: Get Teams. | Get the list of teams with a pagination limit of 100 from Microsoft Teams. |
Send Message Using Team and Channel Name | This action sends a message. For more information, see Action: Send Message Using Team and Channel Name. | Send a message Hello all to the team 0efcc002-6001-4a21-991b-8ba10bac0613 and channel 19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2 with HTML as true. |
Install and Configure the App
Install and configure the required apps to enable Quarterback AI to perform various security-related tasks and provide relevant responses. After installing an app, you must create an instance that will be used to communicate with the app endpoints. An app can have multiple instances, and you can set a default instance from the configured instance list.
Before you Start
Ensure that you have the API token to authenticate with the Microsoft Teams app.
Steps
To install and configure an app, follow these steps:
Go to the application, in the left pane, select Quarterback AI.
In Apps, select Microsoft Teams and click Install.
After the app is installed, click Configure and enter the following details to create an instance:
Instance Name: Enter a name for the instance.
Instance Description: Enter a description for the instance.
Expiry: Select an expiry date for the instance.
Set as default instance: Select this option to set this instance as the default instance. By default, this instance will be used to perform actions from this app.
Username: Enter the username of a user. For example, john@cyware.com.
Password: Enter the password.
Client ID: Enter the application ID assigned to your app. You can retrieve the client ID from the app registration portal.
Client Secret: Enter the client secret key assigned to your app in the app registration portal.
Tenant ID: Enter the Azure Active Directory tenant ID.
SSL Verification: Select this option to verify SSL while making requests. It is recommended to select this option to ensure a secure connection. By default, this option is not selected.
Timeout: Enter the timeout value in seconds. This is the number of seconds that requests will wait to establish a connection with Microsoft Teams. You can enter values between 15 - 120 seconds. By default, 15 seconds is set.
Click Done.
The instance is created, and you can view it in Instances. To create another instance, click Add Instance.
Action: Get Channels Using Team Name
This action retrieves the channels of a team using the specified team name.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
Team Name | Enter the team name to retrieve all associated channels. The team name is case-sensitive. Example: Sample Team Name | Text | Required | You can retrieve Team Name using the Get Teams action. |
Example Request
[
{
"display_name": "Sample Team Name"
}
]Action: Get Teams
This action retrieves the IDs of all teams.
Scope
The following are the permissions required for the Application:
TeamSettings.Read.Group*, TeamSettings.ReadWrite.Group*, Team.ReadBasic.All, TeamSettings.Read.All, TeamSettings.ReadWrite.All, Group.Read.All*, Group.ReadWrite.All*, Directory.Read.All*, Directory.ReadWrite.All*
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Limit | Enter a limit for pagination of the team IDs. Example: 10 | Integer | Required | Default value: 200 |
Example Request
[
{
"limit": 10
}
]Action Response Parameters
Parameter | Type | Description |
|---|---|---|
app_instance.value | Array | An array containing information about the team. |
app_instance.value.id | String | The unique identifier of the team. Example: "172b0cce-e65d-44ce-9a49-91d9f2e8493a" |
app_instance.value.displayName | String | The display name of the team. Example: "Contoso Team" |
app_instance.value.description | String | The description of the team. Example: "This is a Contoso team, used to showcase the range of properties supported by this API" |
Action: Send Message Using Team and Channel Name
This action sends a message using the team and channel name.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
Team Name | Enter the team name to send the message. The team name is case-sensitive. Example: Sample Team | Text | Required | You can retrieve this using the Get Teams action. |
Channel Name | Enter the channel name to send the message. Example: Sample Channel | Text | Required | You can retrieve this using the Get Channels Using Team Name action. |
Message | Enter the message to be sent. Example: This is a sample message. | Text | Required | |
Is HTML | Choose true to indicate that the message is in HTML format. | Boolean | Optional | Default value: false |
Example Request
[
{
"message": "This is a sample message.",
"team_name": "Sample Team",
"channel_name": "Sample Channel"
}
]