Add documentation for /api/v2/team/sync (#2746)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> 22e917a

Author: api-clients-generation-pipeline[bot]

_sources/datadog_api_client.v2.model.rst.txt

@@ -19058,6 +19058,48 @@ datadog\_api\_client.v2.model.team\_routing\_rules\_request\_rule module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.team\_sync\_attributes module
+-----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.team_sync_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.team\_sync\_attributes\_source module
+-------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.team_sync_attributes_source
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.team\_sync\_attributes\_type module
+-----------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.team_sync_attributes_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.team\_sync\_bulk\_type module
+-----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.team_sync_bulk_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.team\_sync\_data module
+-----------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.team_sync_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.team\_sync\_request module
+--------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.team_sync_request
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.team\_target module
 -------------------------------------------------
 

datadog_api_client.html

@@ -5056,6 +5056,12 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.team_routing_rules_request_data_attributes">datadog_api_client.v2.model.team_routing_rules_request_data_attributes module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.team_routing_rules_request_data_type">datadog_api_client.v2.model.team_routing_rules_request_data_type module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.team_routing_rules_request_rule">datadog_api_client.v2.model.team_routing_rules_request_rule module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.team_sync_attributes">datadog_api_client.v2.model.team_sync_attributes module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.team_sync_attributes_source">datadog_api_client.v2.model.team_sync_attributes_source module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.team_sync_attributes_type">datadog_api_client.v2.model.team_sync_attributes_type module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.team_sync_bulk_type">datadog_api_client.v2.model.team_sync_bulk_type module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.team_sync_data">datadog_api_client.v2.model.team_sync_data module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.team_sync_request">datadog_api_client.v2.model.team_sync_request module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.team_target">datadog_api_client.v2.model.team_target module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.team_target_type">datadog_api_client.v2.model.team_target_type module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.team_type">datadog_api_client.v2.model.team_type module</a></li>

datadog_api_client.v2.api.html

@@ -2301,6 +2301,8 @@
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.teams_api.TeamsApi.remove_member_team" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">TeamsApi.remove_member_team()</span></code></a>
         </li>
+        <li class="md-nav__item"><a href="#datadog_api_client.v2.api.teams_api.TeamsApi.sync_teams" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">TeamsApi.sync_teams()</span></code></a>
+        </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.teams_api.TeamsApi.update_team" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">TeamsApi.update_team()</span></code></a>
         </li>
         <li class="md-nav__item"><a href="#datadog_api_client.v2.api.teams_api.TeamsApi.update_team_link" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">TeamsApi.update_team_link()</span></code></a>
@@ -11899,6 +11901,25 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 </dl>
 </dd></dl>
 <dl class="py method">
+<dt class="sig sig-object py" id="datadog_api_client.v2.api.teams_api.TeamsApi.sync_teams">
+<span class="sig-name descname"><span class="pre">sync_teams</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.team_sync_request.TeamSyncRequest" title="datadog_api_client.v2.model.team_sync_request.TeamSyncRequest"><span class="pre">TeamSyncRequest</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datadog_api_client.v2.api.teams_api.TeamsApi.sync_teams" title="Link to this definition">¶</a></dt>
+<dd><p>Link Teams with GitHub Teams.</p>
+<p>This endpoint attempts to link your existing Datadog teams with GitHub teams by matching their names.
+It evaluates all current Datadog teams and compares them against teams in the GitHub organization
+connected to your Datadog account, based on Datadog Team handle and GitHub Team slug
+(lowercased and kebab-cased).</p>
+<p>This operation is read-only on the GitHub side, no teams will be modified or created.</p>
+<p><a class="reference external" href="https://docs.datadoghq.com/integrations/github/">A GitHub organization must be connected to your Datadog account</a> ,
+and the GitHub App integrated with Datadog must have the <code class="docutils literal notranslate"><span class="pre">Members</span> <span class="pre">Read</span></code> permission. Matching is performed by comparing the Datadog team handle to the GitHub team slug
+using a normalized exact match; case is ignored and spaces are removed. No modifications are made
+to teams in GitHub. This will not create new Teams in Datadog.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>None</p>
+</dd>
+</dl>
+</dd></dl>
+<dl class="py method">
 <dt class="sig sig-object py" id="datadog_api_client.v2.api.teams_api.TeamsApi.update_team">
 <span class="sig-name descname"><span class="pre">update_team</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">team_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.team_update_request.TeamUpdateRequest" title="datadog_api_client.v2.model.team_update_request.TeamUpdateRequest"><span class="pre">TeamUpdateRequest</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.team_response.TeamResponse" title="datadog_api_client.v2.model.team_response.TeamResponse"><span class="pre">TeamResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.teams_api.TeamsApi.update_team" title="Link to this definition">¶</a></dt>
 <dd><p>Update a team.</p>

datadog_api_client.v2.html

@@ -1789,6 +1789,7 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.teams_api.TeamsApi.list_teams"><code class="docutils literal notranslate"><span class="pre">TeamsApi.list_teams()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.teams_api.TeamsApi.list_teams_with_pagination"><code class="docutils literal notranslate"><span class="pre">TeamsApi.list_teams_with_pagination()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.teams_api.TeamsApi.remove_member_team"><code class="docutils literal notranslate"><span class="pre">TeamsApi.remove_member_team()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.teams_api.TeamsApi.sync_teams"><code class="docutils literal notranslate"><span class="pre">TeamsApi.sync_teams()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.teams_api.TeamsApi.update_team"><code class="docutils literal notranslate"><span class="pre">TeamsApi.update_team()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.teams_api.TeamsApi.update_team_link"><code class="docutils literal notranslate"><span class="pre">TeamsApi.update_team_link()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.teams_api.TeamsApi.update_team_membership"><code class="docutils literal notranslate"><span class="pre">TeamsApi.update_team_membership()</span></code></a></li>
@@ -12878,6 +12879,30 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
 <li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.team_routing_rules_request_rule.TeamRoutingRulesRequestRule"><code class="docutils literal notranslate"><span class="pre">TeamRoutingRulesRequestRule</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.team_sync_attributes">datadog_api_client.v2.model.team_sync_attributes module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.team_sync_attributes.TeamSyncAttributes"><code class="docutils literal notranslate"><span class="pre">TeamSyncAttributes</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.team_sync_attributes_source">datadog_api_client.v2.model.team_sync_attributes_source module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.team_sync_attributes_source.TeamSyncAttributesSource"><code class="docutils literal notranslate"><span class="pre">TeamSyncAttributesSource</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.team_sync_attributes_type">datadog_api_client.v2.model.team_sync_attributes_type module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.team_sync_attributes_type.TeamSyncAttributesType"><code class="docutils literal notranslate"><span class="pre">TeamSyncAttributesType</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.team_sync_bulk_type">datadog_api_client.v2.model.team_sync_bulk_type module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.team_sync_bulk_type.TeamSyncBulkType"><code class="docutils literal notranslate"><span class="pre">TeamSyncBulkType</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.team_sync_data">datadog_api_client.v2.model.team_sync_data module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.team_sync_data.TeamSyncData"><code class="docutils literal notranslate"><span class="pre">TeamSyncData</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.team_sync_request">datadog_api_client.v2.model.team_sync_request module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.team_sync_request.TeamSyncRequest"><code class="docutils literal notranslate"><span class="pre">TeamSyncRequest</span></code></a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.team_target">datadog_api_client.v2.model.team_target module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.team_target.TeamTarget"><code class="docutils literal notranslate"><span class="pre">TeamTarget</span></code></a></li>
 </ul>