.. _auto_microsoft_teams_worker:

*MICROSOFT TEAMS*
=================

Connects to Microsoft Teams via the Microsoft Graph API using either app-only (Client Credentials) or delegated (Access Token) OAuth 2.0 authentication. Supports listing teams, channels, chats, and members, as well as sending and reading channel and chat messages. Use this worker to automate Teams notifications, retrieve organizational chat data, or integrate Teams messaging into d3VIEW workflows.

When to use
-----------

Tagged: ``azure_ad``, ``channels``, ``chats``, ``client_credentials``, ``delegated_auth``, ``entra``, ``graph_api``, ``integration``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Authentication Mode
     - auth_mode
     - select
     - client_credentials
     - ✓
     - Authentication strategy: select 'client_credentials' for app-only auth (tenant ID, client ID, and secret auto-acquire a token; cannot send messages) or 'access_token' for delegated auth (supply a pre-obtained user token; required for send operations). Defaults to 'client_credentials'.
   * - Azure Tenant ID
     - tenant_id
     - text
     - —
     - 
     - Azure AD (Entra) tenant ID (GUID string, e.g. 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'); required only when auth_mode is 'client_credentials', leave blank for Access Token mode.
   * - Application (Client) ID
     - client_id
     - text
     - —
     - 
     - Azure AD app registration Application (Client) ID (GUID string); required only when auth_mode is 'client_credentials', leave blank for Access Token mode.
   * - Client Secret
     - client_secret
     - text
     - —
     - 
     - Azure AD app registration client secret value (plain-text string); required only when auth_mode is 'client_credentials', leave blank for Access Token mode — treat this value as a credential and do not expose it in logs.
   * - Access Token
     - access_token
     - textarea
     - —
     - 
     - Pre-obtained OAuth 2.0 bearer token with the necessary delegated Microsoft Graph permissions (plain-text JWT string); required only when auth_mode is 'access_token', leave blank for Client Credentials mode.
   * - Operation
     - operation
     - select
     - list_teams
     - ✓
     - Teams Graph API operation to execute: 'list_teams', 'list_channels', 'send_channel_message', 'list_channel_messages', 'list_chats', 'send_chat_message', 'list_chat_messages', or 'list_team_members'; defaults to 'list_teams'. Note that 'send_channel_message', 'send_chat_message', and 'list_chats' require delegated auth.
   * - Team ID
     - team_id
     - text
     - —
     - 
     - Microsoft Teams team ID (GUID string); required for operations 'list_channels', 'send_channel_message', 'list_channel_messages', and 'list_team_members' — leave blank for team-agnostic operations.
   * - Channel ID
     - channel_id
     - text
     - —
     - 
     - Teams channel ID (string); required for operations 'send_channel_message' and 'list_channel_messages' — leave blank for all other operations.
   * - Chat ID
     - chat_id
     - text
     - —
     - 
     - Teams chat thread ID (string); required for operations 'send_chat_message' and 'list_chat_messages' — leave blank for all other operations.
   * - Message
     - message
     - textarea
     - —
     - 
     - Plain-text or HTML message body to post; required for operations 'send_channel_message' and 'send_chat_message' — leave blank for read/list operations.
   * - Max Results
     - max_results
     - number
     - 50
     - 
     - Maximum number of items to return for list operations (integer, 1–999); defaults to 50 — ignored for send operations.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - Status
     - status
     - text
     - Human-readable operation outcome string, e.g. 'Success: list_teams completed successfully.' or an error description if the operation failed.
   * - Results
     - results
     - dataset
     - Structured dataset (array of associative arrays) containing the parsed Graph API response records — e.g. team objects, channel objects, message objects, or member objects depending on the operation performed.
   * - Raw Response
     - raw_response
     - json
     - Full JSON payload returned by the Microsoft Graph API, useful for debugging or accessing fields not surfaced in the 'results' dataset.

Disciplines
-----------

- platform.integration
- platform.notification

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>platform</code> schema. Worker id: <code>microsoft_teams_worker</code>. Schema hash: <code>e8e04a64de3b</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>