254 lines
27 KiB
HTML
254 lines
27 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" data-content_root="../">
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
<meta property="og:title" content="kittycad.api.hidden.get_auth_saml" />
|
||
<meta property="og:type" content="website" />
|
||
<meta property="og:url" content="_autosummary/kittycad.api.hidden.get_auth_saml.html" />
|
||
<meta property="og:site_name" content="kittycad" />
|
||
<meta property="og:description" content="Functions" />
|
||
<meta name="description" content="Functions" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>kittycad.api.hidden.get_auth_saml — kittycad v0.7.4 documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d10597a4" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=fd3f3429" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/autoclasstoc.css?v=08871587" />
|
||
|
||
|
||
<script src="../_static/jquery.js?v=5d32c60e"></script>
|
||
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||
<script src="../_static/documentation_options.js?v=f9b80c38"></script>
|
||
<script src="../_static/doctools.js?v=9a2dae69"></script>
|
||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
|
||
<script src="../_static/copybutton.js?v=f281be69"></script>
|
||
<script src="../_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="kittycad.api.hidden.get_auth_saml.asyncio" href="kittycad.api.hidden.get_auth_saml.asyncio.html" />
|
||
<link rel="prev" title="kittycad.api.hidden.auth_email_callback.sync_detailed" href="kittycad.api.hidden.auth_email_callback.sync_detailed.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="../index.html" class="icon icon-home">
|
||
kittycad
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<ul class="current">
|
||
<li class="toctree-l1 current"><a class="reference internal" href="kittycad.api.html">kittycad.api</a><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.api_calls.html">kittycad.api.api_calls</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.api_tokens.html">kittycad.api.api_tokens</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.apps.html">kittycad.api.apps</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.beta.html">kittycad.api.beta</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.constant.html">kittycad.api.constant</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.executor.html">kittycad.api.executor</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.file.html">kittycad.api.file</a></li>
|
||
<li class="toctree-l2 current"><a class="reference internal" href="kittycad.api.hidden.html">kittycad.api.hidden</a><ul class="current">
|
||
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.hidden.auth_email.html">kittycad.api.hidden.auth_email</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.hidden.auth_email_callback.html">kittycad.api.hidden.auth_email_callback</a></li>
|
||
<li class="toctree-l3 current"><a class="current reference internal" href="#">kittycad.api.hidden.get_auth_saml</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.hidden.get_auth_saml.asyncio.html">kittycad.api.hidden.get_auth_saml.asyncio</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.hidden.get_auth_saml.asyncio_detailed.html">kittycad.api.hidden.get_auth_saml.asyncio_detailed</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.hidden.get_auth_saml.sync.html">kittycad.api.hidden.get_auth_saml.sync</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.hidden.get_auth_saml.sync_detailed.html">kittycad.api.hidden.get_auth_saml.sync_detailed</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.api.hidden.get_auth_saml._build_response"><code class="docutils literal notranslate"><span class="pre">_build_response()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.api.hidden.get_auth_saml._get_kwargs"><code class="docutils literal notranslate"><span class="pre">_get_kwargs()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.api.hidden.get_auth_saml._parse_response"><code class="docutils literal notranslate"><span class="pre">_parse_response()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.api.hidden.get_auth_saml.asyncio"><code class="docutils literal notranslate"><span class="pre">asyncio()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.api.hidden.get_auth_saml.asyncio_detailed"><code class="docutils literal notranslate"><span class="pre">asyncio_detailed()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.api.hidden.get_auth_saml.sync"><code class="docutils literal notranslate"><span class="pre">sync()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#kittycad.api.hidden.get_auth_saml.sync_detailed"><code class="docutils literal notranslate"><span class="pre">sync_detailed()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.hidden.logout.html">kittycad.api.hidden.logout</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.hidden.post_auth_saml.html">kittycad.api.hidden.post_auth_saml</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.hidden.redirect_user_shortlink.html">kittycad.api.hidden.redirect_user_shortlink</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.meta.html">kittycad.api.meta</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.ml.html">kittycad.api.ml</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.modeling.html">kittycad.api.modeling</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.oauth2.html">kittycad.api.oauth2</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.orgs.html">kittycad.api.orgs</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.payments.html">kittycad.api.payments</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.service_accounts.html">kittycad.api.service_accounts</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.shortlinks.html">kittycad.api.shortlinks</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.store.html">kittycad.api.store</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.unit.html">kittycad.api.unit</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.users.html">kittycad.api.users</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="kittycad.client.html">kittycad.client</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="kittycad.models.html">kittycad.models</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="kittycad.types.html">kittycad.types</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="../index.html">kittycad</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item"><a href="kittycad.api.html">kittycad.api</a></li>
|
||
<li class="breadcrumb-item"><a href="kittycad.api.hidden.html">kittycad.api.hidden</a></li>
|
||
<li class="breadcrumb-item active">kittycad.api.hidden.get_auth_saml</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="module-kittycad.api.hidden.get_auth_saml">
|
||
<span id="kittycad-api-hidden-get-auth-saml"></span><h1>kittycad.api.hidden.get_auth_saml<a class="headerlink" href="#module-kittycad.api.hidden.get_auth_saml" title="Link to this heading"></a></h1>
|
||
<p class="rubric">Functions</p>
|
||
<table class="autosummary longtable docutils align-default">
|
||
<tbody>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="kittycad.api.hidden.get_auth_saml.asyncio.html#kittycad.api.hidden.get_auth_saml.asyncio" title="kittycad.api.hidden.get_auth_saml.asyncio"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio</span></code></a>(provider_id, *, client[, callback_url])</p></td>
|
||
<td><p>The UI uses this to avoid having to ask the API anything about the IdP.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="kittycad.api.hidden.get_auth_saml.asyncio_detailed.html#kittycad.api.hidden.get_auth_saml.asyncio_detailed" title="kittycad.api.hidden.get_auth_saml.asyncio_detailed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asyncio_detailed</span></code></a>(provider_id, *, client[, ...])</p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p><a class="reference internal" href="kittycad.api.hidden.get_auth_saml.sync.html#kittycad.api.hidden.get_auth_saml.sync" title="kittycad.api.hidden.get_auth_saml.sync"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sync</span></code></a>(provider_id, *, client[, callback_url])</p></td>
|
||
<td><p>The UI uses this to avoid having to ask the API anything about the IdP.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p><a class="reference internal" href="kittycad.api.hidden.get_auth_saml.sync_detailed.html#kittycad.api.hidden.get_auth_saml.sync_detailed" title="kittycad.api.hidden.get_auth_saml.sync_detailed"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sync_detailed</span></code></a>(provider_id, *, client[, ...])</p></td>
|
||
<td><p></p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="kittycad.api.hidden.get_auth_saml._build_response">
|
||
<span class="sig-prename descclassname"><span class="pre">kittycad.api.hidden.get_auth_saml.</span></span><span class="sig-name descname"><span class="pre">_build_response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/hidden/get_auth_saml.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/api/hidden/get_auth_saml.html#_build_response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.hidden.get_auth_saml._build_response" title="Link to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response" title="kittycad.types.Response"><code class="xref py py-class docutils literal notranslate"><span class="pre">Response</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>]]</span></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="kittycad.api.hidden.get_auth_saml._get_kwargs">
|
||
<span class="sig-prename descclassname"><span class="pre">kittycad.api.hidden.get_auth_saml.</span></span><span class="sig-name descname"><span class="pre">_get_kwargs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider_id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">callback_url</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="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/hidden/get_auth_saml.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/api/hidden/get_auth_saml.html#_get_kwargs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.hidden.get_auth_saml._get_kwargs" title="Link to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dict</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></a>]</span></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="kittycad.api.hidden.get_auth_saml._parse_response">
|
||
<span class="sig-prename descclassname"><span class="pre">kittycad.api.hidden.get_auth_saml.</span></span><span class="sig-name descname"><span class="pre">_parse_response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/hidden/get_auth_saml.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/api/hidden/get_auth_saml.html#_parse_response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.hidden.get_auth_saml._parse_response" title="Link to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>]</span></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="kittycad.api.hidden.get_auth_saml.asyncio">
|
||
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.api.hidden.get_auth_saml.</span></span><span class="sig-name descname"><span class="pre">asyncio</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider_id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">callback_url</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="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/hidden/get_auth_saml.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/api/hidden/get_auth_saml.html#asyncio"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.hidden.get_auth_saml.asyncio" title="Link to this definition"></a></dt>
|
||
<dd><p>The UI uses this to avoid having to ask the API anything about the IdP. It already knows the SAML IdP ID from the path, so it can just link to this path and rely on the API to redirect to the actual IdP.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>]</span></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="kittycad.api.hidden.get_auth_saml.asyncio_detailed">
|
||
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.api.hidden.get_auth_saml.</span></span><span class="sig-name descname"><span class="pre">asyncio_detailed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider_id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">callback_url</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="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/hidden/get_auth_saml.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/api/hidden/get_auth_saml.html#asyncio_detailed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.hidden.get_auth_saml.asyncio_detailed" title="Link to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response" title="kittycad.types.Response"><code class="xref py py-class docutils literal notranslate"><span class="pre">Response</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>]]</span></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="kittycad.api.hidden.get_auth_saml.sync">
|
||
<span class="sig-prename descclassname"><span class="pre">kittycad.api.hidden.get_auth_saml.</span></span><span class="sig-name descname"><span class="pre">sync</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider_id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">callback_url</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="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/hidden/get_auth_saml.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/api/hidden/get_auth_saml.html#sync"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.hidden.get_auth_saml.sync" title="Link to this definition"></a></dt>
|
||
<dd><p>The UI uses this to avoid having to ask the API anything about the IdP. It already knows the SAML IdP ID from the path, so it can just link to this path and rely on the API to redirect to the actual IdP.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>]</span></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="kittycad.api.hidden.get_auth_saml.sync_detailed">
|
||
<span class="sig-prename descclassname"><span class="pre">kittycad.api.hidden.get_auth_saml.</span></span><span class="sig-name descname"><span class="pre">sync_detailed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">provider_id</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">callback_url</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="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/hidden/get_auth_saml.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/api/hidden/get_auth_saml.html#sync_detailed"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.hidden.get_auth_saml.sync_detailed" title="Link to this definition"></a></dt>
|
||
<dd><dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="kittycad.types.Response.html#kittycad.types.Response" title="kittycad.types.Response"><code class="xref py py-class docutils literal notranslate"><span class="pre">Response</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>]]</span></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="kittycad.api.hidden.auth_email_callback.sync_detailed.html" class="btn btn-neutral float-left" title="kittycad.api.hidden.auth_email_callback.sync_detailed" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="kittycad.api.hidden.get_auth_saml.asyncio.html" class="btn btn-neutral float-right" title="kittycad.api.hidden.get_auth_saml.asyncio" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2025, KittyCAD Team Members.</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |