Configuring MS Teams with ICI - Revision history

IDT-1 at 10:46, 26 May 2022

2022-05-26T10:46:43Z

IDT-1 at 10:43, 26 May 2022

2022-05-26T10:43:02Z

IDT-1 at 10:42, 26 May 2022

2022-05-26T10:42:13Z

IDT-1 at 10:40, 26 May 2022

2022-05-26T10:40:58Z

IDT-1 at 10:38, 26 May 2022

2022-05-26T10:38:32Z

IDT-1 at 10:37, 26 May 2022

2022-05-26T10:37:07Z

IDT-1 at 09:55, 26 May 2022

2022-05-26T09:55:14Z

IDT-1 at 09:54, 26 May 2022

2022-05-26T09:54:34Z

IDT-1 at 09:52, 26 May 2022

2022-05-26T09:52:54Z

IDT-1 at 09:51, 26 May 2022

2022-05-26T09:51:24Z

@@ Line 90: / Line 90: @@
 <li>(ICI UI) Redirect URI</li>
 </ol>
@@ Line 118: / Line 119: @@
 *You'll be asked to provide the following information:
 *#
-*#*'''Name'''. Enter the name for the application
+*##'''Name'''. Enter the name for the application
-*#*Select the '''Supported account types''' for your application. Select Accounts in this organizational directory only (ABC only - Single tenant).
+*##Select the '''Supported account types''' for your application. Select Accounts in this organizational directory only (ABC only - Single tenant).
-*#*For the '''Redirect URI'''
+*##For the '''Redirect URI'''    <ul style="margin-left: 80px;">
-*Select '''Web'''.
+<li>Select '''Web'''.</li>
-*Set the URL to (ICI UI Application URL)&nbsp;<br/> &nbsp;&nbsp; &nbsp;i.&nbsp;&nbsp; &nbsp;https://{{your-tenant-name}}.icertis.com <ol style="list-style-type:lower-roman;">
+<li>Set the URL to (ICI UI Application URL)&nbsp;</li>
-</ol>  </ul>
+</ul>  </ul>
-&nbsp;
+&nbsp;&nbsp; &nbsp;i.&nbsp;&nbsp; &nbsp;https://{{your-tenant-name}}.icertis.com<br/> &nbsp;
 b. Click on '''Register'''

@@ Line 90: / Line 90: @@
 <li>(ICI UI) Redirect URI</li>
 </ol>
@@ Line 121: / Line 122: @@
 *#*For the '''Redirect URI'''
 *Select '''Web'''.
