AUTTO integrates with the Microsoft (MS) Graph API, a unified programmability model for accessing data in Microsoft 365. AUTTO does this through calls defined in the AUTTO API Manager and the Get Data and Send Data actions.
NOTE: Familiarity with web applications development may be needed when working with APIs.
Table of Contents
- Prerequisites
- Integration Requirements
- Sample Usage
- Using a POST API Call in a Send Data Action
- Related Articles
Prerequisites
Access to API Manager Integrations, including Microsoft Graph API, is limited to AUTTO customers on the Business, Corporate and Enterprise Plans. If you need access to Microsoft Graph, and the other external applications that integrate with AUTTO, contact us.
To fully utilize this feature, you should be familiar with the AUTTO API, including the AUTTO API Manager. For more information, see Getting Started with the AUTTO API and Using the AUTTO API Manager.
Ideally, you should also be familiar with the MS Graph API. To go to the MS Graph API page on the Microsoft website, click here.
Integration Requirements
Before you can integrate AUTTO and Microsoft Graph API, you need to do the following:
- Add a user with administrative rights to your Microsoft Cloud accounts as an Admin in your AUTTO account. For more information, see Managing Admins and Managers in AUTTO.
- Create a new API Manager Integration with Microsoft Graph. For more information, see API Manager Integrations.
- Navigate to Main Menu > Integrations > API Manager Integrations, then scroll down and click Microsoft Graph.
- Enter a name, then a scope, e.g., Application.Read.All, for the connection. You can enter multiple scopes. For more information, see Microsoft's scope (or permissions) reference page here.
- Click Connect and complete the Microsoft authentication process.
- Within the API Manager, when creating a new connection under the Integrations page, you will now be able to select the connection under the name you specified above. For more information, see Using the AUTTO API Manager.
Sample Usage
While AUTTO integrates with the entire MS Graph API, in terms of specific use cases during workflow creation, you can use this feature to, among others:
- Send messages, including attachments, to users or channels in MS Teams.
- Automate creation of a workflow user in Azure Active Directory (AD); and
- Automate the addition of a workflow user to an Azure AD Group.
Send Messages and Files to Users in MS Teams
After registering and getting an API key for AUTTO, you can start creating a POST API call to send a message and files to specific users in MS Teams.
NOTE: This API call will send an MS Graph API chatMessage resource type to a specific MS Teams user. For more information on the chatMessage resource type, click here.
To create the API call:
- On your AUTTO Dashboard, click the Main Menu, then API Manager.
- On the API Manager, click the New API POST Call button to display the fields for defining the API call.
- Enter a name for the API call, then a description. You can use any name for now, but it is recommended that the API call be more descriptive to avoid any confusion when you start creating more calls.
- Click the API URL button, then enter https://graph.microsoft.com/v1.0/chats/{chats-id}/messages as the API URL.
- Under the Query Parameters section, enter chats-id as a parameter. You may also enter an optional description for the parameter.
- Under the Integrations section, toggle the switch to enable Integrations for API Manager.
- Select the Microsoft connection you have created from the list.
- Click Payload Map, then add the following:
- A String data type, with body as the Payload property.
- A File data type, with attachments as the Payload property.
- Click Done.
Send Messages and Files to Channels in MS Teams
You can also create a POST API call that will send a message and file to specific channels in MS Teams.
This API call will send an MS Graph API chatMessage resource type to a specific MS Teams channel. For more information on the chatMessage resource type, click here.
To create the API call:
- On your Dashboard, click the Main Menu, then API Manager.
- On the API Manager, click the New API POST Call button to display the fields for defining the API call.
- Enter a name for the API call, then a description. You can use any name for now, but it is recommended that the API call be more descriptive to avoid any confusion when you start creating more calls.
- Click the API URL button, then enter https://graph.microsoft.com/v1.0/teams/{team-id}/channels/{channel-id}/messages as the API URL.
- Under the Query Parameters section, enter team-id and channel-id as parameter names. You may also enter optional descriptions for these parameters.
- Under the Integrations section, toggle the switch to enable Integrations for API Manager.
- From the dropdown menu, select the Microsoft connection you have created.
- Click Payload Map, then add the following:
- A String data type, with body as the Payload property.
- A File data type, with attachments as the Payload property.
- Click Done.
Automate User Creation in Azure AD
This API call will add a member to a security or Microsoft 365 group through the MS Graph API's members navigation property. For more information, click here.
To create the API call:
- On your Dashboard, click the Main Menu, then API Manager.
- On the API Manager, click the New API POST Call button to display the fields for defining the API call.
- Enter a name for the API call, then a description. You can use any name for now, but it is recommended that the API call be more descriptive to avoid any confusion when you start creating more calls.
- Click the API URL button, then enter https://graph.microsoft.com/v1.0/users as the API URL.
- Under the Integrations section, toggle the switch to enable Integrations for API Manager.
- Select the Microsoft connection you have created from the list.
- Click Payload Map, then add xxx.
- Click Done.
Automate Addition of a User to an Azure AD Group
This API call will create a new user. The request body contains the user to create. At a minimum, you must specify the required properties for the user. For more information, click here.
To create the API call:
- On your Dashboard, click the Main Menu, then API Manager.
- On the API Manager, click the New API POST Call button to display the fields for defining the API call.
- Enter a name for the API call, then a description. You can use any name for now, but it is recommended that the API call be more descriptive to avoid any confusion when you start creating more calls.
- Click the API URL button, then enter https://graph.microsoft.com/v1.0/groups/{group-id}/members/$ref as the API URL.
- Under the Query Parameters section, enter team-id and channel-id as parameter names. You may also enter optional descriptions for these parameters.
- Under the Integrations section, toggle the switch to enable Integrations for API Manager.
- Select the Microsoft connection you have created from the list.
- Click Payload Map, then add xxx.
- Click Done.
Using a POST API Call in a Send Data Action
You will need to use a Send Data action to post to MS Teams and update information in Azure AD. For more information, see Send Data Action.
To set up a Send Data action:
- Drag a Send Data action to the canvas of the Workflow Editor, then connect it to the previous action in the workflow.
- Position your cursor over the action, then click the Edit icon when it appears.
- On the Action Editor, select the appropriate API call from the list.
- Under the Parameters section, select the square brackets for the parameters that will be sent to the API.
- Under the Response section, enter the name/s for the square bracket/s to which the response data will be saved.
NOTE: The Response section always contains an API Success Yes/No output that will return either Yes or No depending on whether the API connection succeeded in sending data or not. You are required to provide a name for the square bracket to which this message will be saved. Depending on your requirements, you can then add a Condition action that will allow your users to take the workflow into different paths based on this output. For more information, see Condition Action.
- Under the Payload section, enter the name/s for the square bracket/s which will be sent to the external system.
- Click the x button on the top-left to save your changes and close the Action Editor.
Comments
0 comments
Article is closed for comments.