Microsoft Teams Component

Manage the teams, groups, channels, and messages associated with your Microsoft Teams account
Component key: ms-teams#
DescriptionMicrosoft Teams is a business communication platform developed by Microsoft, as part of the Microsoft 365 family of products. This component allows you to easily manage teams, groups, channels, and messages inside of your Microsoft Teams account.
#
Microsoft Teams Connections#
OAuth 2.0The Microsoft Teams component authenticates requests through the Microsoft Graph API. To configure OAuth 2.0 you must first create an application through Active Directory in the Microsoft Azure Portal.
When creating the application you will be prompted to select the 'Supported account types'. Under this section, be sure to select 'Accounts in any organizational directory (Any Azure AD directory - Multitenant)'. You will need to go to "Platforms" and add the "Web" platform. In that section you should add Prismatic's OAuth 2.0 callback URL - https://oauth2.prismatic.io/callback - as a Redirect URI.
Next, go to "Certificates & Secrets" for the app and add a new Client Secret. Note this value as you will need to supply it to the connection within Prismatic.
You will also need the Application (client) ID from the "Overview" page.
The last step of configuring the "App Registration" is assigning "App Permissions". Click "Add Permission", select all permissions that are required for your desired integration and save these values for later. A full list of scopes can be found on the Microsoft Graph API documentation
Next, supply the following values to the OAuth 2.0 connection in your integration within Prismatic:
- For Client ID and Client Secret enter the values that you got from the Microsoft Azure Portal.
- Provide the Scopes you assigned to your Azure application permissions.
- If you didn't select Multitenant when creating the Azure application, you will need to replace the Authorize URL and Token URL with ones specific to your tenant.
For more information regarding authenticating against the Microsoft Graph API refer to the Microsoft documentation.
Input | Default | Notes | Example |
---|---|---|---|
Input Authorize URL string / Required | Default | Notes The OAuth 2.0 Authorization URL for Microsoft Teams | Example https://login.microsoftonline.com/common/oauth2/authorize |
Input Client ID string / Required | Default | Notes Generate at https://dev.teams.microsoft.com/home | Example |
Input Client Secret password / Required | Default | Notes Generate at https://dev.teams.microsoft.com/home | Example |
Input Scopes string | Default https://graph.microsoft.com/Team.ReadBasic.All https://graph.microsoft.com/Team.Create https://graph.microsoft.com/Group.ReadWrite.All https://graph.microsoft.com/TeamMember.ReadWrite.All https://graph.microsoft.com/ChannelMessage.Read.All offline_access | Notes Microsoft Teams permission scopes are set on the OAuth application | Example |
Input Token URL string / Required | Default | Notes The OAuth 2.0 Token URL for Microsoft Teams | Example https://login.microsoftonline.com/common/oauth2/v2.0/token |
#
Triggers#
WebhookTrigger for handling webhooks from Microsoft Teams | key: webhook
You can configure a Microsoft Teams outgoing webhook to send information to a Prismatic webhook URL under certain conditions (a "Team" is created, a "User" is added to a team, etc.).
For more information on configuring webhooks refer to the Microsoft Graph API Docs
Additionally, you can reference a trigger's results.webhookUrls to create a webhook in a deploy-triggered flow. That'll configure webhooks to point to an instance when that instance is deployed to a customer.
#
Output Example Payload{ "response": { "statusCode": 200, "contentType": "application/json" }, "payload": { "headers": { "accept": "*/*", "Content-Type": "application/json", "Host": "hooks.example.prismatic.io" }, "body": { "data": {} }, "rawBody": { "data": { "type": "Buffer", "data": [69, 120, 97, 109, 112, 108, 101] } }, "queryParameters": None, "webhookUrls": { "Flow 1": "https://hooks.example.prismatic.io/trigger/EXAMPLEGbG93Q29uZmlnOmRlNmNmNDMyLTliNWMtN0005NDMxLTRmYzA4ZjViODgxOA==" }, "webhookApiKeys": { "Flow 1": ["abc-123"] }, "customer": { "externalId": "customer-example-external-id", "name": "John Doe" } }}
#
Actions#
Add Group MemberAdd a member to an existing group | key: addGroupMember
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Group string / Required | Notes Provide a string value for the group Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
Input User Id string / Required | Notes Provide a string value for the Id of the user. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
#
Add Group OwnerAdd an owner (admin) to an existing group | key: addGroupOwner
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Group string / Required | Notes Provide a string value for the group Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
Input User Id string / Required | Notes Provide a string value for the Id of the user. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
#
Add Tab To ChannelCreate a new channel tab | key: addTabToChannel
Input | Notes | Example |
---|---|---|
Input Channel Id string / Required | Notes Provide a string value for the channel Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Connection connection / Required | Notes | Example |
Input Content Url string / Required | Notes Url used for rendering tab contents in Teams. | Example https://www.contoso.com/Orders/2DCA2E6C7A10415CAF6B8AB6661B3154/tabView |
Input Display Name string / Required | Notes Provide a string value for the display name of the resource. | Example My Group |
Input Entity Id string | Notes Identifier for the entity hosted by the tab provider. | Example 2DCA2E6C7A10415CAF6B8AB6661B3154 |
Input Remove Url string | Notes Url called by Teams client when a Tab is removed using the Teams Client. | Example https://www.example.com/Orders/2DCA2E6C7A10415CAF6B8AB6661B3154/uninstallTab |
Input Team string / Required | Notes Provide an identifier of the given team. This value can either be an Id or a displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Teams App URL string | Notes The application that is linked to the tab. This cannot be changed after tab creation. | Example https://graph.microsoft.com/v1.0/appCatalogs/teamsApps/06805b9e-77e3-4b93-ac81-525eb87513b8 |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
Input Website Url string | Notes Url for showing tab contents outside of Teams. | Example https://www.example.com/Orders/2DCA2E6C7A10415CAF6B8AB6661B3154 |
#
Add Team MemberAdd a new member to the team | key: addMember
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Roles string Value List | Notes For each item, provide a string value containing a role you would like to assign the user. | Example owner |
Input Team string / Required | Notes Provide an identifier of the given team. This value can either be an Id or a displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
Input User Id string / Required | Notes Provide a string value for the Id of the user. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
#
Output Example Payload{ "data": { "odata.type": "#microsoft.graph.aadUserConversationMember", "id": "4e99g7eaf-68dd-43oT-ae3f", "roles": [ "owner" ], "displayName": "example", "userId": "4e99g7eaf-68dd-43oT-ae3f", "email": "someone@example.com", "tenantId": "4e99g7eaf-68dd-43oT-ae3f" }}
#
Archive TeamArchive the specified team | key: archiveTeam
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Team string / Required | Notes Provide an identifier of the given team. This value can either be an Id or a displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
#
Create ChannelCreate a channel inside a team | key: createChannel
Input | Default | Notes | Example |
---|---|---|---|
Input Channel Description string / Required | Default | Notes Provide a string value for the channel description. | Example This is an example description |
Input Channel Name string / Required | Default | Notes Provide a string value for the channel name. | Example myChannel |
Input Connection connection / Required | Default | Notes | Example |
Input Membership Type string / Required | Default | Notes The type of the channel. Can be set during creation and can't be changed. Possible values are: standard - Channel inherits the list of members of the parent team; private - Channel can have members that are a subset of all the members on the parent team. | Example |
Input Team string / Required | Default | Notes Provide an identifier of the given team. This value can either be an Id or a displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Default | Notes The maximum time a client will await a response | Example 3000 |
Input Visibility string / Required | Default public | Notes The visibility of the group and team. Defaults to Public. | Example |
#
Create GroupCreate a new group | key: createGroup
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Description string | Default | Notes Provide a string value for the description. | Example This is an example description |
Input Display Name string / Required | Default | Notes Provide a string value for the display name of the resource. | Example My Group |
Input Security Enabled string / Required | Default | Notes Determines if security will be enabled on the group. | Example |
Input Timeout string | Default | Notes The maximum time a client will await a response | Example 3000 |
#
Create TeamCreate a new team | key: createTeam
Input | Default | Notes | Example |
---|---|---|---|
Input Allow users to create/update channels boolean | Default false | Notes This flag will give users the permission to create/update channels. | Example |
Input Allow Giphy boolean | Default false | Notes This flag will enable the use of Giphy content in your team. | Example |
Input Allow users to delete messages boolean | Default false | Notes This flag will give users the permission to delete messages. | Example |
Input Allow users to edit messages boolean | Default false | Notes This flag will give users the permission to edit messages. | Example |
Input Channel Description string / Required | Default | Notes Provide a string value for the channel description. | Example This is an example description |
Input Channel Name string / Required | Default | Notes Provide a string value for the channel name. | Example myChannel |
Input Connection connection / Required | Default | Notes | Example |
Input Giphy Content Rating string | Default | Notes | Example |
Input Team Description string / Required | Default | Notes Provide a string value for the description. | Example This is an example description. |
Input Team Name string / Required | Default | Notes Provide a string value for the team name. | Example myTeam |
Input Timeout string | Default | Notes The maximum time a client will await a response | Example 3000 |
Input Visibility string / Required | Default public | Notes The visibility of the group and team. Defaults to Public. | Example |
#
Create WebhookCreate a new webhook | key: createWebhook
Input | Notes | Example |
---|---|---|
Input Change Type string / Required | Notes Provide a comma separated list of changes you want to listen for. | Example created/updated |
Input Expiration Date Time string | Notes Provide a valid date time for the expiration of the webhook. | Example 2021-10-21T14:55:45.0000000Z |
Input Notification URL string / Required | Notes Provide a valid URL representing where you want the request to be directed to. | Example https://hooks.prismatic.io/EXAMPLE |
Input Resource string | Notes Provide a string value for the type of resource you want to listen to. | Example /teams/getAllMessages |
#
Delete ChannelDelete the information and metadata of a given channel | key: deleteChannel
Input | Notes | Example |
---|---|---|
Input Channel Id string / Required | Notes Provide a string value for the channel Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Connection connection / Required | Notes | Example |
Input Team string / Required | Notes Provide an identifier of the given team. This value can either be an Id or a displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
#
Delete Channel TabDelete the information and metadata of channel tab | key: deleteChannelTab
Input | Notes | Example |
---|---|---|
Input Channel Id string / Required | Notes Provide a string value for the channel Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Connection connection / Required | Notes | Example |
Input Tab string / Required | Notes Provide the identifier of a channel tab. This value can either be an id, displayName, or webUrl | Example 794f0e4e-4d10-4bb5-9079-3a465a629eff |
Input Team string / Required | Notes Provide an identifier of the given team. This value can either be an Id or a displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
#
Delete GroupDelete the information and metadata of a given group | key: deleteGroup
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Group string / Required | Notes Provide a string value for the group Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
#
Delete UserDelete the information and metadata of an existing user | key: deleteUser
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
Input User Id string / Required | Notes Provide a string value for the Id of the user. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
#
Output Example Payload{ "data": { "businessPhones": [ "+1 555 555 5555" ], "displayName": "exampleUser", "givenName": "exampleUser", "jobTitle": "Retail Manager", "mail": "someoneV@example.onmicrosoft.com", "mobilePhone": "+1 555 555 5555", "officeLocation": "example", "preferredLanguage": "en-US", "surname": "Example", "id": "3693-4789-a1c3-f4de565f" }}
#
Get ChannelRetrieve the information and metadata of a given channel | key: getChannel
Input | Notes | Example |
---|---|---|
Input Channel Id string / Required | Notes Provide a string value for the channel Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Connection connection / Required | Notes | Example |
Input Team string / Required | Notes Provide an identifier of the given team. This value can either be an Id or a displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
#
Get Channel TabGet the information and metadata of channel tab | key: getChannelTab
Input | Notes | Example |
---|---|---|
Input Channel Id string / Required | Notes Provide a string value for the channel Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Connection connection / Required | Notes | Example |
Input Tab string / Required | Notes Provide the identifier of a channel tab. This value can either be an id, displayName, or webUrl | Example 794f0e4e-4d10-4bb5-9079-3a465a629eff |
Input Team string / Required | Notes Provide an identifier of the given team. This value can either be an Id or a displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
#
Get Current UserGet the information and metadata of the user that is currently logged in | key: getCurrentUser
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
#
Output Example Payload{ "data": { "businessPhones": [ "+1 555 555 5555" ], "displayName": "exampleUser", "givenName": "exampleUser", "jobTitle": "Retail Manager", "mail": "someoneV@example.onmicrosoft.com", "mobilePhone": "+1 555 555 5555", "officeLocation": "example", "preferredLanguage": "en-US", "surname": "Example", "id": "3693-4789-a1c3-f4de565f" }}
#
Get GroupGet the information and metadata of a given group | key: getGroup
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Group string / Required | Notes Provide a string value for the group Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
#
Output Example Payload{ "data": { "id": "91fgs950-1256r434490-387xd606", "creationOptions": [ "team" ], "description": "example", "displayName": "example", "expirationDateTime": "", "groupTypes": [ "unified" ], "isAssignableToRole": "true", "mail": "someone@example.com", "mailEnables": true, "mailNickname": "someone@example.com", "theme": "" }}
#
Get Group MemberGet the information and metadata of an existing group member | key: getGroupMember
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Group string / Required | Notes Provide a string value for the group Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Member string / Required | Notes Provide the identifier of a given member. This value can either be a memberId, email, userId, or displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
#
Get MemberGet information or metadata about a team member | key: getMember
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Member string / Required | Notes Provide the identifier of a given member. This value can either be a memberId, email, userId, or displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Team string / Required | Notes Provide an identifier of the given team. This value can either be an Id or a displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
#
Output Example Payload{ "data": { "odata.type": "#microsoft.graph.aadUserConversationMember", "id": "4e99g7eaf-68dd-43oT-ae3f", "roles": [ "owner" ], "displayName": "example", "userId": "4e99g7eaf-68dd-43oT-ae3f", "email": "someone@example.com", "tenantId": "4e99g7eaf-68dd-43oT-ae3f" }}
#
Get TeamGet information or metadata of a team | key: getTeam
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Team string / Required | Notes Provide an identifier of the given team. This value can either be an Id or a displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
#
Get UserGet the information and metadata of an existing user | key: getUser
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
Input User Id string / Required | Notes Provide a string value for the Id of the user. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
#
Output Example Payload{ "data": { "businessPhones": [ "+1 555 555 5555" ], "displayName": "exampleUser", "givenName": "exampleUser", "jobTitle": "Retail Manager", "mail": "someoneV@example.onmicrosoft.com", "mobilePhone": "+1 555 555 5555", "officeLocation": "example", "preferredLanguage": "en-US", "surname": "Example", "id": "3693-4789-a1c3-f4de565f" }}
#
List Channel MessagesList all of the messages in a given channel | key: listChannelMessages
Input | Notes | Example |
---|---|---|
Input Channel Id string / Required | Notes Provide a string value for the channel Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Connection connection / Required | Notes | Example |
Input Filter string | Notes Filters results (rows), uses the OData V4 query language. | Example startswith(givenName,'J') |
Input Order By string | Notes Order results (rows), uses the OData V4 query language. | Example displayName desc |
Input Search string | Notes Returns results based on search criteria. | Example Search For This |
Input Select string | Notes Filters properties (columns), uses the OData V4 query language. | Example givenName,surname |
Input Page Offset string | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Team string / Required | Notes Provide an identifier of the given team. This value can either be an Id or a displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
Input Top string | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
#
Output Example Payload{ "data": { "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('id')/channels('id')/messages", "@odata.count": "1", "value": [ { "id": "6525322568857", "replyToId": "665253225688577", "etag": "111111", "messageType": "message", "createdDateTime": "2022-05-13T05:26:08.857Z", "lastModifiedDateTime": "2022-05-13T05:26:08.857Z", "lastEditedDateTime": "2022-05-13T05:26:08.857Z", "deletedDateTime": "2022-05-13T05:26:08.857Z", "subject": "example", "summary": "example", "chatId": "", "importance": "normal", "locale": "en-us", "webUrl": "https://teams.microsoft.com/l/message/example", "eventDetail": "", "from": { "application": "example", "device": "example", "user": { "id": "6525322568857", "displayName": "example", "userIdentityType": "aadUser" }, "body": { "contentType": "text", "content": "Hello World" } } } ] }}
#
List Channel TabsList all of the tabs in a given channel | key: listChannelTabs
Input | Notes | Example |
---|---|---|
Input Channel Id string / Required | Notes Provide a string value for the channel Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Connection connection / Required | Notes | Example |
Input Filter string | Notes Filters results (rows), uses the OData V4 query language. | Example startswith(givenName,'J') |
Input Order By string | Notes Order results (rows), uses the OData V4 query language. | Example displayName desc |
Input Search string | Notes Returns results based on search criteria. | Example Search For This |
Input Select string | Notes Filters properties (columns), uses the OData V4 query language. | Example givenName,surname |
Input Page Offset string | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Team string / Required | Notes Provide an identifier of the given team. This value can either be an Id or a displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
Input Top string | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
#
Output Example Payload{ "data": { "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('id')/channels('id')/tabs", "@odata.count": "1", "value": [ { "id": "6525322568857", "displayName": "example", "webUrl": "https://teams.microsoft.com/l/tabs/example", "configuration": { "entityId": "12345678", "contentUrl": "https://teams.microsoft.com/l/example", "removeUrl": "https://teams.microsoft.com/l/example", "websiteUrl": "https://teams.microsoft.com/l/example", "hasContent": true } } ] }}
#
List ChannelsRetrieve the list of channels in a given team | key: listChannels
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Filter string | Notes Filters results (rows), uses the OData V4 query language. | Example startswith(givenName,'J') |
Input Order By string | Notes Order results (rows), uses the OData V4 query language. | Example displayName desc |
Input Search string | Notes Returns results based on search criteria. | Example Search For This |
Input Select string | Notes Filters properties (columns), uses the OData V4 query language. | Example givenName,surname |
Input Page Offset string | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Team string / Required | Notes Provide an identifier of the given team. This value can either be an Id or a displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
Input Top string | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
#
Output Example Payload{ "data": { "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('id')/channels", "@odata.count": "1", "value": [ { "id": "19:Qm7ZZyj4FQ-TZJMWDJYIKML19X", "createdDateTime": "2022-05-11T05:24:49.127Z", "displayName": "General", "isFavoriteByDefault": false, "email": "someone@example.com", "webUrl": "https://teams.microsoft.com/l/channel/example-id", "membershipType": "standard" } ] }}
#
List Current User's TeamsList all teams containing the user that is currently logged in | key: ListCurrentUsersTeams
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Filter string | Notes Filters results (rows), uses the OData V4 query language. | Example startswith(givenName,'J') |
Input Order By string | Notes Order results (rows), uses the OData V4 query language. | Example displayName desc |
Input Search string | Notes Returns results based on search criteria. | Example Search For This |
Input Select string | Notes Filters properties (columns), uses the OData V4 query language. | Example givenName,surname |
Input Page Offset string | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
Input Top string | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
#
List Group MembersList all members in a group | key: listGroupMembers
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Filter string | Notes Filters results (rows), uses the OData V4 query language. | Example startswith(givenName,'J') |
Input Group string / Required | Notes Provide a string value for the group Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Order By string | Notes Order results (rows), uses the OData V4 query language. | Example displayName desc |
Input Search string | Notes Returns results based on search criteria. | Example Search For This |
Input Select string | Notes Filters properties (columns), uses the OData V4 query language. | Example givenName,surname |
Input Page Offset string | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
Input Top string | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
#
Output Example Payload{ "data": { "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryObjects", "value": [ { "businessPhones": [ "+1 555 555 5555" ], "displayName": "exampleUser", "givenName": "exampleUser", "jobTitle": "Retail Manager", "mail": "someoneV@example.onmicrosoft.com", "mobilePhone": "+1 555 555 5555", "officeLocation": "example", "preferredLanguage": "en-US", "surname": "Example", "id": "3693-4789-a1c3-f4de565f" } ] }}
#
List Group OwnersList all owners of a group | key: listGroupOwners
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Filter string | Notes Filters results (rows), uses the OData V4 query language. | Example startswith(givenName,'J') |
Input Group string / Required | Notes Provide a string value for the group Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Order By string | Notes Order results (rows), uses the OData V4 query language. | Example displayName desc |
Input Search string | Notes Returns results based on search criteria. | Example Search For This |
Input Select string | Notes Filters properties (columns), uses the OData V4 query language. | Example givenName,surname |
Input Page Offset string | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
Input Top string | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
#
Output Example Payload{ "data": { "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryObjects", "value": [ { "businessPhones": [ "+1 555 555 5555" ], "displayName": "exampleUser", "givenName": "exampleUser", "jobTitle": "Retail Manager", "mail": "someoneV@example.onmicrosoft.com", "mobilePhone": "+1 555 555 5555", "officeLocation": "example", "preferredLanguage": "en-US", "surname": "Example", "id": "3693-4789-a1c3-f4de565f" } ] }}
#
List Group PlansReturns a list of all plans contained in a group | key: listGroupPlans
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Filter string | Notes Filters results (rows), uses the OData V4 query language. | Example startswith(givenName,'J') |
Input Group string / Required | Notes Provide a string value for the group Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Order By string | Notes Order results (rows), uses the OData V4 query language. | Example displayName desc |
Input Search string | Notes Returns results based on search criteria. | Example Search For This |
Input Select string | Notes Filters properties (columns), uses the OData V4 query language. | Example givenName,surname |
Input Page Offset string | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
Input Top string | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
#
List GroupsList the groups associated with your account | key: listGroups
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Filter string | Notes Filters results (rows), uses the OData V4 query language. | Example startswith(givenName,'J') |
Input Order By string | Notes Order results (rows), uses the OData V4 query language. | Example displayName desc |
Input Search string | Notes Returns results based on search criteria. | Example Search For This |
Input Select string | Notes Filters properties (columns), uses the OData V4 query language. | Example givenName,surname |
Input Page Offset string | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
Input Top string | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
#
Output Example Payload{ "data": { "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups", "value": [ { "id": "91fgs950-1256r434490-387xd606", "creationOptions": [ "team" ], "description": "example", "displayName": "example", "expirationDateTime": "", "groupTypes": [ "unified" ], "isAssignableToRole": "true", "mail": "someone@example.com", "mailEnables": true, "mailNickname": "someone@example.com", "theme": "" } ] }}
#
List OneNote Notebooks by GroupReturns a list of all OneNote notebooks contained in a group | key: listGroupNotebooks
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Filter string | Notes Filters results (rows), uses the OData V4 query language. | Example startswith(givenName,'J') |
Input Group string / Required | Notes Provide a string value for the group Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Order By string | Notes Order results (rows), uses the OData V4 query language. | Example displayName desc |
Input Search string | Notes Returns results based on search criteria. | Example Search For This |
Input Select string | Notes Filters properties (columns), uses the OData V4 query language. | Example givenName,surname |
Input Page Offset string | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
Input Top string | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
#
List Team MembersList all the members in a team | key: listMembers
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Team string / Required | Notes Provide an identifier of the given team. This value can either be an Id or a displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
#
Output Example Payload{ "data": { "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams('id')/members", "@odata.count": 1, "value": [ { "odata.type": "#microsoft.graph.aadUserConversationMember", "id": "4e99g7eaf-68dd-43oT-ae3f", "roles": [ "owner" ], "displayName": "example", "userId": "4e99g7eaf-68dd-43oT-ae3f", "email": "someone@example.com", "tenantId": "4e99g7eaf-68dd-43oT-ae3f" } ] }}
#
List TeamsList the teams associated with your account | key: listTeams
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Filter string | Notes Filters results (rows), uses the OData V4 query language. | Example startswith(givenName,'J') |
Input Order By string | Notes Order results (rows), uses the OData V4 query language. | Example displayName desc |
Input Search string | Notes Returns results based on search criteria. | Example Search For This |
Input Select string | Notes Filters properties (columns), uses the OData V4 query language. | Example givenName,surname |
Input Page Offset string | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
Input Top string | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
#
Output Example Payload{ "data": { "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#teams", "@odata.count": 1, "value": [ { "id": "aa6fsa5ae-ed8e-4af1-aefs4-bce66f795ea5", "createdDateTime": "", "displayName": "Example Team", "description": "Example Description", "internalId": "aa6fsa5ae-ed8e-aefs4-bce66f795ea5", "summary": "Example Summary" } ] }}
#
List Teams AppsList apps from the Microsoft Teams app catalog | key: listTeamsApps
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Filter string | Notes Filters results (rows), uses the OData V4 query language. | Example startswith(givenName,'J') |
Input Order By string | Notes Order results (rows), uses the OData V4 query language. | Example displayName desc |
Input Search string | Notes Returns results based on search criteria. | Example Search For This |
Input Select string | Notes Filters properties (columns), uses the OData V4 query language. | Example givenName,surname |
Input Page Offset string | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Team string / Required | Notes Provide an identifier of the given team. This value can either be an Id or a displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
Input Top string | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
#
List User's TeamsList all teams containing the provided user | key: ListUsersTeams
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Filter string | Notes Filters results (rows), uses the OData V4 query language. | Example startswith(givenName,'J') |
Input Order By string | Notes Order results (rows), uses the OData V4 query language. | Example displayName desc |
Input Search string | Notes Returns results based on search criteria. | Example Search For This |
Input Select string | Notes Filters properties (columns), uses the OData V4 query language. | Example givenName,surname |
Input Page Offset string | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
Input Top string | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
Input User Id string / Required | Notes Provide a string value for the Id of the user. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
#
List UsersList all users | key: listUsers
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Filter string | Notes Filters results (rows), uses the OData V4 query language. | Example startswith(givenName,'J') |
Input Order By string | Notes Order results (rows), uses the OData V4 query language. | Example displayName desc |
Input Search string | Notes Returns results based on search criteria. | Example Search For This |
Input Select string | Notes Filters properties (columns), uses the OData V4 query language. | Example givenName,surname |
Input Page Offset string | Notes Provide an integer value for the page offset for the given object's results. | Example 3 |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
Input Top string | Notes Provide an integer value for the maximum amount of results that will be returned. Provide a value from 1 to 1000. | Example 20 |
#
Output Example Payload{ "data": { "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users", "value": [ { "businessPhones": [ "+1 555 555 5555" ], "displayName": "exampleUser", "givenName": "exampleUser", "jobTitle": "Retail Manager", "mail": "someoneV@example.onmicrosoft.com", "mobilePhone": "+1 555 555 5555", "officeLocation": "example", "preferredLanguage": "en-US", "surname": "Example", "id": "3693-4789-a1c3-f4de565f" } ] }}
#
Raw RequestIssue a raw HTTP request with the configured connection | key: rawRequest
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Data string | Default | Notes The HTTP body payload to send to the URL. Must be a string or a reference to output from a previous step. | Example {"exampleKey": "Example Data"} |
Input Debug Request boolean | Default false | Notes Enabling this flag will log out the current request. | Example |
Input File Data string Key Value List | Default | Notes File Data to be sent as a multipart form upload. | Example [{key: "example.txt", value: "My File Contents"}] |
Input Form Data string Key Value List | Default | Notes The Form Data to be sent as a multipart form upload. | Example [{"key": "Example Key", "value": new Buffer("Hello World")}] |
Input Header string Key Value List | Default | Notes A list of headers to send with the request. | Example User-Agent: curl/7.64.1 |
Input Max Retry Count string | Default 0 | Notes The maximum number of retries to attempt. | Example |
Input Method string | Default | Notes | Example |
Input Query Parameter string Key Value List | Default | Notes A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | Example |
Input Response Type string | Default json | Notes The type of data you expect in the response. You can request json, text, or binary data. | Example binary |
Input Retry Delay (ms) string | Default 0 | Notes The delay in milliseconds between retries. | Example |
Input Retry On All Errors boolean | Default false | Notes If true, retries on all erroneous responses regardless of type. | Example |
Input Timeout string | Default | Notes The maximum time that a client will await a response to its request | Example 2000 |
Input URL string / Required | Default | Notes This is the URL to call. | Example /sobjects/Account |
Input Use Exponential Backoff boolean | Default false | Notes Specifies whether to use a pre-defined exponential backoff strategy for retries. | Example |
#
Remove Group MemberRemove an existing member from a group | key: removeGroupMember
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Group string / Required | Notes Provide a string value for the group Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Member string / Required | Notes Provide the identifier of a given member. This value can either be a memberId, email, userId, or displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
#
Remove Group OwnerRemove an existing owner from a group | key: removeGroupOwner
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Group string / Required | Notes Provide a string value for the group Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Owner Id string / Required | Notes Provide the identifier of a given member. This value can either be a memberId, email, userId, or displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
#
Remove Team MemberRemove a user from a provided team | key: removeMember
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Member string / Required | Notes Provide the identifier of a given member. This value can either be a memberId, email, userId, or displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Team string / Required | Notes Provide an identifier of the given team. This value can either be an Id or a displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
#
Send Message To ChannelSend a message to a given channel | key: sendChannelMessage
Input | Default | Notes | Example |
---|---|---|---|
Input Channel Id string / Required | Default | Notes Provide a string value for the channel Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Connection connection / Required | Default | Notes | Example |
Input Content Type string | Default text | Notes Provide a value for the content type of the message | Example |
Input Message string / Required | Default | Notes Provide a string value for the message to send. | Example Hello World! |
Input Team string / Required | Default | Notes Provide an identifier of the given team. This value can either be an Id or a displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Default | Notes The maximum time a client will await a response | Example 3000 |
#
Update ChannelUpdate an existing channel inside a team | key: updateChannel
Input | Default | Notes | Example |
---|---|---|---|
Input Channel Description string | Default | Notes Provide a string value for the channel description. | Example This is an example description |
Input Channel Id string / Required | Default | Notes Provide a string value for the channel Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Channel Name string | Default | Notes Provide a string value for the channel name. | Example myChannel |
Input Connection connection / Required | Default | Notes | Example |
Input Team string / Required | Default | Notes Provide an identifier of the given team. This value can either be an Id or a displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Default | Notes The maximum time a client will await a response | Example 3000 |
Input Visibility string | Default public | Notes The visibility of the group and team. Defaults to Public. | Example |
#
Update Channel TabUpdate an existing channel tab | key: updateChannelTab
Input | Notes | Example |
---|---|---|
Input Channel Id string / Required | Notes Provide a string value for the channel Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Connection connection / Required | Notes | Example |
Input Display Name string | Notes Provide a string value for the display name of the resource. | Example My Group |
Input Fields string Key Value List | Notes Optional fields to include in the request body | Example |
Input Tab string / Required | Notes Provide the identifier of a channel tab. This value can either be an id, displayName, or webUrl | Example 794f0e4e-4d10-4bb5-9079-3a465a629eff |
Input Team string / Required | Notes Provide an identifier of the given team. This value can either be an Id or a displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Timeout string | Notes The maximum time a client will await a response | Example 3000 |
#
Update GroupUpdate the information and metadata of an existing group | key: updateGroup
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Description string | Default | Notes Provide a string value for the description. | Example This is an example description |
Input Display Name string / Required | Default | Notes Provide a string value for the display name of the resource. | Example My Group |
Input Fields string Key Value List | Default | Notes Optional fields to include in the request body | Example |
Input Group string / Required | Default | Notes Provide a string value for the group Id | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Security Enabled string / Required | Default | Notes Determines if security will be enabled on the group. | Example |
Input Timeout string | Default | Notes The maximum time a client will await a response | Example 3000 |
#
Update TeamUpdate an existing team | key: updateTeam
Input | Default | Notes | Example |
---|---|---|---|
Input Allow users to create/update channels boolean | Default false | Notes This flag will give users the permission to create/update channels. | Example |
Input Allow Giphy boolean | Default false | Notes This flag will enable the use of Giphy content in your team. | Example |
Input Allow users to delete messages boolean | Default false | Notes This flag will give users the permission to delete messages. | Example |
Input Allow users to edit messages boolean | Default false | Notes This flag will give users the permission to edit messages. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Giphy Content Rating string | Default | Notes | Example |
Input Team Description string | Default | Notes Provide a string value for the description. | Example This is an example description. |
Input Team string / Required | Default | Notes Provide an identifier of the given team. This value can either be an Id or a displayName. | Example 37635f8e-82d1-example-8ba4-af6e8985427f |
Input Team Name string | Default | Notes Provide a string value for the team name. | Example myTeam |
Input Timeout string | Default | Notes The maximum time a client will await a response | Example 3000 |
Input Visibility string / Required | Default public | Notes The visibility of the group and team. Defaults to Public. | Example |