Microsoft Teams

App Vendor: Microsoft Teams

App Category: Messaging

Connector Version: 1.2.3

API Version: 1.0.0

About App

Microsoft Teams is a business communication platform from Microsoft. The Microsoft Teams app enables security analysts to send messages and monitor the messaging activity of the users.

The Microsoft Teams app is configured with the Orchestrate application to perform the following actions:

Action Name	Description
Send Message	This action sends a message.
Send Message to Chat	This action sends a message to a chat.
Get Teams	This action retrieves the IDs of all teams.
Get Channels for Team	This action retrieves all the channels of a team.
List Channel Messages	This action retrieves all the messages from a channel.
Get Channel Delta	This action retrieves messages from a channel. This action also retrieves a Nextlink or Deltalink to paginate data (Nextlink) or to retrieve data updated from the last call (Deltalink).
Get Results from Nextlink	This action retrieves an object from a Nextlink or Deltalink object to enable pagination and delta queries.
Get Message Replies	This action retrieves all replies from a message.
Get Chats	This action retrieves all chat IDs of a user.
Get Messages from Chat	This action retrieves all the messages from a chat.
Search Channels by Name	This action searches for channels by the channel name.
Search Teams by Name	This action searches for teams by the team name.
Generic Action	This is a generic action to perform any additional use case on Microsoft Teams.

Administrative units permissions

Delegated permissions

Permission	Display String	Description	Admin Consent Required	Microsoft Account supported
AdministrativeUnit.Read.All	Read administrative units	Allows the app to read administrative units and administrative unit membership on behalf of the signed-in user.	Yes	No
AdministrativeUnit.ReadWrite.All	Read and write administrative units	Allows the app to create, read, update, and delete administrative units and manage administrative unit membership on behalf of the signed-in user.	Yes	No

Application permissions

Permission	Display String	Description	Admin Consent Required
AdministrativeUnit.Read.All	Read all administrative units	Allows the app to read administrative units and administrative unit membership without a signed-in user.	Yes
AdministrativeUnit.ReadWrite.All	Read and write all administrative units	Allows the app to create, read, update, and delete administrative units and manage administrative unit membership without a signed-in user.	Yes

Access reviews permissions

Delegated permissions

Permission	Display String	Description	Admin Consent Required	Microsoft Account supported
AccessReview.Read.All	Read all access reviews	Allows the app to read access reviews on behalf of the signed-in user.	Yes	No
AccessReview.ReadWrite.All	Manage all access reviews	Allows the app to read and write access reviews on behalf of the signed-in user.	Yes	No
AccessReview.ReadWrite.Membership	Manage access reviews for group and app memberships	Allows the app to read and write access reviews of groups and apps on behalf of the signed-in user.	Yes	No

Application permissions

Permission	Display String	Description	Admin Consent Required
AccessReview.Read.All	Read all access reviews	Allows the app to read access reviews without a signed-in user.	Yes
AccessReview.ReadWrite.All	AccessReview.ReadWrite.All	Allows the app to read, update, delete and perform actions on access reviews, reviewers, decisions and settings in the organization, without a signed-in user.	Yes
AccessReview.ReadWrite.Membership	Manage access reviews for group and app memberships	Allows the app to manage access reviews of groups and apps without a signed-in user.	Yes

Configuration Parameters

The following configuration parameters are required for the Microsoft Teams app to communicate with the Microsoft Teams enterprise application. The parameters can be configured by creating instances in the app.

Parameter	Description	Field Type	Required/Optional	Comments
Username	Enter the username of a user. Example: "john@cyware.com"	Text	Required
Password	Enter the password.	Password	Required
Client ID	Enter the application ID. Example: "8m7r499d-6a45-4c99-b4d8-e4a6b99979b"	Text	Required	You can retrieve the client ID from the app registration portal.
Client Secret	Enter the client secret key.	Password	Required	You can retrieve the client secret key from the app registration portal.
Tenant ID	Enter the Azure Active Directory tenant ID. Example: "421c85c3-3791-4b2d-5dd6-6fa64bc1b232"	Text	Required	Allowed formats: GUID Domain name
Timeout	Enter the timeout value in seconds. This is the number of seconds requests will wait to connect with the Microsoft Teams app.	Integer	Optional	Available range: 15 - 120 seconds Default range: 15 seconds
Verify	Choose your preference to verify SSL while making requests. It is recommended to set this option to yes. If no is passed, it may result in an incorrect connection establishment, potentially resulting in a broken connection.	Boolean	Optional	Default value: true Allowed values: true false

