mirror of
https://github.com/awatertrevi/infisical.git
synced 2026-09-22 13:39:35 +00:00
docs(workflow-integrations): microsoft teams
This commit is contained in:
Daniel Hougaard
@@ -0,0 +1,240 @@
|
||||
---
|
||||
title: "Microsoft Teams Integration"
|
||||
description: "Learn how to setup the Microsoft Teams integration"
|
||||
---
|
||||
|
||||
import MicrosoftTeamsWorkflowIntegration from '/snippets/documentation/platform/workflow-integrations/microsoft-teams-integration.mdx';
|
||||
|
||||
|
||||
This guide will provide step by step instructions on how to configure Microsoft Teams integration for your Infisical projects.
|
||||
|
||||
## Setting up Microsoft Teams integration in your projects
|
||||
|
||||
<Tabs>
|
||||
<Tab title="Infisical Cloud">
|
||||
<MicrosoftTeamsWorkflowIntegration />
|
||||
</Tab>
|
||||
<Tab title="Self-hosted setup">
|
||||
### Configure Azure Resources
|
||||
To create a Microsoft Teams bot, you must first create an Azure Bot from the Azure Marketplace, an app registration, and a Microsoft Teams app. The steps below document in detail how to create and configure these resources.
|
||||
|
||||
<Steps>
|
||||
<Step title="Create Azure Bot resource">
|
||||
|
||||
When creating the Azure Bot resource, it's important that you set the `Type of App` to `Multi Tenant`. Additionally, you must set the `Creation Type` to `Create new Microsoft App ID`.
|
||||
|
||||
|
||||
|
||||
|
||||
Click the "Review + create" button and complete the creation process.
|
||||
|
||||
Once this is completed, an Azure Bot **and** an app registration will be created. We will need to configure both to work with Microsoft Teams.
|
||||
|
||||
</Step>
|
||||
<Step title="Configure Azure Bot resource">
|
||||
After creating the Azure Bot resource, you will be redirected to the Azure Bot resource overview page. Here we can configure the bot's settings.
|
||||
|
||||
**Enable Microsoft Teams Channel**
|
||||
|
||||
This will allow the bot to be used in Microsoft Teams.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Press the "Apply" button to enable the Microsoft Teams channel.
|
||||
|
||||
**Configure Messaging Endpoint**
|
||||
|
||||
You must configure the messaging endpoint for the Azure Bot resource. This allows events to be handled by the Infisical Microsoft Teams integration.
|
||||
|
||||
The endpoint must be reachable from the internet, or Infisical won't be notified of events.
|
||||
|
||||
Configure the endpoint to be:<br/>
|
||||
**`https://<your-infisical-instance-url>/api/v1/workflow-integrations/microsoft-teams/message-endpoint`**.<br/>Replace `<your-infisical-instance-url>` with the URL of your Infisical instance.
|
||||
|
||||
Once completed, press the "Apply" button to save your changes.
|
||||
|
||||
|
||||
</Step>
|
||||
<Step title="Configure Azure App Registration">
|
||||
When you created the Azure Bot resource, an app registration associated with the bot was also created. We need to configure the app registration to integrate with Microsoft Teams.
|
||||
|
||||
You can find the app registration in the Azure Portal by navigating to the "App registrations" section, and selecting the app registration with the same name as the Azure Bot resource.
|
||||
|
||||
|
||||
|
||||
|
||||
**Configure Redirect URIs**
|
||||
|
||||
Configure a redirect URI to be:<br/>
|
||||
`https://<your-infisical-instance-url>/organization/settings/oauth/callback`. Replace `<your-infisical-instance-url>` with the URL of your Infisical instance.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**Configure API Permissions**
|
||||
|
||||
Next, configure the API permissions for the app registration.
|
||||
|
||||
Add the following permissions:
|
||||
- `AppCatalog.Read.All`
|
||||
- `ChannelSettings.Read.All`
|
||||
- `MultiTenantOrganization.Read.All`
|
||||
- `Organization.Read.All`
|
||||
- `Team.ReadBasic.All`
|
||||
- `TeamsAppInstallation.Read.All`
|
||||
|
||||
<Note>
|
||||
Please keep in mind that these permissions have to be configured as **Application** permissions, not delegated permissions.
|
||||
</Note>
|
||||
|
||||
Once you've added the permissions, press the **Grant admin consent for [your-organization]** button to grant the permissions.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Get App Registration Client ID and Client Secret">
|
||||
Next we need to get the application client ID and create a new client secret. **Save these values for later, as they're required to configure the Microsoft Teams integration in Infisical.**
|
||||
|
||||
|
||||
Copy the application client ID from the overview page.
|
||||
|
||||
|
||||
Create a new client secret, and save the value. Keep the expiry time in mind when you're creating the secret.
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Create Microsoft Teams Bot">
|
||||
Finally we're ready to create the Microsoft Teams bot itself. This step takes place on the [Microsoft Teams Developer Portal](https://dev.teams.microsoft.com/).
|
||||
|
||||
- Navigate to the [Microsoft Teams Developer Portal](https://dev.teams.microsoft.com/).
|
||||
- Make sure you're logged in with the same Microsoft account as you used to create the Azure Bot resource.
|
||||
|
||||
|
||||
|
||||
Once you're on the Microsoft Teams Developer Portal, press the "Create a new app" button on the overview page. Give the bot a name and press the "Add" button.
|
||||
|
||||
**Update Manifest File**
|
||||
|
||||
The only change you need to make to the Microsoft Teams app you've just created, is to update the `manifest.json` file to match what's expected by Infisical.
|
||||
|
||||
Go to the App Package Editor page, and press the `manifest.json` file to open the file editor.
|
||||
|
||||
|
||||
|
||||
|
||||
Copy the following JSON into the `manifest.json` file:
|
||||
```json manifest.json
|
||||
{
|
||||
"$schema": "https://developer.microsoft.com/en-us/json-schemas/teams/v1.11/MicrosoftTeams.schema.json",
|
||||
"version": "3.0.0",
|
||||
"manifestVersion": "1.11",
|
||||
"id": "f86bbe9c-b853-4f96-8512-7ceba7d2a620", // Keep your existing ID here, this field cannot be changed.
|
||||
"name": {
|
||||
"short": "Infisical",
|
||||
"full": "Infisical Bot"
|
||||
},
|
||||
"developer": {
|
||||
"name": "Infisical",
|
||||
"websiteUrl": "https://www.infisical.com",
|
||||
"privacyUrl": "https://www.infisical.com/privacy",
|
||||
"termsOfUseUrl": "https://www.infisical.com/terms"
|
||||
},
|
||||
"description": {
|
||||
"short": "Microsoft Teams bot for Infisical",
|
||||
"full": "Microsoft Teams bot for Infisical. This bot will send notifications as configured in Infisical to your Microsoft Teams channels."
|
||||
},
|
||||
"icons": {
|
||||
"outline": "outline.png",
|
||||
"color": "color.png"
|
||||
},
|
||||
"accentColor": "#FFFFFF",
|
||||
"bots": [
|
||||
{
|
||||
"botId": "01bad7fb-227b-4ac3-b5f3-41e8cdaf65d7", // Replace the botId with the Client ID of the App Registration from the previous step.
|
||||
"scopes": [
|
||||
"team",
|
||||
"personal",
|
||||
"groupchat"
|
||||
],
|
||||
"isNotificationOnly": true,
|
||||
"supportsCalling": false,
|
||||
"supportsVideo": false,
|
||||
"supportsFiles": false
|
||||
}
|
||||
],
|
||||
"validDomains": []
|
||||
}
|
||||
```
|
||||
|
||||
<Note>
|
||||
Please note that it's very important that the `bots[].botId` field matches the Client ID of the App Registration from the previous step.
|
||||
</Note>
|
||||
|
||||
After making the changes to the manifest file, press the "Save" button to save the changes, and confirm the changes by then pressing the "Update" button.
|
||||
|
||||
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Copy the Bot ID">
|
||||
Once the manifest file is updated, you can copy the Bot ID from the overview page. Save the Bot ID for later, as it's required to configure the Microsoft Teams integration in Infisical, alongside the App Registration Client ID and Client Secret that you saved earlier.
|
||||
|
||||
|
||||
</Step>
|
||||
|
||||
<Step title="Download the App Package">
|
||||
Once the manifest file is updated, you can download the app package by navigating to the "Publish to Store" page, and pressing the "Download app package" button.
|
||||
|
||||
You will need to install the app package into your desired Microsoft Teams tenant(s).
|
||||
|
||||
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
### Configure Microsoft Teams Bot in Infisical
|
||||
|
||||
After creating the Microsoft Teams bot and its corresponding Azure resources, you are ready to configure the Microsoft Teams integration in Infisical.
|
||||
Please note that you must be an instance admin in order to configure the Microsoft Teams instance-wide settings.
|
||||
|
||||
<Steps>
|
||||
<Step title="Navigate to the Integrations tab in your Server Admin Console settings">
|
||||
|
||||
|
||||
|
||||
Enter the values you saved from the earlier steps into the respective fields.
|
||||
|
||||
- **Application (Client) ID**: The Client ID of the App Registration from the previous steps.
|
||||
- **Client Secret**: The Client Secret of the App Registration from the previous steps.
|
||||
- **Bot ID**: The App ID of the Microsoft Teams App from the previous steps.
|
||||
|
||||
Once completed, press the "Save" button to save your changes.
|
||||
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
<MicrosoftTeamsWorkflowIntegration />
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
<Accordion title="Notifications are not being sent to Microsoft Teams even though the integration is configured">
|
||||
If you recently added the Microsoft Teams app to your tenant, **it may take up to 24 hours for Microsoft Teams to propagate the changes.**
|
||||
A common indication of propagation issues is that the workflow integration is shown as "Installed", and you're able to view the teams and channels when configuring the workflow integration on your project, but no notification is being sent.
|
||||
</Accordion>
|
||||
|
||||
<Accordion title="Workflow Integration is stuck on 'Pending' status">
|
||||
The workflow integration can get stuck on Pending if you created the workflow integration before the Infisical Microsoft Teams bot was installed in the tenant.
|
||||
To resolve this, make sure you have installed the Infisical Microsoft Teams app in your tenant.
|
||||
|
||||
You can manually recheck the installation status by pressing the "Check Installation Status" button in the workflow organization settings.
|
||||
|
||||
|
||||
</Accordion>
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Slack integration"
|
||||
description: "Learn how to setup Slack integration"
|
||||
title: "Slack Integration"
|
||||
description: "Learn how to setup the Slack integration"
|
||||
---
|
||||
|
||||
This guide will provide step by step instructions on how to configure Slack integration for your Infisical projects.
|
||||
|
||||
Reference in New Issue
Block a user