public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-28 22:18:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: 8a26132d03

Browse Source
This commit is contained in:
github-actions[bot]
2024-05-29 21:39:49 +00:00
parent 7ac18f2764
commit 90a697e952
5140 changed files with 15463 additions and 15491 deletions
Download Patch File Download Diff File Expand all files Collapse all files
v2.6/reference-guides/about-the-api/api-tokens.html
+4 -4
View File
@@ -15,8 +15,8 @@
<script src="https://cdn.cookielaw.org/scripttemplates/otSDKStub.js" charset="UTF-8" data-domain-script="0f98beb0-fc4c-417d-a42e-564e2cae42d2" async></script>
<script src="/scripts/optanonwrapper.js" async></script><link rel="stylesheet" href="/assets/css/styles.b83e5a9c.css">
<link rel="preload" href="/assets/js/runtime~main.0190ea56.js" as="script">
<link rel="preload" href="/assets/js/main.2c620d99.js" as="script">
<link rel="preload" href="/assets/js/runtime~main.8aa519f2.js" as="script">
<link rel="preload" href="/assets/js/main.5415f821.js" as="script">
</head>
<body class="navigation-with-keyboard">
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-57KS2MW" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
@@ -27,7 +27,7 @@
<strong>Introduced in version 2.6.6</strong>.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="kubeconfig-token-ttl-minutes">kubeconfig-token-ttl-minutes<a href="#kubeconfig-token-ttl-minutes" class="hash-link" aria-label="Direct link to kubeconfig-token-ttl-minutes" title="Direct link to kubeconfig-token-ttl-minutes">​</a></h3><p>Time to live (TTL) duration in minutes, used to determine when a kubeconfig token that was generated by the CLI expires. Tokens are generated by the CLI when <a href="#kubeconfig-generate-token"><code>kubeconfig-generate-token</code></a> is false. When the token is expired, the API rejects the token. This setting can&#x27;t be larger than <a href="#auth-token-max-ttl-minutes"><code>auth-token-max-ttl-minutes</code></a>.
<strong>Deprecated since Rancher v2.6.6.</strong></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="auth-token-max-ttl-minutes">auth-token-max-ttl-minutes<a href="#auth-token-max-ttl-minutes" class="hash-link" aria-label="Direct link to auth-token-max-ttl-minutes" title="Direct link to auth-token-max-ttl-minutes">​</a></h3><p>Maximum Time to Live (TTL) in minutes allowed for auth tokens. If a user attempts to create a token with a TTL greater than <code>auth-token-max-ttl-minutes</code>, Rancher sets the token TTL to the value of <code>auth-token-max-ttl-minutes</code>. Auth tokens are tokens created for authenticating API requests. The default value is <code>0</code>, which means that tokens never expire.
<strong>Rancher v2.6.6 and later: Applies to all kubeconfig tokens and api tokens.</strong></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="kubeconfig-generate-token">kubeconfig-generate-token<a href="#kubeconfig-generate-token" class="hash-link" aria-label="Direct link to kubeconfig-generate-token" title="Direct link to kubeconfig-generate-token">​</a></h3><p>When true, kubeconfigs requested through the UI contain a valid token. When false, the kubeconfig contains a command that uses the Rancher CLI to prompt the user to log in. <a href="/v2.6/reference-guides/cli-with-rancher/kubectl-utility#authentication-with-kubectl-and-kubeconfig-tokens-with-ttl">The CLI then retrieves and caches a token for the user</a>.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/rancher/rancher-docs/edit/main/versioned_docs/version-2.6/reference-guides/about-the-api/api-tokens.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"><span class="theme-last-updated">Last updated<!-- --> on <b><time datetime="2024-03-25T22:05:17.000Z">Mar 25, 2024</time></b></span></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/v2.6/reference-guides/about-the-api"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">API</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/v2.6/reference-guides/rancher-cluster-tools"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Cluster Tools for Logging, Monitoring, and Visibility</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#deleting-tokens" class="table-of-contents__link toc-highlight">Deleting Tokens</a></li><li><a href="#setting-ttl-on-kubeconfig-tokens" class="table-of-contents__link toc-highlight">Setting TTL on Kubeconfig Tokens</a></li><li><a href="#disable-tokens-in-generated-kubeconfigs" class="table-of-contents__link toc-highlight">Disable Tokens in Generated Kubeconfigs</a></li><li><a href="#token-hashing" class="table-of-contents__link toc-highlight">Token Hashing</a></li><li><a href="#token-settings" class="table-of-contents__link toc-highlight">Token Settings</a><ul><li><a href="#auth-user-session-ttl-minutes" class="table-of-contents__link toc-highlight">auth-user-session-ttl-minutes</a></li><li><a href="#kubeconfig-default-token-ttl-minutes" class="table-of-contents__link toc-highlight">kubeconfig-default-token-ttl-minutes</a></li><li><a href="#kubeconfig-token-ttl-minutes" class="table-of-contents__link toc-highlight">kubeconfig-token-ttl-minutes</a></li><li><a href="#auth-token-max-ttl-minutes" class="table-of-contents__link toc-highlight">auth-token-max-ttl-minutes</a></li><li><a href="#kubeconfig-generate-token" class="table-of-contents__link toc-highlight">kubeconfig-generate-token</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 SUSE Rancher. All Rights Reserved.</div></div></div></footer></div>
<script src="/assets/js/runtime~main.0190ea56.js"></script>
<script src="/assets/js/main.2c620d99.js"></script>
<script src="/assets/js/runtime~main.8aa519f2.js"></script>
<script src="/assets/js/main.5415f821.js"></script>
</body>
</html>