Action: Send Message

This action sends a message.

Scope

The following is the permission required for the Application:

Teamwork.Migrate.All

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Message	Enter the message to be sent. Example: "Hello world!"	Text	Required
Is HTML	Specify if the message is in HTML format or not. Example: true	Boolean	Required	Allowed values: true false
Team ID	Enter the team ID. Example: "0efcc002-6001-4a21-991b-8ba10bac0613"	Text	Required	You can retrieve the team ID of a team by using the Get Teams action.
Channel ID	Enter the channel ID. Example: "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2"	Text	Required	You can retrieve the channel ID of a channel by using the Get Channels of a Team action.

Example Request

[
    {
        "message": "sample message",
        "is_html": true,
        "team_id": "0efcc002-6001-4a21-991b-8ba10bac0613",
        "channel_id": "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2"
    }
]

Action Response Parameters

Parameter	Type	Description
app_instance.id	String	The unique identifier of the message. Example: "1616991851162"
app_instance.replyToId	Null	The identifier of the message to which this message is a reply, if applicable.
app_instance.etag	String	The entity tag of the message. Example: "1616991851162"
app_instance.messageType	String	The type of message. Example: "message"
app_instance.createdDateTime	String	The date and time when the message was created. Example: "2021-03-29T04:24:11.162Z"
app_instance.lastModifiedDateTime	String	The date and time when the message was last modified. Example: "2021-03-29T04:24:11.162Z"
app_instance.lastEditedDateTime	Null	The date and time when the message was last edited, if applicable.
app_instance.deletedDateTime	Null	The date and time when the message was deleted, if applicable.
app_instance.subject	Null	The subject of the message, if applicable.
app_instance.summary	Null	The summary of the message, if applicable.
app_instance.chatId	Null	The unique identifier of the chat associated with the message, if applicable. Example: null
app_instance.importance	String	The importance level of the message. Example: "normal"
app_instance.locale	String	The locale of the message. Example: "en-us"
app_instance.webUrl	String	The URL of the message in the web client.
app_instance.policyViolation	Null	Information about any policy violation associated with the message, if applicable.
app_instance.eventDetail	Null	Details of any event associated with the message, if applicable.
app_instance.from	Object	Information about the sender of the message. Example: {"application": null, "device": null, "user": {...}}
app_instance.body	Object	The body of the message.
app_instance.channelIdentity	Object	Information about the channel in which the message was sent.
app_instance.attachments	Array	An array containing information about any attachments included in the message.
app_instance.mentions	Array	An array containing information about any mentions in the message.
app_instance.reactions	Array	An array containing information about any reactions to the message.
app_instance.messageHistory	Array	An array containing information about the message history.

Action: Send Message to Chat

This action sends a message to a chat.

Scope

The following are the permissions required for the Application:

ChatMessage.Send, Chat.ReadWrite

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Message

Enter the message to be sent.

Example:

"Hello world!"

Text

Required

Is HTML

Specify if the message is in HTML format or not.

Example:

true

Boolean

Required

Allowed values:

true
false

Chat ID

Enter the chat ID.

Example:

"19:d0f51aeb0e8e43d0befb24be72b09ea7@thread.v2"

Text

Required

You can retrieve the chat ID of a chat by using the Get Chats action.

Example Request

[
    {
        "message": "sample message",
        "is_html": true,
        "chat_id": "19:d0f51aeb0e8e43d0befb24be72b09ea7@thread.v2"
    }
]

Action Response Parameters

