{ "opencollection": "1.0.0", "info": { "name": "Knock Audiences Microsoft Teams API", "version": "1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Microsoft Teams", "type": "folder" }, "items": [ { "info": { "name": "Check auth", "type": "http" }, "http": { "method": "GET", "url": "https://api.knock.app/v1/providers/ms-teams/:channel_id/auth_check", "params": [ { "name": "channel_id", "value": "", "type": "path", "description": "The ID of the Knock Microsoft Teams channel to check." }, { "name": "ms_teams_tenant_object", "value": "{\"collection\":\"projects\",\"object_id\":\"project_123\"}", "type": "query", "description": "A JSON encoded string containing the Microsoft Teams tenant object reference." } ] }, "docs": "Check if a connection to Microsoft Teams has been authorized for a given Microsoft Teams tenant object." }, { "info": { "name": "List channels", "type": "http" }, "http": { "method": "GET", "url": "https://api.knock.app/v1/providers/ms-teams/:channel_id/channels", "params": [ { "name": "channel_id", "value": "", "type": "path", "description": "The ID of the Knock Microsoft Teams channel to get channels for." }, { "name": "ms_teams_tenant_object", "value": "{\"collection\":\"projects\",\"object_id\":\"project_123\"}", "type": "query", "description": "A JSON encoded string containing the Microsoft Teams tenant object reference." }, { "name": "team_id", "value": "", "type": "query", "description": "Microsoft Teams team ID." }, { "name": "query_options.$filter", "value": "displayName eq 'General'", "type": "query", "description": "[OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed to the Microsoft Graph API to filter channels." }, { "name": "query_options.$select", "value": "id,displayName,description", "type": "query", "description": "[OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed to the Microsoft Graph API to select specific properties." } ] }, "docs": "List the Microsoft Teams channels within a team. By default, archived and private channels are excluded from the results." }, { "info": { "name": "List teams", "type": "http" }, "http": { "method": "GET", "url": "https://api.knock.app/v1/providers/ms-teams/:channel_id/teams", "params": [ { "name": "channel_id", "value": "", "type": "path", "description": "The ID of the Knock Microsoft Teams channel to get teams for." }, { "name": "ms_teams_tenant_object", "value": "{\"collection\":\"projects\",\"object_id\":\"project_123\"}", "type": "query", "description": "A JSON encoded string containing the Microsoft Teams tenant object reference." }, { "name": "query_options.$filter", "value": "displayName eq 'My Team'", "type": "query", "description": "[OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed to the Microsoft Graph API to filter teams." }, { "name": "query_options.$select", "value": "id,displayName,description", "type": "query", "description": "[OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed to the Microsoft Graph API to select fields on a team." }, { "name": "query_options.$top", "value": "10", "type": "query", "description": "[OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed to the Microsoft Graph API to limit the number of teams returned." }, { "name": "query_options.$skiptoken", "value": "", "type": "query", "description": "[OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed to the Microsoft Graph API to retrieve the next page of results." } ] }, "docs": "Get a list of teams belonging to the Microsoft Entra tenant. By default, archived and private channels are excluded from the results." }, { "info": { "name": "Revoke access", "type": "http" }, "http": { "method": "PUT", "url": "https://api.knock.app/v1/providers/ms-teams/:channel_id/revoke_access", "params": [ { "name": "channel_id", "value": "", "type": "path", "description": "The ID of the Knock Microsoft Teams channel to revoke access for." }, { "name": "ms_teams_tenant_object", "value": "{\"collection\":\"projects\",\"object_id\":\"project_123\"}", "type": "query", "description": "A JSON encoded string containing the Microsoft Teams tenant object reference." } ] }, "docs": "Remove a Microsoft Entra tenant ID from a Microsoft Teams tenant object." } ] } ], "bundled": true }