Skip to content

Commit

Permalink
Add restriction policy APIs (#1337)
Browse files Browse the repository at this point in the history
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com> 4e059cf
  • Loading branch information
api-clients-generation-pipeline[bot] and ci.datadog-api-spec committed Feb 16, 2023
1 parent 039162a commit a34f54e
Show file tree
Hide file tree
Showing 10 changed files with 505 additions and 7 deletions.
7 changes: 7 additions & 0 deletions _sources/datadog_api_client.v2.api.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,13 @@ processes\_api
:members:
:show-inheritance:

restriction\_policies\_api
--------------------------

.. automodule:: datadog_api_client.v2.api.restriction_policies_api
:members:
:show-inheritance:

roles\_api
----------

Expand Down
42 changes: 42 additions & 0 deletions _sources/datadog_api_client.v2.model.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3725,6 +3725,48 @@ response\_meta\_attributes
:members:
:show-inheritance:

restriction\_policy
-------------------

.. automodule:: datadog_api_client.v2.model.restriction_policy
:members:
:show-inheritance:

restriction\_policy\_attributes
-------------------------------

.. automodule:: datadog_api_client.v2.model.restriction_policy_attributes
:members:
:show-inheritance:

restriction\_policy\_binding
----------------------------

.. automodule:: datadog_api_client.v2.model.restriction_policy_binding
:members:
:show-inheritance:

restriction\_policy\_response
-----------------------------

.. automodule:: datadog_api_client.v2.model.restriction_policy_response
:members:
:show-inheritance:

restriction\_policy\_type
-------------------------

.. automodule:: datadog_api_client.v2.model.restriction_policy_type
:members:
:show-inheritance:

restriction\_policy\_update\_request
------------------------------------

.. automodule:: datadog_api_client.v2.model.restriction_policy_update_request
:members:
:show-inheritance:

role
----

Expand Down
28 changes: 28 additions & 0 deletions datadog_api_client.html
Original file line number Diff line number Diff line change
Expand Up @@ -4387,6 +4387,10 @@ <h1 id="datadog-api-client--page-root">datadog_api_client<a class="headerlink" h
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.processes_api.ProcessesApi"><code class="docutils literal notranslate"><span class="pre">ProcessesApi</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.api.html#module-datadog_api_client.v2.api.restriction_policies_api">restriction_policies_api</a><ul>
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.restriction_policies_api.RestrictionPoliciesApi"><code class="docutils literal notranslate"><span class="pre">RestrictionPoliciesApi</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.api.html#module-datadog_api_client.v2.api.roles_api">roles_api</a><ul>
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.roles_api.RolesApi"><code class="docutils literal notranslate"><span class="pre">RolesApi</span></code></a></li>
</ul>
Expand Down Expand Up @@ -6550,6 +6554,30 @@ <h1 id="datadog-api-client--page-root">datadog_api_client<a class="headerlink" h
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.response_meta_attributes.ResponseMetaAttributes"><code class="docutils literal notranslate"><span class="pre">ResponseMetaAttributes</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.restriction_policy">restriction_policy</a><ul>
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.restriction_policy.RestrictionPolicy"><code class="docutils literal notranslate"><span class="pre">RestrictionPolicy</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.restriction_policy_attributes">restriction_policy_attributes</a><ul>
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.restriction_policy_attributes.RestrictionPolicyAttributes"><code class="docutils literal notranslate"><span class="pre">RestrictionPolicyAttributes</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.restriction_policy_binding">restriction_policy_binding</a><ul>
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.restriction_policy_binding.RestrictionPolicyBinding"><code class="docutils literal notranslate"><span class="pre">RestrictionPolicyBinding</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.restriction_policy_response">restriction_policy_response</a><ul>
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.restriction_policy_response.RestrictionPolicyResponse"><code class="docutils literal notranslate"><span class="pre">RestrictionPolicyResponse</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.restriction_policy_type">restriction_policy_type</a><ul>
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.restriction_policy_type.RestrictionPolicyType"><code class="docutils literal notranslate"><span class="pre">RestrictionPolicyType</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.restriction_policy_update_request">restriction_policy_update_request</a><ul>
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.restriction_policy_update_request.RestrictionPolicyUpdateRequest"><code class="docutils literal notranslate"><span class="pre">RestrictionPolicyUpdateRequest</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.role">role</a><ul>
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.role.Role"><code class="docutils literal notranslate"><span class="pre">Role</span></code></a></li>
</ul>
Expand Down
92 changes: 92 additions & 0 deletions datadog_api_client.v2.api.html
Original file line number Diff line number Diff line change
Expand Up @@ -711,6 +711,20 @@
</li></ul>
</nav>
</li>
<li class="md-nav__item"><a href="#module-datadog_api_client.v2.api.restriction_policies_api" class="md-nav__link">restriction_policies_api</a><nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.restriction_policies_api.RestrictionPoliciesApi" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">RestrictionPoliciesApi</span></code></a><nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.restriction_policies_api.RestrictionPoliciesApi.delete_restriction_policy" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">RestrictionPoliciesApi.delete_restriction_policy()</span></code></a>
</li>
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.restriction_policies_api.RestrictionPoliciesApi.get_restriction_policy" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">RestrictionPoliciesApi.get_restriction_policy()</span></code></a>
</li>
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.restriction_policies_api.RestrictionPoliciesApi.update_restriction_policy" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">RestrictionPoliciesApi.update_restriction_policy()</span></code></a>
</li></ul>
</nav>
</li></ul>
</nav>
</li>
<li class="md-nav__item"><a href="#module-datadog_api_client.v2.api.roles_api" class="md-nav__link">roles_api</a><nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.roles_api.RolesApi" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">RolesApi</span></code></a><nav class="md-nav">
Expand Down Expand Up @@ -1782,6 +1796,20 @@
</li></ul>
</nav>
</li>
<li class="md-nav__item"><a href="#module-datadog_api_client.v2.api.restriction_policies_api" class="md-nav__link">restriction_policies_api</a><nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.restriction_policies_api.RestrictionPoliciesApi" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">RestrictionPoliciesApi</span></code></a><nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.restriction_policies_api.RestrictionPoliciesApi.delete_restriction_policy" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">RestrictionPoliciesApi.delete_restriction_policy()</span></code></a>
</li>
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.restriction_policies_api.RestrictionPoliciesApi.get_restriction_policy" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">RestrictionPoliciesApi.get_restriction_policy()</span></code></a>
</li>
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.restriction_policies_api.RestrictionPoliciesApi.update_restriction_policy" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">RestrictionPoliciesApi.update_restriction_policy()</span></code></a>
</li></ul>
</nav>
</li></ul>
</nav>
</li>
<li class="md-nav__item"><a href="#module-datadog_api_client.v2.api.roles_api" class="md-nav__link">roles_api</a><nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.roles_api.RolesApi" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">RolesApi</span></code></a><nav class="md-nav">
Expand Down Expand Up @@ -4489,6 +4517,70 @@ <h1 id="datadog-api-client-v2-api--page-root">datadog_api_client.v2.api<a class=
</dd></dl>
</dd></dl>
</section>
<section id="module-datadog_api_client.v2.api.restriction_policies_api">
<span id="restriction-policies-api"></span><h2 id="module-datadog_api_client.v2.api.restriction_policies_api">restriction_policies_api<a class="headerlink" href="#module-datadog_api_client.v2.api.restriction_policies_api" title="Permalink to this heading">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="datadog_api_client.v2.api.restriction_policies_api.RestrictionPoliciesApi">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">RestrictionPoliciesApi</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">api_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datadog_api_client.v2.api.restriction_policies_api.RestrictionPoliciesApi" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>A restriction policy defines the access control rules for a resource, mapping a set of relations
(such as editor and viewer) to a set of allowed principals (such as roles). The restriction policy
determines who is authorized to perform what actions on the resource.</p>
<dl class="py method">
<dt class="sig sig-object py" id="datadog_api_client.v2.api.restriction_policies_api.RestrictionPoliciesApi.delete_restriction_policy">
<span class="sig-name descname"><span class="pre">delete_restriction_policy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resource_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><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.restriction_policies_api.RestrictionPoliciesApi.delete_restriction_policy" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete a restriction policy.</p>
<p>Deletes the restriction policy associated with a specified resource.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>resource_id</strong> (<em>str</em>) – Identifier, formatted as <code class="docutils literal notranslate"><span class="pre">type:id</span></code>. Supported types: <code class="docutils literal notranslate"><span class="pre">connection</span></code> , <code class="docutils literal notranslate"><span class="pre">dashboard</span></code> , <code class="docutils literal notranslate"><span class="pre">notebook</span></code> , <code class="docutils literal notranslate"><span class="pre">security-rule</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>None</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datadog_api_client.v2.api.restriction_policies_api.RestrictionPoliciesApi.get_restriction_policy">
<span class="sig-name descname"><span class="pre">get_restriction_policy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resource_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><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.restriction_policy_response.RestrictionPolicyResponse" title="datadog_api_client.v2.model.restriction_policy_response.RestrictionPolicyResponse"><span class="pre">RestrictionPolicyResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.restriction_policies_api.RestrictionPoliciesApi.get_restriction_policy" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a restriction policy.</p>
<p>Retrieves the restriction policy associated with a specified resource.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>resource_id</strong> (<em>str</em>) – Identifier, formatted as <code class="docutils literal notranslate"><span class="pre">type:id</span></code>. Supported types: <code class="docutils literal notranslate"><span class="pre">connection</span></code> , <code class="docutils literal notranslate"><span class="pre">dashboard</span></code> , <code class="docutils literal notranslate"><span class="pre">notebook</span></code> , <code class="docutils literal notranslate"><span class="pre">security-rule</span></code>.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.restriction_policy_response.RestrictionPolicyResponse" title="datadog_api_client.v2.model.restriction_policy_response.RestrictionPolicyResponse">RestrictionPolicyResponse</a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="datadog_api_client.v2.api.restriction_policies_api.RestrictionPoliciesApi.update_restriction_policy">
<span class="sig-name descname"><span class="pre">update_restriction_policy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">resource_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.restriction_policy_update_request.RestrictionPolicyUpdateRequest" title="datadog_api_client.v2.model.restriction_policy_update_request.RestrictionPolicyUpdateRequest"><span class="pre">RestrictionPolicyUpdateRequest</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.restriction_policy_response.RestrictionPolicyResponse" title="datadog_api_client.v2.model.restriction_policy_response.RestrictionPolicyResponse"><span class="pre">RestrictionPolicyResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.restriction_policies_api.RestrictionPoliciesApi.update_restriction_policy" title="Permalink to this definition">¶</a></dt>
<dd><p>Update a restriction policy.</p>
<p>Updates the restriction policy associated with a resource.</p>
<p><strong>Supported resources</strong></p>
<p>Restriction policies can be applied to the following resources:</p>
<ul class="simple">
<li><p>Connections: <code class="docutils literal notranslate"><span class="pre">connection</span></code></p></li>
<li><p>Dashboards: <code class="docutils literal notranslate"><span class="pre">dashboard</span></code></p></li>
<li><p>Notebooks: <code class="docutils literal notranslate"><span class="pre">notebook</span></code></p></li>
<li><p>Security Rules: <code class="docutils literal notranslate"><span class="pre">security-rule</span></code></p></li>
</ul>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>resource_id</strong> (<em>str</em>) – Identifier, formatted as <code class="docutils literal notranslate"><span class="pre">type:id</span></code>. Supported types: <code class="docutils literal notranslate"><span class="pre">connection</span></code> , <code class="docutils literal notranslate"><span class="pre">dashboard</span></code> , <code class="docutils literal notranslate"><span class="pre">notebook</span></code> , <code class="docutils literal notranslate"><span class="pre">security-rule</span></code>.</p></li>
<li><p><strong>body</strong> (<a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.restriction_policy_update_request.RestrictionPolicyUpdateRequest" title="datadog_api_client.v2.model.restriction_policy_update_request.RestrictionPolicyUpdateRequest"><em>RestrictionPolicyUpdateRequest</em></a>) – Restriction policy payload</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.restriction_policy_response.RestrictionPolicyResponse" title="datadog_api_client.v2.model.restriction_policy_response.RestrictionPolicyResponse">RestrictionPolicyResponse</a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="module-datadog_api_client.v2.api.roles_api">
<span id="id12"></span><h2 id="module-datadog_api_client.v2.api.roles_api">roles_api<a class="headerlink" href="#module-datadog_api_client.v2.api.roles_api" title="Permalink to this heading">¶</a></h2>
<dl class="py class">
Expand Down
Loading

0 comments on commit a34f54e

Please sign in to comment.