Parameter	Field Type	Description
app_instance.id	String	The unique identifier of the message. Example: "1616991851162"
app_instance.replyToId	Null	The identifier of the message to which this message is a reply, if applicable.
app_instance.etag	String	The entity tag of the message. Example: "1616991851162"
app_instance.messageType	String	The type of message. Example: "message"
app_instance.createdDateTime	String	The date and time when the message was created. Example: "2021-03-29T04:24:11.162Z"
app_instance.lastModifiedDateTime	String	The date and time when the message was last modified. Example: "2021-03-29T04:24:11.162Z"
app_instance.lastEditedDateTime	Null	The date and time when the message was last edited, if applicable.
app_instance.deletedDateTime	Null	The date and time when the message was deleted, if applicable.
app_instance.subject	Null	The subject of the message, if applicable.
app_instance.summary	Null	The summary of the message, if applicable.
app_instance.chatId	Null	The unique identifier of the chat associated with the message, if applicable.
app_instance.importance	String	The importance level of the message. Example: "normal"
app_instance.locale	String	The locale of the message. Example: "en-us"
app_instance.webUrl	String	The URL of the message in the web client.
app_instance.policyViolation	Null	Information about any policy violation associated with the message, if applicable. Example: null
app_instance.eventDetail	Null	Details of any event associated with the message, if applicable.
app_instance.from	Object	Information about the sender of the message. Example: {"application": null, "device": null, "user": {...}}
app_instance.body	Object	The body of the message.
app_instance.channelIdentity	Object	Information about the channel in which the message was sent.
app_instance.attachments	Array	An array containing information about any attachments included in the message.
app_instance.mentions	Array	An array containing information about any mentions in the message.
app_instance.reactions	Array	An array containing information about any reactions to the message.
app_instance.messageHistory	Array	An array containing information about the message history.

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

Parameter

Description

Field Type

Required/Optional

Comments

Limit

Enter a limit for pagination of the team IDs.

Example:

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: Get Channels for Team

This action retrieves all the channels of a team.

Scope

The following are the permissions required for the Application:

ChannelMember.Read.All, ChannelMember.ReadWrite.All

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Team ID	Enter the team ID to retrieve the channels. Example: "0efcc002-6001-4a21-991b-8ba10bac0613"	Text	Required	You can retrieve the team ID of a team by using the Get Teams action.
Membership Type	Enter the membership type to retrieve channels. Example: private shared	Text	Optional

Parameter

Description

Field Type

Required/Optional

Comments

Team ID

Enter the team ID to retrieve the channels.

Example:

"0efcc002-6001-4a21-991b-8ba10bac0613"

Text

Required

You can retrieve the team ID of a team by using the Get Teams action.

Membership Type

Enter the membership type to retrieve channels.

Example:

private
shared

Text

Optional

Example Request

[
    {
       "team_id":"0efcc002-6001-4a21-991b-8ba10bac0613",
       "membership_type":"private"
    }
]

Action Response Parameters

Parameter	Type	Response
{app_instance}	Object	This parameter indicates the ID of the app instance configured in Orchestrate from which the response is retrieved.
app_instance.id	String	Unique identifier for the item. Example: "19:561fbdbbfca848a484f0a6f00ce9dbbd@thread.tacv2"
app_instance.createdDateTime	Datetime	The date and time when the item was created. Example: "2020-05-27T19:22:25.692Z"
app_instance.displayName	String	The display name of the item. Example: "General"
app_instance.description	String	A brief description of the item. Example: "AutoTestTeam_20210311_150740.2550_fim3udfdjen9"
app_instance.membershipType	String	The type of membership for the item (e.g., standard). Example: "standard"

Action: List Channel Messages

This action retrieves all the messages from a channel.

Scope

The following are the permissions required for the Application:

ChannelMessage.Read.Group*, ChannelMessage.Read.All

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Team ID

Enter the team ID.

Example:

"0efcc002-6001-4a21-991b-8ba10bac0613"

Text

Required

You can retrieve the team ID of a team by using the Get Teams action.

Channel ID

Enter the channel ID.

Example:

"19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2"

Text

Required

You can retrieve the channel ID of a channel by using the Get Channels of a Team action.

Limit

Enter the number of messages to be retrieved.

Example:

Integer

Optional

Maximum value:

Example Request

[
    {
        "team_id": "0efcc002-6001-4a21-991b-8ba10bac0613",
        "channel_id": "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2",
        "limit": 10
    }
]

Action Response Parameters

