Microsoft ToDo
In this article
Supported Version: Cloud
About OAuth 2.0
OAuth 2.0 lets users access instance resources through external clients by obtaining a token rather than by entering login credentials with each resource request.
You must have the security_admin role to manage the OAuth integration.
API Rate Limit: No limit
Setting up OAuth 2.0 application in ToDo
Follow the below steps to register an OAuth 2.0 application on Microsoft ToDo using your account.
- Login into Azure Account using https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade
- Click on “New registration” and enter following details:
- Name : User Friendly Name of OAuth 2.0 App, like “KleraToDoApplication”
- Click on the Submit button.
- On the new page, copy and save followings:
- Application ID : This will be our Client Id
- Go to “Certificates & Secretes” & click on “New client secret”. Enter description and choose validity period. Copy the string generated by the system under column “Value”. This is our Client Secret ID.
- Go to “Authentication” and add a redirect URL under the “Redirect URIs” section.
- Choose Type -> Web
- Redirect URI -> Redirect URL of Gathr Analytics machine. Sample redirect URI would be https://<HostName.DomainName>:48444/AccountManagementWebService/callback.html
- Go to API Permissions and click on “Add a permission”. Under Microsoft-> Delegated permissions choose followings:
- Tasks.ReadWrite
- Go to “Expose an API” and click on Add a scope. Now add following scopes with their user friendly description:
- Offline_access
- Select Azure Active Directory.
- Select Properties.
- Then, scroll down to the Tenant ID field. Your tenant ID will be in the box. Save this tenant Id as we’ll be needing it to create Authorization URL and Access Token URL.
Important:
- This URL should be accessible from the client machine. Machine from where the user is logged into Gathr Analytics.
- Need to add port 48444 in Firewall/Security systems whitelist.
- You will need additional permissions from the Microsoft Azure Administrator or from IT department to register an application.
- Please make sure your Microsoft Todo Connector instance must be accessible from the Gathr Analytics Machine.
Steps to configure connection of Microsoft ToDo connector on Gathr Analytics:
- Right click on Connector » Connections » Configure.
- Enter Instance URL : https://graph.microsoft.com
- Application Key: Client Id generated from the azure app
- Application Secret : Client secret Id generated from azure app.
- Authorization URL : https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/authorize
- Access Token URL : https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token
- Domain for Callback Authentication : Enter HostName with Domain Name of the Gathr Analytics Machine Example: HostName-123.Kleramachine.com
Scope:
- Create New Account and give a user-friendly account Name like : Microsoft ToDo Account.
- Click Save.
- On clicking ‘Save’, a pop-up will appear which requires ToDo user to login using the credentials asked in the pop-up window.
Important: Please make sure, the pop-up is not blocked by the chrome browser.
If you have any feedback on Gathr documentation, please email us!