-*Set the URL to (ICI UI Application URL)&nbsp;<br/> &nbsp;&nbsp; &nbsp;i.&nbsp;&nbsp; &nbsp;[https://<span%20class= https://{{your-tenant-name}}.icertis.com] <ol style="list-style-type:lower-roman;">
+*Set the URL to (ICI UI Application URL)&nbsp;<br/> &nbsp;&nbsp; &nbsp;i.&nbsp;&nbsp; &nbsp;https://{{your-tenant-name}}.icertis.com <ol style="list-style-type:lower-roman;">
 </ol>  </ul>

@@ Line 90: / Line 90: @@
 <li>(ICI UI) Redirect URI</li>
 </ol>
@@ Line 120: / Line 121: @@
 *#*For the '''Redirect URI'''
 *Select '''Web'''.
-*Set the URL to (ICI UI Application URL)&nbsp;<br/> &nbsp;&nbsp; &nbsp;i.&nbsp;&nbsp; &nbsp;https://{{your-tenant-name}}.icertis.com <ol style="list-style-type:lower-roman;">
+*Set the URL to (ICI UI Application URL)&nbsp;<br/> &nbsp;&nbsp; &nbsp;i.&nbsp;&nbsp; &nbsp;[https://<span%20class= https://{{your-tenant-name}}.icertis.com] <ol style="list-style-type:lower-roman;">
 </ol>  </ul>
 b. Click on '''Register'''
@@ Line 146: / Line 149: @@
 <li>Now select the following permission (''please find more information on usage of every API permission under ‘'''Section C.2'''’'')
 *Files.ReadWrite.All
-*User.Read  </li>
+*User.Read
-−
 #g. Copy and save the following information to a file:
 #*The '''Application (client) ID''' value. You'll use this value later as the ''Client ID'' when you register this Azure identity application with your bot.
-#*The '''Directory (tenant) ID''' value. You'll also use this value later as the ''Tenant ID'' to register this Azure identity application with your bot.  h. Click on '''Overview''' in the left panel. In the right panel on the top click on ‘Endpoints’ (We need to record/copy a few values for the next step: Bot channel Authentication mechanism '''Step F''')
+#*The '''Directory (tenant) ID''' value. You'll also use this value later as the ''Tenant ID'' to register this Azure identity application with your bot. h. Click on '''Overview''' in the left panel. In the right panel on the top click on ‘Endpoints’ (We need to record/copy a few values for the next step: Bot channel Authentication mechanism '''Step F''')
 #*Copy and record '''OAuth 2.0 authorization endpoint (v2)''' value.
-#*Copy and record '''OAuth 2.0 token endpoint (v2)''' value.  i. Click on '''Expose an API, '''copy the '''scope''' value that you have added. j. With respect to the newly created or modified ICI API app, you are required to share the following with Icertis (''to be able to enable ICI integration with Microsoft Teams'').
+#*Copy and record '''OAuth 2.0 token endpoint (v2)''' value. i. Click on '''Expose an API, '''copy the '''scope''' value that you have added. j. With respect to the newly created or modified ICI API app, you are required to share the following with Icertis (''to be able to enable ICI integration with Microsoft Teams'').
 #*Application ID (Client ID) '''[Copy value to E.4]'''
 #*Client Secret '''[Copy value to E.5]'''
@@ Line 158: / Line 160: @@
 #*OAuth 2.0 authorization endpoint (v2) '''[Copy value to E.7]'''
 #*OAuth 2.0 token endpoint (v2) '''[Copy value to E.8]'''
-#*Scope (defined under section B.3.i) '''[Copy value to E.6]'''
+#*Scope (defined under section B.3.i) '''[Copy value to E.6]'''    </li>
 == Azure Portal Configuration for Microsoft Teams App ==

@@ Line 90: / Line 90: @@
 <li>(ICI UI) Redirect URI</li>
 </ol>
 == Azure Portal Configuration for ICI API Application ==
@@ Line 119: / Line 120: @@
 *#*For the '''Redirect URI'''
 *Select '''Web'''.
-*Set the URL to (''ICI Application API URL'') <ol style="list-style-type:lower-roman;">
+*Set the URL to (ICI UI Application URL)&nbsp;<br/> &nbsp;&nbsp; &nbsp;i.&nbsp;&nbsp; &nbsp;https://{{your-tenant-name}}.icertis.com <ol style="list-style-type:lower-roman;">
 </ol>  </ul>
 b. Click on '''Register'''
@@ Line 149: / Line 148: @@
 *User.Read  </li>
+#g. Copy and save the following information to a file:
-g. Copy and save the following information to a file:
+#*The '''Application (client) ID''' value. You'll use this value later as the ''Client ID'' when you register this Azure identity application with your bot.
+#*The '''Directory (tenant) ID''' value. You'll also use this value later as the ''Tenant ID'' to register this Azure identity application with your bot.  h. Click on '''Overview''' in the left panel. In the right panel on the top click on ‘Endpoints’ (We need to record/copy a few values for the next step: Bot channel Authentication mechanism '''Step F''')
-*The '''Application (client) ID''' value. You'll use this value later as the ''Client ID'' when you register this Azure identity application with your bot.
+#*Copy and record '''OAuth 2.0 authorization endpoint (v2)''' value.
-*The '''Directory (tenant) ID''' value. You'll also use this value later as the ''Tenant ID'' to register this Azure identity application with your bot.
+#*Copy and record '''OAuth 2.0 token endpoint (v2)''' value.  i. Click on '''Expose an API, '''copy the '''scope''' value that you have added. j. With respect to the newly created or modified ICI API app, you are required to share the following with Icertis (''to be able to enable ICI integration with Microsoft Teams'').
+#*Application ID (Client ID) '''[Copy value to E.4]'''
-h. Click on '''Overview''' in the left panel. In the right panel on the top click on ‘Endpoints’ (We need to record/copy a few values for the next step: Bot channel Authentication mechanism '''Step F''')
+#*Client Secret '''[Copy value to E.5]'''
+#*(ICI API) Redirect URI
-*Copy and record '''OAuth 2.0 authorization endpoint (v2)''' value.
+#*OAuth 2.0 authorization endpoint (v2) '''[Copy value to E.7]'''
-*Copy and record '''OAuth 2.0 token endpoint (v2)''' value.
+#*OAuth 2.0 token endpoint (v2) '''[Copy value to E.8]'''
+#*Scope (defined under section B.3.i) '''[Copy value to E.6]'''
 i. Click on '''Expose an API, '''copy the '''scope''' value that you have added. j. With respect to the newly created or modified ICI API app, you are required to share the following with Icertis (''to be able to enable ICI integration with Microsoft Teams'').
-−
 *Application ID (Client ID) '''[Copy value to E.4]'''
 *Client Secret '''[Copy value to E.5]'''
 *(ICI API) Redirect URI
 *OAuth 2.0 authorization endpoint (v2) '''[Copy value to E.7]'''
 *OAuth 2.0 token endpoint (v2) '''[Copy value to E.8]'''
 *Scope (defined under section B.3.i) '''[Copy value to E.6]'''
 == Azure Portal Configuration for Microsoft Teams App ==

← Older revision		Revision as of 10:38, 26 May 2022
Line 7:		Line 7:

	With the help of the following sections, you can create/edit the ICI UI and API apps (App Registrations), add URL redirects, provide API permissions etc.		With the help of the following sections, you can create/edit the ICI UI and API apps (App Registrations), add URL redirects, provide API permissions etc.
		+

@@ Line 7: / Line 7: @@
 With the help of the following sections, you can create/edit the ICI UI and API apps (App Registrations), add URL redirects, provide API permissions etc.
 == Azure Portal Configuration for ICI UI Application ==
@@ Line 16: / Line 17: @@
 <li>In both the above scenarios the following details with respect to the newly created or modified app are required to be shared with Icertis (''to be able to enable ICI integration with Microsoft Teams'').</li>
 </ol>
+<ul style="margin-left: 80px;">
-*Directory ID (Tenant ID)
+<li>Directory ID (Tenant ID)</li>
-*Application ID (Client ID)
+<li>Application ID (Client ID)</li>
-*Client Secret
+<li>Client Secret</li>
-*(ICI UI) Redirect URI
+<li>(ICI UI) Redirect URI</li>
 '''2. ICI UI application (app registration) on Azure portal requires the following Microsoft Graph delegated API permission with Admin consent.'''
@@ Line 31: / Line 33: @@
 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;i.&nbsp;Provide the following information:&nbsp; &nbsp; &nbsp;&nbsp;
-#'''Name''': Enter the name for the application
+a.&nbsp;&nbsp; &nbsp;Select Web.
-#Select the '''Supported account types''' for your application. Select Accounts in this organizational directory only (ABC only - Single tenant).
-#For the '''Redirect URI:''' <ol style="list-style-type:lower-alpha;">
-</ol>  </ol>
-*Select '''Web'''.
+b.&nbsp;&nbsp; &nbsp;Set the URL to (ICI UI Application URL)&nbsp;<br/> &nbsp;&nbsp; &nbsp;i.&nbsp;&nbsp; &nbsp;[https://{{your-tenant-name}}.icertis.com https://{{your-tenant-name}}.icertis.com]
-*Set the URL to (''ICI UI Application URL'')
-−
 [https://{{your-tenant-name}}.icertis.com https://{{your-tenant-name}}.icertis.com]
 b. Click '''Register'''
@@ Line 62: / Line 63: @@
 <li>Now select the following permission (''please find more information on usage of every API permission under ‘'''Section B.2'''’'')</li>
 </ol>
+<ul style="margin-left: 40px;">
+<li>AppCatalog.Read.All</li>
-*#AppCatalog.Read.All
+<li>Channel.Create</li>
-*#Channel.Create
+<li>Files.ReadWrite.All</li>
-*#Files.ReadWrite.All
+<li>Group.ReadWrite.All</li>
-*#Group.ReadWrite.All
+<li>Team.Create</li>
-*#Team.Create
+<li>Team.ReadBasic.All</li>
-*#Team.ReadBasic.All
+<li>TeamMember.ReadWrite.All</li>
-*#TeamMember.ReadWrite.All
+<li>TeamsAppInstallation.ReadWriteForTeam</li>
-*#TeamsAppInstallation.ReadWriteForTeam
+<li>User.Read</li>
-*#User.Read
+<li>User.ReadBasic.All</li>
-*#User.ReadBasic.All
+</ul>
 f.&nbsp;Copy and save the following information to a file:
@@ Line 88: / Line 89: @@
 <li>(ICI UI) Redirect URI</li>
 </ol>
 == Azure Portal Configuration for ICI API Application ==

@@ Line 242: / Line 242: @@
 #Click ‘Set up a Bot’.
 #‘Icertis Teamworks’ application is ready for use.
 == Verification in ICI ==
 Once all the above configurations done. User should be able to see ‘Collaborate in Teams’ button on published Agreement instance.
+<div class="image-green-border">[[File:8.1 Teams 1.png|420px|8.1 Teams 1.png]]</div>
 [[File:8.1 Teams 1.png|420px|8.1 Teams 1.png]]
-−
 When user clicks on ‘Collaborate in Teams’ button, user should see Wizard to push/send information from ICI to MS teams.
+<div class="image-green-border">[[File:8.1 Teams 2.png|620px|8.1 Teams 2.png]]</div>
 [[File:8.1 Teams 2.png|620px|8.1 Teams 2.png]]
-−
 &nbsp;
 &nbsp;
 <div class="image-green-border">&nbsp;</div>

@@ Line 205: / Line 205: @@
 &nbsp;
 == Upload & Approval Process for new Icertis Teamworks app in Microsoft Teams admin center ==
@@ Line 213: / Line 214: @@
 '''a.&nbsp;'''The ‘'''Pending approval'''’ widget under the ‘Manage apps’ panel at the top of the page which lets the Microsoft Teams admin know when a custom app is submitted for approval
+<div class="image-green-border">[[File:8.1 Configure Teams 14.png|720px|8.1 Configure Teams 14.png]]</div>
 [[File:8.1 Configure Teams 14.png|720px|8.1 Configure Teams 14.png]]
-−
 b.&nbsp;Search for the app name as shown below that you want to approve. The app to be approved status would be ‘Blocked’ currently.
+<div class="image-green-border">[[File:8.1 Configure Teams 15.png|720px|8.1 Configure Teams 15.png]]</div>
 [[File:8.1 Configure Teams 15.png|720px|8.1 Configure Teams 15.png]]
-−
 c.&nbsp;Clicking the app link will take you to the app details page.
+<div class="image-green-border">[[File:8.1 Configure Teams 16.png|720px|8.1 Configure Teams 16.png]]</div> <div class="image-green-border">[[File:8.1 Configure Teams 17.PNG|720px|8.1 Configure Teams 17.PNG]]</div>
 [[File:8.1 Configure Teams 16.png|720px|8.1 Configure Teams 16.png]]
-−
 [[File:8.1 Configure Teams 17.PNG|720px|8.1 Configure Teams 17.PNG]]
-−
 d.&nbsp;On the ‘Icertis Teamworks’ app details page, click the ‘Publish’ button to approve the app.
+<div class="image-green-border">[[File:8.1 Configure Teams 18.PNG|720px|8.1 Configure Teams 18.PNG]]</div>
 [[File:8.1 Configure Teams 18.PNG|720px|8.1 Configure Teams 18.PNG]]
-−
 e.&nbsp;The ‘Icertis Teamworks’ app should now be visible under the ‘Build for your org’ under App section in ‘Microsoft Teams’
+<div class="image-green-border">[[File:8.1 Configure Teams 19.png|720px|8.1 Configure Teams 19.png]]</div>
 [[File:8.1 Configure Teams 19.png|720px|8.1 Configure Teams 19.png]]
 == Update an existing Icertis Teamworks app in Microsoft Teams admin center ==

@@ Line 39: / Line 39: @@
 *Select '''Web'''.
 *Set the URL to (''ICI UI Application URL'')
 [https://{{your-tenant-name}}.icertis.com https://{{your-tenant-name}}.icertis.com]
@@ Line 106: / Line 103: @@
 </ol>
-'''2.&nbsp;''''''ICI API application (app registration) on Azure portal requires the following Microsoft Graph delegated API permission with Admin consent.'''
+.&nbsp;'''ICI API application (app registration) on Azure portal requires the following Microsoft Graph delegated API permission with Admin consent.'''
 '''[[File:8.1 Configure Teams 4.PNG|620px|8.1 Configure Teams 4.PNG]]'''
@@ Line 112: / Line 109: @@
 '''3. Create a new ICI API Application: '''We need an identity provider that can be used for authentication of ICI API & ‘Icertis Teamworks’ (Microsoft Teams) app. For clients who are updating the existing ICI API app can skip points '''‘a’''' to '''‘d’''' and directly open the existing ICI API app on Azure portal and start with point '''‘e’.'''
-&nbsp;
+a.&nbsp;Go to ‘'''App Registrations'''’ under ‘'''Azure Active Directory'''’ on Azure portal and on the right panel, click ‘'''New registration’''' tab.
 *You'll be asked to provide the following information:
@@ Line 118: / Line 115: @@
 *#*'''Name'''. Enter the name for the application
 *#*Select the '''Supported account types''' for your application. Select Accounts in this organizational directory only (ABC only - Single tenant).
-*#*For the '''Redirect URI''' <ol style="list-style-type:lower-alpha;">
+*#*For the '''Redirect URI'''
-</ol>  </ul>  </ol>  <li>Select '''Web'''.</li>
+*Select '''Web'''.
-<li>Set the URL to (''ICI Application API URL'') <ol style="list-style-type:lower-roman;">
+*Set the URL to (''ICI Application API URL'') <ol style="list-style-type:lower-roman;">
 <li>'''Error! Hyperlink reference not valid.'''</li>
-</ol> </li>
+</ol>  </ul>
-<li>Click on '''Register'''</li>
-<li>Once it is created, Azure displays the '''Overview''' page for the app.</li>
+b. Click on '''Register'''
-<li>In the left panel, select Certificates & secrets to create a client secret for your application. <ol style="list-style-type:lower-roman;">
 <li>Under '''Client secrets''', select ➕ '''New client secret'''.</li>
 <li>Add a description to identify this secret from others.</li>
@@ Line 131: / Line 132: @@
 <li>Select '''Add'''.</li>
 <li>Before leaving this page, '''record the secret'''.</li>
-</ol> </li>
+</ol>
-<li>In the left panel, select ‘'''Authentication'''’ under ‘'''Manage'''’ <ol style="list-style-type:lower-roman;">
 <li>For the '''Redirect URI''', click ‘'''Add URI'''’</li>
 <li>Add a new redirect URL i.e.,&nbsp; [https://token.botframework.com/.auth/web/redirect '''https://token.botframework.com/.auth/web/redirect'''] (''required to authenticate the Icertis Teamworks App'')</li>
 <li>Click on '''Save'''</li>
-</ol> </li>
+</ol>
-<li>In the left panel, select ‘API permissions’ to add certain delegated permission for your UI application. <ol style="list-style-type:lower-roman;">
 <li>Click ‘Add a permission’.</li>
 <li>Under ‘Microsoft APIs’ select ‘Microsoft Graph’.</li>
@@ Line 144: / Line 149: @@
 *Files.ReadWrite.All
 *User.Read  </li>
 &nbsp;
-#Copy and save the following information to a file: <ol style="list-style-type:lower-roman;">
+g. Copy and save the following information to a file:
-</ol>  </ol>
 *The '''Application (client) ID''' value. You'll use this value later as the ''Client ID'' when you register this Azure identity application with your bot.
 *The '''Directory (tenant) ID''' value. You'll also use this value later as the ''Tenant ID'' to register this Azure identity application with your bot.
-&nbsp;
+h. Click on '''Overview''' in the left panel. In the right panel on the top click on ‘Endpoints’ (We need to record/copy a few values for the next step: Bot channel Authentication mechanism '''Step F''')
 *Application ID (Client ID) '''[Copy value to E.4]'''
@@ Line 207: / Line 210: @@
 [[File:8.1 Configure Teams 5.PNG|620px|8.1 Configure Teams 5.PNG]]
 == Upload & Approval Process for new Icertis Teamworks app in Microsoft Teams admin center ==