Parameter	Type	Description
app_instance.@odata.context	String	The context URL of the response. Example: "https://graph.microsoft.com/v1.0/$metadata#teams('fbe2bf47-16c8-47cf-b4a5-4b9b187c508b')/channels('19%3A4a95f7d8db4c4e7fae857bcebe0623e6%40thread.tacv2')/messages"
app_instance.@odata.count	Number	The count of messages in the response. Example: 3
app_instance.@odata.nextLink	String	The URL to fetch the next page of messages, if available.
app_instance.value	Array	An array containing messages. Example: [{"id": "1616965872395", ... }, {"id": "1616963377068", ... }, {"id": "1616883610266", ... }]
app_instance.value.id	String	The unique identifier of the message. Example: "1616965872395"
app_instance.value.replyToId	Null	The unique identifier of the message being replied to, if any. Example: null
app_instance.value.etag	String	The entity tag used for optimistic concurrency control. Example: "1616965872395"
app_instance.value.messageType	String	The type of the message. Example: "message"
app_instance.value.createdDateTime	String	The date and time when the message was created. Example: "2021-03-28T21:11:12.395Z"
app_instance.value.lastModifiedDateTime	String	The date and time when the message was last modified. Example: "2021-03-28T21:11:12.395Z"
app_instance.value.lastEditedDateTime	Null	The date and time when the message was last edited, if applicable. Example: null
app_instance.value.deletedDateTime	Null	The date and time when the message was deleted, if applicable. Example: null
app_instance.value.subject	String	The subject of the message, if any.
app_instance.value.summary	Null	A summary of the message content, if any. Example: null
app_instance.value.chatId	String	The unique identifier of the chat associated with the message, if applicable. Example: null
app_instance.value.importance	String	The importance level of the message. Example: "normal"
app_instance.value.locale	String	The locale of the message. Example: "en-us"
app_instance.value.webUrl	String	The URL of the message in the web client.
app_instance.value.policyViolation	Null	Information about any policy violation associated with the message, if applicable. Example: null
app_instance.value.eventDetail	Object	Details of any event associated with the message.
app_instance.value.from	Object	Information about the sender of the message.
app_instance.value.body	Object	The body of the message
app_instance.value.channelIdentity	Object	Information about the channel in which the message was sent. Example: {"teamId": "fbe2bf47-16c8-47cf-b4a5-4b9b187c508b", "channelId": "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2"}
app_instance.value.attachments	Array	An array containing information about any attachments included in the message. Example: []
app_instance.value.mentions	Array	An array containing information about any mentions in the message. Example: [{"id": 0, "mentionText": "Jane Smith", "mentioned": {"application": null, "device": null, "conversation": null, "user": {"id": "ef1c916a-3135-4417-ba27-8eb7bd084193", "displayName": "Jane Smith", "userIdentityType": "aadUser"}}}]
app_instance.value.reactions	Array	An array containing information about any reactions to the message.
app_instance.value.messageHistory	Array	An array containing information about the message history.

Action: Get Channel Delta

This action retrieves messages from a channel. This action also retrieves a Nextlink or Deltalink to paginate data (Nextlink) or to retrieve data updated from the last call (Deltalink).

Scope

The following are the permissions required for the Application:

ChannelMessage.Read.Group*, ChannelMessage.Read.All

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Team ID

Enter the team ID.

Example:

"0efcc002-6001-4a21-991b-8ba10bac0613"

Text

Required

You can retrieve the team ID of a team by using the Get Teams action.

Channel ID

Enter the channel ID.

Example:

"19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2"

Text

Required

You can retrieve the channel ID of a channel by using the Get Channels of a Team action.

Limit

Enter the number of messages to be retrieved.

Example:

Integer

Required

Maximum value:

Example Request

[
    {
        "team_id": "0efcc002-6001-4a21-991b-8ba10bac0613",
        "channel_id": "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2",
        "limit": 10
    }
]

Action: Get Results from Nextlink

This action retrieves an object from a Nextlink or Deltalink object to enable pagination and delta queries.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Nextlink	Enter the Nextlink or Deltalink to retrieve data from. Example: "https://graph.microsoft.com/beta/users/test@conteso.on microsoft.com/mailfolders('aqmbxxz3ngu3awq2lxm0mxxx xgq4ny04m2ixltgwnwflmjzjndzlmgauaaadc4vdeduv6uqke hs83_ixxxxx2sk7ayuvke6eoq6cxxfipaaaagemaaaa')/messages /delta$deltatoken=lztfwwjo5iivxxxxxxaefppquq0uwa2bclcih2v mkaczs14hfsgsvdaxwwjzi3ywzx81aj2blczqnxxny4defceijlhiig9q gftyc4ei.j8xvglai6ys6bcrbn2999_zwsxxvocafdf5qlj4ofsdx"	Text	Required

