Documentation | Providers › Ms Teams

API Reference

Providers

providers

Providers

Ms Teams

providers.ms_teams

Methods

Check Auth -> { connection }

get/v1/providers/ms-teams/{channel_id}/auth_check

Check if a connection to Microsoft Teams has been authorized for a given Microsoft Teams tenant object

List Channels -> { ms_teams_channels }

get/v1/providers/ms-teams/{channel_id}/channels

List the Microsoft Teams channels within a team. By default, archived and private channels are excluded from the results.

List Teams -> { ms_teams_teams, skip_token }

get/v1/providers/ms-teams/{channel_id}/teams

Get a list of teams belonging to the Microsoft Entra tenant. By default, archived and private channels are excluded from the results.

Parameters

channel_id: string

ms_teams_tenant_object: string

A JSON encoded string containing the Microsoft Teams tenant object reference

query_options: {

Optional

$filter: string

Optional

OData param passed to the Microsoft Graph API to filter teams

$select: string

Optional

OData param passed to the Microsoft Graph API to select fields on a team

$skiptoken: string

Optional

OData param passed to the Microsoft Graph API to retrieve the next page of results

$top: number

Optional

OData param passed to the Microsoft Graph API to limit the number of teams returned

}

Response fields

ms_teams_teams: Array<{ id, displayName, description }>

skip_token: string

Request example

curl https://api.knock.app/v1/providers/ms-teams/$CHANNEL_ID/teams \
    -H "Authorization: Bearer $KNOCK_API_KEY" \
    -d '{}'

200Example

{
  "ms_teams_teams": [
    {
      "id": "team-id-1",
      "displayName": "Engineering Team",
      "description": "description"
    }
  ],
  "skip_token": "token-for-next-page"
}

Revoke Access -> string

put/v1/providers/ms-teams/{channel_id}/revoke_access

Remove a Microsoft Entra tenant ID from a Microsoft Teams tenant object

Providers

Slack

providers.slack

Methods

Check Auth -> { connection }

get/v1/providers/slack/{channel_id}/auth_check

Check if a Slack channel is authenticated

List Channels -> SlackChannelsCursor<{ id, context_team_id, is_im, 2 more... }>

get/v1/providers/slack/{channel_id}/channels

List Slack channels for a Slack workspace

Revoke Access -> string

put/v1/providers/slack/{channel_id}/revoke_access

Revoke access for a Slack channel