Skip to content

Commit fcc4595

Browse files
committed
Deploy preview for PR 700 🛫
1 parent 1f8a2bf commit fcc4595

File tree

3 files changed

+38
-28
lines changed

3 files changed

+38
-28
lines changed

‎pr-preview/pr-700/deploying/integration-requests/index.html‎

Lines changed: 37 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -996,7 +996,7 @@
996996

997997
<h1>Integration Requests</h1>
998998

999-
<p>Integration requests streamline your deployment process by automatically associating the necessary OAuth integrations with your content, eliminating the need for manual configuration and ensuring that your deployed content has immediate access to the external services that it depends on.</p>
999+
<p>Integration requests streamline your deployment process by automatically associating the necessary OAuth integrations with your content, eliminating the need for manual configuration and ensuring that your deployed content has immediate access to the external resources that it depends on.</p>
10001000
<p>You can define integration requests for your content by defining <code>integration_requests</code> in your content's <code>manifest.json</code> file. The base <code>manifest.json</code> file can be produced using the <a href="../../commands/write-manifest/"><code>write-manifest</code></a> command, but you will need to edit the file by hand to add the <code>integration_requests</code>.</p>
10011001
<h3 id="integration-request-specification">Integration Request Specification<a class="headerlink" href="#integration-request-specification" title="Permanent link">#</a></h3>
10021002
<p>During deployment, these integration requests will be processed, and the specified integration specifications will be matched to integrations that are available on the Connect server. If a matching integration is found, it will be used for the deployment. If no matching integration is found, the deployment will fail with an error message indicating that the integration request could not be satisfied.</p>
@@ -1049,30 +1049,34 @@ <h3 id="integration-request-specification">Integration Request Specification<a c
10491049
</tr>
10501050
</tbody>
10511051
</table>
1052-
<p>Possible values for <code>type</code> include:
1053-
- <code>azure</code>
1054-
- <code>azure-openai</code>
1055-
- <code>sharepoint</code>
1056-
- <code>msgraph</code>
1057-
- <code>bigquery</code>
1058-
- <code>drive</code>
1059-
- <code>sheets</code>
1060-
- <code>vertex-ai</code>
1061-
- <code>databricks</code>
1062-
- <code>github</code>
1063-
- <code>salesforce</code>
1064-
- <code>snowflake</code>
1065-
- <code>connect</code>
1066-
- <code>aws</code>
1067-
- <code>custom</code></p>
1068-
<p>Possible values for <code>auth_type</code> include:
1069-
- <code>Viewer</code>
1070-
- <code>Service Account</code>
1071-
- <code>Visitor API Key</code></p>
1052+
<p>Possible values for <code>type</code> include:</p>
1053+
<ul>
1054+
<li><code>azure</code></li>
1055+
<li><code>azure-openai</code></li>
1056+
<li><code>sharepoint</code></li>
1057+
<li><code>msgraph</code></li>
1058+
<li><code>bigquery</code></li>
1059+
<li><code>drive</code></li>
1060+
<li><code>sheets</code></li>
1061+
<li><code>vertex-ai</code></li>
1062+
<li><code>databricks</code></li>
1063+
<li><code>github</code></li>
1064+
<li><code>salesforce</code></li>
1065+
<li><code>snowflake</code></li>
1066+
<li><code>connect</code></li>
1067+
<li><code>aws</code></li>
1068+
<li><code>custom</code></li>
1069+
</ul>
1070+
<p>Possible values for <code>auth_type</code> include:</p>
1071+
<ul>
1072+
<li><code>Viewer</code></li>
1073+
<li><code>Service Account</code></li>
1074+
<li><code>Visitor API Key</code></li>
1075+
</ul>
10721076
<p>An integration request can contain any combination of the fields listed above, and the correct combination will vary by situation.</p>
10731077
<h3 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">#</a></h3>
10741078
<h4 id="using-the-integration-guid">Using the integration guid<a class="headerlink" href="#using-the-integration-guid" title="Permanent link">#</a></h4>
1075-
<p>If the content will only ever be deployed to a single server, the easiest way to make sure an OAuth integration gets automatically associated with it is by only listing the OAuth integration <code>guid</code> in the integration request:</p>
1079+
<p>If the content will only ever be deployed to a single server, the easiest way to make sure the correct OAuth integration gets automatically associated is by listing the OAuth integration <code>guid</code> in the integration request:</p>
10761080
<div class="highlight"><pre><span></span><code><span class="w"> </span><span class="c1">// ...</span>
10771081
<span class="w"> </span><span class="nt">&quot;integration_requests&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
10781082
<span class="w"> </span><span class="p">{</span><span class="nt">&quot;guid&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;123e4567-e89b-12d3-a456-426614174000&quot;</span><span class="p">}</span>
@@ -1092,11 +1096,17 @@ <h4 id="using-the-integration-name-and-template">Using the integration name and
10921096
</code></pre></div>
10931097
<h4 id="using-the-name-template-and-config">Using the name, template, and config<a class="headerlink" href="#using-the-name-template-and-config" title="Permanent link">#</a></h4>
10941098
<div class="highlight"><pre><span></span><code><span class="p">{</span>
1095-
<span class="w"> </span><span class="c1">// ...</span>
1096-
<span class="w"> </span><span class="nt">&quot;integration_requests&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
1097-
<span class="w"> </span><span class="p">{</span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;custom-integration&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;custom&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;config&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="nt">&quot;auth_mode&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Confidential&quot;</span><span class="p">}}</span>
1098-
<span class="w"> </span><span class="p">]</span>
1099-
<span class="w"> </span><span class="c1">// ...</span>
1099+
<span class="w"> </span><span class="c1">// ...</span>
1100+
<span class="w"> </span><span class="nt">&quot;integration_requests&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
1101+
<span class="w"> </span><span class="p">{</span>
1102+
<span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;custom-integration&quot;</span><span class="p">,</span>
1103+
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;custom&quot;</span><span class="p">,</span>
1104+
<span class="w"> </span><span class="nt">&quot;config&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
1105+
<span class="w"> </span><span class="nt">&quot;auth_mode&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Confidential&quot;</span>
1106+
<span class="w"> </span><span class="p">}</span>
1107+
<span class="w"> </span><span class="p">}</span>
1108+
<span class="w"> </span><span class="p">]</span>
1109+
<span class="w"> </span><span class="c1">// ...</span>
11001110
<span class="p">}</span>
11011111
</code></pre></div>
11021112
<h4 id="multiple-integration-requests">Multiple integration requests<a class="headerlink" href="#multiple-integration-requests" title="Permanent link">#</a></h4>

‎pr-preview/pr-700/search/search_index.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.
0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)