Parameter

Description

Field Type

Required/Optional

Comments

Nextlink

Enter the Nextlink or Deltalink to retrieve data from.

Example:

"https://graph.microsoft.com/beta/users/test@conteso.on microsoft.com/mailfolders('aqmbxxz3ngu3awq2lxm0mxxx xgq4ny04m2ixltgwnwflmjzjndzlmgauaaadc4vdeduv6uqke

hs83_ixxxxx2sk7ayuvke6eoq6cxxfipaaaagemaaaa')/messages /delta$deltatoken=lztfwwjo5iivxxxxxxaefppquq0uwa2bclcih2v mkaczs14hfsgsvdaxwwjzi3ywzx81aj2blczqnxxny4defceijlhiig9q gftyc4ei.j8xvglai6ys6bcrbn2999_zwsxxvocafdf5qlj4ofsdx"

Text

Required

Example Request

[
    {
        "next_link": "https://graph.microsoft.com/beta/users/test@conteso.on
                microsoft.com/mailfolders('aqmbxxz3ngu3awq2lxm0mxxx
                xgq4ny04m2ixltgwnwflmjzjndzlmgauaaadc4vdeduv6uqke
                hs83_ixxxxx2sk7ayuvke6eoq6cxxfipaaaagemaaaa')/messages
                /delta$deltatoken=lztfwwjo5iivxxxxxxaefppquq0uwa2bclcih2v
                mkaczs14hfsgsvdaxwwjzi3ywzx81aj2blczqnxxny4defceijlhiig9q
                gftyc4ei.j8xvglai6ys6bcrbn2999_zwsxxvocafdf5qlj4ofsdx"
    }
]

Action: Get Message Replies

This action retrieves all replies from a message.

Scope

The following are the permissions required for the Application:

Mail.ReadBasic.All , Mail.Read, Mail.ReadWrite

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Team ID	Enter the team ID. Example: "0efcc002-6001-4a21-991b-8ba10bac0613"	Text	Required	You can retrieve the team ID of a team by using the Get Teams action.
Channel ID	Enter the channel ID. Example: "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2"	Text	Required	You can retrieve the channel ID of a channel by using the Get Channels of a Team action.
Message ID	Enter the message ID. Example: "1612289992105"	Text	Required	You can retrieve the message ID of a message by using the Get Channel Messages action.
Limit	Enter the number of messages to be retrieved. Example: 10	Integer	Required	Maximum value: 50

Example Request

[
    {
        "team_id": "0efcc002-6001-4a21-991b-8ba10bac0613",
        "channel_id": "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2",
        "message_id": "1612289992105"
        "limit": 10
    }
]

Action Response Parameters

Parameter	Type	Desc
{app_instance}	Object	This parameter indicates the ID of the app instance configured in Orchestrate from which the response is retrieved.
app_instance.id	String	The unique identifier of the message. Example: 1614618259349
app_instance.replyToId	Null	The unique identifier of the message being replied to, if any. Example: null
app_instance.etag	String	The entity tag used for optimistic concurrency control. Example: "1614618259349"
app_instance.messageType	String	The type of the message. Example: message
app_instance.createdDateTime	String	The date and time when the message was created. Example: "2021-03-01T17:04:19.349Z"
app_instance.lastModifiedDateTime	String	The date and time when the message was last modified. Example: "2021-03-01T17:04:19.349Z"
app_instance.lastEditedDateTime	Null	The date and time when the message was last edited, if applicable. Example: null
app_instance.deletedDateTime	Null	The date and time when the message was deleted, if applicable. Example: null
app_instance.subject	Null	The subject of the message, if any. Example: null
app_instance.summary	Null	A summary of the message content, if any. Example: null
app_instance.chatId	Null	The unique identifier of the chat associated with the message, if any. Example: null
app_instance.importance	String	The importance level of the message. Example: "normal"
app_instance.locale	String	The locale of the message. Example: "en-us"
app_instance.webUrl	String	The URL of the message in a web browser.
app_instance.policyViolation	Null	Information about any policy violation associated with the message, if applicable. Example: null
app_instance.eventDetail	Null	Details about any event associated with the message, if applicable. Example: null
app_instance.from	Object	Information about the sender of the message. Example: {"id": "8ea0e38b-efb3-4757-924a-5f94061cf8c2", "displayName": "Robin Kline", "userIdentityType": "aadUser", "tenantId": "e61ef81e-8bd8-476a-92e8-4a62f8426fca"}
app_instance.body	Object	The content of the message.
app_instance.channelIdentity	Object	Information about the channel in which the message was posted. Example: {"teamId": "fbe2bf47-16c8-47cf-b4a5-4b9b187c508b", "channelId": "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2"}
app_instance.attachments	Array	An array of attachments included in the message, if any.
app_instance.mentions	Array	An array of mentions in the message, if any.
app_instance.reactions	Array	An array of reactions to the message, if any.
app_instance.messageHistory	Array	An array of previous versions of the message, if any.

Action: Get Chats

This action retrieves all chat IDs of a user.

Scope

The following are the permissions required for the Application:

Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All

Action Input Parameters

This action does not require any input parameter.

Action: Get Messages from Chat

This action retrieves all the messages from a chat.

Scope

The following are the permissions required for the Application:

Chat.Read.All, Chat.ReadWrite.All

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Chat ID	Enter the chat ID. Example: "19:d0f51aeb0e8e43d0befb24be72b09ea7@thread.v2"	Text	Required	You can retrieve the chat ID of a team by using the Get Chats action.
Limit	Enter the number of messages to be retrieved. Example: 10	Integer	Required	Maximum value: 50

Parameter

Description

Field Type

Required/Optional

Comments

Chat ID

Enter the chat ID.

Example:

"19:d0f51aeb0e8e43d0befb24be72b09ea7@thread.v2"

Text

Required

You can retrieve the chat ID of a team by using the Get Chats action.

Limit

Enter the number of messages to be retrieved.

Example:

Integer

Required

Maximum value:

Example Request

[
    {
        "chat_id": "19:d0f51aeb0e8e43d0befb24be72b09ea7@thread.v2",
        "limit": 10
    }
]

Action Response Parameters

Parameter	Type	Description
app_instance.id	String	The unique identifier of the message. Example: "1614618259349"
app_instance.replyToId	Null	The unique identifier of the message being replied to, if any.
app_instance.etag	String	The entity tag used for optimistic concurrency control. Example: "1614618259349"
app_instance.messageType	String	The type of the message. Example: "message"
app_instance.createdDateTime	String	The date and time when the message was created. Example: "2021-03-01T17:04:19.349Z"
app_instance.lastModifiedDateTime	String	The date and time when the message was last modified. Example: "2021-03-01T17:04:19.349Z"
app_instance.lastEditedDateTime	Null	The date and time when the message was last edited, if applicable.
app_instance.deletedDateTime	Null	The date and time when the message was deleted, if applicable.
app_instance.subject	Null	The subject of the message, if any.
app_instance.summary	Null	A summary of the message content, if any.
app_instance.chatId	Null	The unique identifier of the chat associated with the message, if any. Example: null
app_instance.importance	String	The importance level of the message. Example: "normal"
app_instance.locale	String	The locale of the message. Example: "en-us"
app_instance.webUrl	String	The URL of the message in a web browser."
app_instance.policyViolation	Null	Information about any policy violation associated with the message, if applicable.
app_instance.eventDetail	Null	Details about any event associated with the message, if applicable.
app_instance.from	Object	Information about the sender of the message. Example: {"id": "8ea0e38b-efb3-4757-924a-5f94061cf8c2", "displayName": "Robin Kline", "userIdentityType": "aadUser", "tenantId": "e61ef81e-8bd8-476a-92e8-4a62f8426fca"}
app_instance.body	Object	The content of the message.
app_instance.channelIdentity	Object	Information about the channel in which the message was posted. Example: {"teamId": "fbe2bf47-16c8-47cf-b4a5-4b9b187c508b", "channelId": "19:4a95f7d8db4c4e7fae857bcebe0623e6@thread.tacv2"}
app_instance.attachments	Array	An array of attachments included in the message, if any.
app_instance.mentions	Array	An array of mentions in the message, if any.
app_instance.reactions	Array	An array of reactions to the message, if any.
app_instance.messageHistory	Array	An array of previous versions of the message, if any.

Action: Search Channels by Name

This action searches for channels by the channel name.

Scope

The following are the permissions required for the Application:

ChannelSettings.Read.Group*, ChannelSettings.ReadWrite.Group*, Channel.ReadBasic.All, ChannelSettings.Read.All, ChannelSettings.ReadWrite.All, Group.Read.All**, Group.ReadWrite.All**, Directory.Read.All**, Directory.ReadWrite.All**

Action Input Parameters

Parameter	Description	Field Type	Required/Optional	Comments
Display Name	Enter the channel name. Example: "IT Updates"	Text	Required	You can retrieve the display name of a channel by using the Get Channels of a Team action.
Team ID	Enter the team ID. Example: 1a23b123-12a1-12a1-ab12-abc12345abcd	Text	Required

Parameter

Description

Field Type

Required/Optional

Comments

Display Name

Enter the channel name.

Example:

"IT Updates"

Text

Required

You can retrieve the display name of a channel by using the Get Channels of a Team action.

Team ID

Enter the team ID.

Example:

1a23b123-12a1-12a1-ab12-abc12345abcd

Text

Required

Example Request

[
    {
        "display_name": "IT Updates"
    }
]

Action Response Parameters

Parameter	Type	Response
app_instance.value	Array	An array containing information about channel. Example: [{"id": "19:982abbfca323a582f0a6d00ae2deca@thread.tacv2", ... }]
app_instance.value.id	String	The unique identifier of the channel. Example: "19:982abbfca323a582f0a6d00ae2deca@thread.tacv2"
app_instance.value.createdDateTime	String	The date and time when the channel was created. Example: "2020-05-27T19:22:25.692Z"
app_instance.value.displayName	String	The display name of the channel. Example: "IT Updates"
app_instance.value.description	String	The description of the channel. Example: "This is a team for all IT-related updates."
app_instance.value.membershipType	String	The membership type of the channel. Example: "private"

Action: Search Teams by Name

This action searches for teams by the team name.

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
Display Name	Enter the team name. Example: "IT Support"	Text	Required	You can retrieve the display name of a team by using the Get Teams action.

Parameter

Description

Field Type

Required/Optional

Comments

Display Name

Enter the team name.

Example:

"IT Support"

Text

Required

You can retrieve the display name of a team by using the Get Teams action.

Example Request

[
    {
        "display_name": "IT Support"
    }
]

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: Generic Action

This is a generic action to perform any additional use case on Microsoft Teams.

Action Input Parameters

Parameter	Description	Field Type	Required/Optional
Method	Enter an HTTP method to initiate a request. Example: "GET" "POST"	Text	Required
Endpoint	Enter the endpoint to initiate a request. Example: 'v1.0/teams/{team_id}/channels'	Text	Required
Payload	Enter the payload to pass to the API. Example: $JSON[{"title": "send message"}]	Any	Optional

Parameter

Description

Field Type

Required/Optional

Comments

Method

Enter an HTTP method to initiate a request.

Example:

"GET"
"POST"

Text

Required

Endpoint

Enter the endpoint to initiate a request.

Example:

'v1.0/teams/{team_id}/channels'

Text

Required

Payload

Enter the payload to pass to the API.

Example:

$JSON[{"title": "send message"}]

Any

Optional

Example Request

[
    {
        "method":"GET",
        "endpoint":"v1.0/me/chats/",
        "payload":{"title": "send message"},
    }
]

Cyware Orchestrate

Microsoft Teams

About App

Administrative units permissions

Access reviews permissions

Configuration Parameters

Action: Send Message

Action: Send Message to Chat

Action: Get Teams

Action: Get Channels for Team

Action: List Channel Messages

Action: Get Channel Delta

Action: Get Results from Nextlink

Action: Get Message Replies

Action: Get Chats

Action: Get Messages from Chat

Action: Search Channels by Name

Action: Search Teams by Name

Action: Generic Action

Search results