Files
kittycad.py/docs/html/_autosummary/kittycad.api.api_tokens.html
2025-01-07 02:19:42 +00:00

167 lines
11 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.api_tokens" />
<meta property="og:type" content="website" />
<meta property="og:url" content="_autosummary/kittycad.api.api_tokens.html" />
<meta property="og:site_name" content="kittycad" />
<meta property="og:description" content="Contains methods for accessing the api_tokens API paths: API tokens allow users to call the API outside of their session token that is used as a cookie in the user interface. Users can create, dele..." />
<meta name="description" content="Contains methods for accessing the api_tokens API paths: API tokens allow users to call the API outside of their session token that is used as a cookie in the user interface. Users can create, dele..." />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.api_tokens &mdash; 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.api_tokens.create_api_token_for_user" href="kittycad.api.api_tokens.create_api_token_for_user.html" />
<link rel="prev" title="kittycad.api.api_calls.user_list_api_calls.sync_detailed" href="kittycad.api.api_calls.user_list_api_calls.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 current"><a class="current reference internal" href="#">kittycad.api.api_tokens</a><ul>
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.api_tokens.create_api_token_for_user.html">kittycad.api.api_tokens.create_api_token_for_user</a></li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.api_tokens.delete_api_token_for_user.html">kittycad.api.api_tokens.delete_api_token_for_user</a></li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.api_tokens.get_api_token_for_user.html">kittycad.api.api_tokens.get_api_token_for_user</a></li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.api_tokens.list_api_tokens_for_user.html">kittycad.api.api_tokens.list_api_tokens_for_user</a></li>
</ul>
</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"><a class="reference internal" href="kittycad.api.hidden.html">kittycad.api.hidden</a></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 active">kittycad.api.api_tokens</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.api_tokens">
<span id="kittycad-api-api-tokens"></span><h1>kittycad.api.api_tokens<a class="headerlink" href="#module-kittycad.api.api_tokens" title="Link to this heading"></a></h1>
<p>Contains methods for accessing the api_tokens API paths: API tokens allow users to call the API outside of their session token that is used as a cookie in the user interface. Users can create, delete, and list their API tokens. But, of course, you need an API token to do this, so first be sure to generate one in the account UI.</p>
<p class="rubric">Modules</p>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="kittycad.api.api_tokens.create_api_token_for_user.html#module-kittycad.api.api_tokens.create_api_token_for_user" title="kittycad.api.api_tokens.create_api_token_for_user"><code class="xref py py-obj docutils literal notranslate"><span class="pre">create_api_token_for_user</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="kittycad.api.api_tokens.delete_api_token_for_user.html#module-kittycad.api.api_tokens.delete_api_token_for_user" title="kittycad.api.api_tokens.delete_api_token_for_user"><code class="xref py py-obj docutils literal notranslate"><span class="pre">delete_api_token_for_user</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="kittycad.api.api_tokens.get_api_token_for_user.html#module-kittycad.api.api_tokens.get_api_token_for_user" title="kittycad.api.api_tokens.get_api_token_for_user"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_api_token_for_user</span></code></a></p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="kittycad.api.api_tokens.list_api_tokens_for_user.html#module-kittycad.api.api_tokens.list_api_tokens_for_user" title="kittycad.api.api_tokens.list_api_tokens_for_user"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list_api_tokens_for_user</span></code></a></p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="kittycad.api.api_calls.user_list_api_calls.sync_detailed.html" class="btn btn-neutral float-left" title="kittycad.api.api_calls.user_list_api_calls.sync_detailed" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="kittycad.api.api_tokens.create_api_token_for_user.html" class="btn btn-neutral float-right" title="kittycad.api.api_tokens.create_api_token_for_user" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; 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>