CINXE.COM

<!DOCTYPE html><html lang="en" class="dark"><head><meta charSet="utf-8"/><meta name="viewport" content="width=device-width"/><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="https://mintlify.s3-us-west-1.amazonaws.com/infisical/_generated/favicon/apple-touch-icon.png?v=3"/><link rel="icon" type="image/png" sizes="32x32" href="https://mintlify.s3-us-west-1.amazonaws.com/infisical/_generated/favicon/favicon-32x32.png?v=3"/><link rel="icon" type="image/png" sizes="16x16" href="https://mintlify.s3-us-west-1.amazonaws.com/infisical/_generated/favicon/favicon-16x16.png?v=3"/><link rel="shortcut icon" type="image/x-icon" href="https://mintlify.s3-us-west-1.amazonaws.com/infisical/_generated/favicon/favicon.ico?v=3"/><meta name="msapplication-config" content="https://mintlify.s3-us-west-1.amazonaws.com/infisical/_generated/favicon/browserconfig.xml?v=3"/><meta name="apple-mobile-web-app-title" content="Infisical"/><meta name="application-name" content="Infisical"/><meta name="msapplication-TileColor" content="#26272b"/><meta name="theme-color" content="#ffffff"/><link rel="sitemap" type="application/xml" href="/docs/sitemap.xml"/><meta name="charset" content="utf-8"/><meta name="og:type" content="website"/><meta name="og:site_name" content="Infisical"/><meta name="twitter:card" content="summary_large_image"/><meta name="og:title" content="Infisical Node.js SDK - Infisical"/><meta name="twitter:title" content="Infisical Node.js SDK - Infisical"/><meta name="og:image" content="https://mintlify.com/docs/api/og?division=Documentation&mode=light&title=Infisical+Node.js+SDK&logoLight=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Finfisical%2Flogo%2Flight.svg&logoDark=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Finfisical%2Flogo%2Fdark.svg&primaryColor=%2326272b&lightColor=%2397b31d&darkColor=%23A1B659"/><meta name="twitter:image" content="https://mintlify.com/docs/api/og?division=Documentation&mode=light&title=Infisical+Node.js+SDK&logoLight=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Finfisical%2Flogo%2Flight.svg&logoDark=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Finfisical%2Flogo%2Fdark.svg&primaryColor=%2326272b&lightColor=%2397b31d&darkColor=%23A1B659"/><title>Infisical Node.js SDK - Infisical</title><meta name="og:url" content="/docs/sdks/languages/node"/><link rel="canonical" href="/docs/sdks/languages/node"/><meta name="next-head-count" content="23"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.16.0/dist/katex.min.css" integrity="sha384-Xi8rHCmBmhbuyyhbI88391ZKP2dmfnOl4rT9ZfRI7mLTdk1wblIUnrIq35nqwEvC" crossorigin="anonymous"/><link rel="preload" href="/docs/_next/static/media/a34f9d1faa5f3315-s.p.woff2" as="font" type="font/woff2" crossorigin="anonymous" data-next-font="size-adjust"/><link rel="preload" href="/docs/_next/static/media/bb3ef058b751a6ad-s.p.woff2" as="font" type="font/woff2" crossorigin="anonymous" data-next-font="size-adjust"/><script id="mode-toggle" data-nscript="beforeInteractive"> try { if (localStorage.isDarkMode === 'true') { document.documentElement.classList.add('dark'); } else if (localStorage.isDarkMode === 'false') { document.documentElement.classList.remove('dark'); } else if ((false && !('isDarkMode' in localStorage) && window.matchMedia('(prefers-color-scheme: dark)').matches) || false) { document.documentElement.classList.add('dark'); } else { document.documentElement.classList.remove('dark'); } } catch (_) {} </script><link rel="preload" href="/docs/_next/static/css/17e674fe0a1d207f.css" as="style"/><link rel="stylesheet" href="/docs/_next/static/css/17e674fe0a1d207f.css" data-n-g=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/docs/_next/static/chunks/polyfills-42372ed130431b0a.js"></script><script src="/docs/_next/static/chunks/webpack-082cee471cefe69d.js" defer=""></script><script src="/docs/_next/static/chunks/framework-d17a13b7014ce556.js" defer=""></script><script src="/docs/_next/static/chunks/main-b4563e976e2fd8aa.js" defer=""></script><script src="/docs/_next/static/chunks/pages/_app-d5ffaf2e83a1968d.js" defer=""></script><script src="/docs/_next/static/chunks/2edb282b-7fa355f49eaeb230.js" defer=""></script><script src="/docs/_next/static/chunks/e893f787-54a006ae51267903.js" defer=""></script><script src="/docs/_next/static/chunks/086d643d-3aa1cf46914548d9.js" defer=""></script><script src="/docs/_next/static/chunks/9097-12d1b59a6a39c208.js" defer=""></script><script src="/docs/_next/static/chunks/6430-16e004706658d885.js" defer=""></script><script src="/docs/_next/static/chunks/2073-fcba8b6245f0552c.js" defer=""></script><script src="/docs/_next/static/chunks/pages/_sites/%5Bsubdomain%5D/%5B%5B...slug%5D%5D-7d0e3c1d0f130c24.js" defer=""></script><script src="/docs/_next/static/DLyUTdO3OSYUYl4V89rim/_buildManifest.js" defer=""></script><script src="/docs/_next/static/DLyUTdO3OSYUYl4V89rim/_ssgManifest.js" defer=""></script><style id="__jsx-3178852779">:root{--font-inter:'__Inter_c8d9fa', '__Inter_Fallback_c8d9fa';--font-jetbrains-mono:'__JetBrains_Mono_ea4744', '__JetBrains_Mono_Fallback_ea4744'}</style></head><div id="__next"><main class="jsx-3178852779"><style>:root { --primary: 38 39 43; --primary-light: 151 179 29; --primary-dark: 161 182 89; --background-light: 255 255 255; --background-dark: 13 17 23; --gray-50: 244 244 244; --gray-100: 239 239 239; --gray-200: 223 223 223; --gray-300: 207 207 207; --gray-400: 159 159 159; --gray-500: 113 113 113; --gray-600: 81 81 81; --gray-700: 63 63 63; --gray-800: 38 38 38; --gray-900: 23 23 24; --gray-950: 11 11 11; }</style><style>#navbar .max-w-8xl { max-width: 100%; border-bottom: 1px solid #ebebeb; background-color: #F4F3EF; } .max-w-8xl { /* background-color: #f5f5f5; */ } #sidebar { left: 0; padding-right: 30px; border-right: 1px; border-color: #cdd64b; background-color: #F4F3EF; border-right: 1px solid #ebebeb; } #sidebar-content { padding-left: 2rem; } #sidebar .relative .sticky { opacity: 0; } #sidebar li > div.mt-2 { border-radius: 0; padding: 5px; } #sidebar li > a.text-primary { border-radius: 0; background-color: #FBFFCC; border-left: 4px solid #EFFF33; padding: 5px; } #sidebar li > a.mt-2 { border-radius: 0; padding: 5px; } #sidebar li > a.leading-6 { border-radius: 0; padding: 0px; } /* #sidebar ul > div.mt-12 { padding-top: 30px; position: relative; } #sidebar ul > div.mt-12 h5 { position: absolute; left: -12px; top: -0px; } */ #header { border-left: 4px solid #EFFF33; padding-left: 16px; padding-right: 16px; background-color: #FDFFE5; padding-bottom: 10px; padding-top: 10px; } #content-area .mt-8 .block{ border-radius: 0; border-width: 1px; background-color: #FCFBFA; border-color: #ebebeb; } /* #content-area:hover .mt-8 .block:hover{ border-radius: 0; border-width: 1px; background-color: #FDFFE5; border-color: #EFFF33; } */ #content-area .mt-8 .rounded-xl{ border-radius: 0; } #content-area .mt-8 .rounded-lg{ border-radius: 0; } #content-area .mt-6 .rounded-xl{ border-radius: 0; } #content-area .mt-6 .rounded-lg{ border-radius: 0; } #content-area .mt-6 .rounded-md{ border-radius: 0; } #content-area .mt-8 .rounded-md{ border-radius: 0; } #content-area div.my-4{ border-radius: 0; border-width: 1px; } #content-area div.flex-1 { /* text-transform: uppercase; */ opacity: 0.8; font-weight: 400; } #content-area button { border-radius: 0; } #content-area a { border-radius: 0; } #content-area .not-prose { border-radius: 0; } /* .eyebrow { text-transform: uppercase; font-weight: 400; color: red; } */ #content-container { /* background-color: #f5f5f5; */ margin-top: 2rem; } #topbar-cta-button .group .absolute { background-color: black; border-radius: 0px; } /* #topbar-cta-button .group .absolute:hover { background-color: white; border-radius: 0px; } */ #topbar-cta-button .group .flex { margin-top: 5px; margin-bottom: 5px; font-size: medium; } .flex-1 .flex .items-center { /* background-color: #f5f5f5; */ } </style><div class="relative antialiased text-gray-500 dark:text-gray-400"><span class="fixed inset-0 bg-background-light dark:bg-background-dark -z-10"></span><div id="navbar" class="z-30 fixed lg:sticky top-0 w-full"><div id="navbar-transition" class="absolute w-full h-full backdrop-blur flex-none transition-colors duration-500 border-b border-gray-500/5 dark:border-gray-300/[0.06] supports-backdrop-blur:bg-background-light/60 dark:bg-transparent"></div><div class="max-w-8xl mx-auto relative"><div class=""><div class="relative"><div class="flex items-center lg:px-12 h-16 min-w-0 mx-4 lg:mx-0"><div class="h-full relative flex-1 flex items-center gap-x-4 min-w-0 border-b border-gray-500/5 dark:border-gray-300/[0.06]"><div class="flex-1 flex items-center gap-x-4"><a href="https://infisical.com"><span class="sr-only">Infisical home page</span><img class="w-auto h-7 relative object-contain block dark:hidden" src="https://mintlify.s3.us-west-1.amazonaws.com/infisical/logo/light.svg" alt="light logo"/><img class="w-auto h-7 relative object-contain hidden dark:block" src="https://mintlify.s3.us-west-1.amazonaws.com/infisical/logo/dark.svg" alt="dark logo"/></a><div class="flex items-center gap-x-2"></div></div><div class="hidden lg:block mx-px relative flex-1 bg-white dark:bg-gray-900 pointer-events-auto rounded-lg min-w-0"><button type="button" class="w-full flex items-center text-sm leading-6 rounded-lg py-1.5 pl-3.5 pr-3 shadow-sm text-gray-400 dark:text-white/50 bg-background-light dark:bg-background-dark dark:brightness-[1.1] dark:ring-1 dark:hover:brightness-[1.25] ring-1 ring-gray-400/20 hover:ring-gray-600/25 dark:ring-gray-600/30 dark:hover:ring-gray-500/30 focus:outline-primary justify-between truncate gap-2 min-w-[43px]" id="search-bar-entry"><div class="flex items-center gap-3 min-w-[42px]"><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-search min-w-4 flex-none text-gray-700 hover:text-gray-800 dark:text-gray-300 hover:dark:text-gray-200"><circle cx="11" cy="11" r="8"></circle><path d="m21 21-4.3-4.3"></path></svg><div class="truncate min-w-0">Search or ask...</div></div></button></div><div class="flex-1 relative hidden lg:flex items-center ml-auto justify-end space-x-4"><nav class="text-sm"><ul class="flex space-x-6 items-center"><li class="block lg:hidden"><a class="whitespace-nowrap font-medium text-gray-600 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" href="https://app.infisical.com/signup">Start for Free</a></li><li><a href="https://app.infisical.com/login" class="whitespace-nowrap font-medium text-gray-600 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" target="_blank">Log In</a></li><li class="whitespace-nowrap hidden lg:flex" id="topbar-cta-button"><a target="_blank" class="group px-4 py-1.5 relative inline-flex items-center text-sm font-medium" href="https://app.infisical.com/signup"><span class="absolute inset-0 bg-primary-dark dark:bg-primary-light/10 border-primary-light/30 rounded-full dark:border group-hover:opacity-[0.9] dark:group-hover:border-primary-light/60"></span><div class="mr-0.5 space-x-2.5 flex items-center"><span class="z-10 text-white dark:text-primary-light">Start for Free</span><svg width="3" height="24" viewBox="0 -9 3 24" class="h-5 rotate-0 overflow-visible text-white/90 dark:text-primary-light"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></a></li></ul></nav><div class="flex items-center"></div></div><div class="flex lg:hidden items-center gap-2"><button type="button" class="text-gray-500 w-8 h-8 flex items-center justify-center hover:text-gray-600 dark:text-gray-400 dark:hover:text-gray-300" id="search-bar-entry-mobile"><span class="sr-only">Search...</span><svg class="h-4 w-4 bg-gray-500 dark:bg-gray-400 hover:bg-gray-600 dark:hover:bg-gray-300" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/magnifying-glass.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center"></svg></button><button aria-label="More actions" class="h-7 w-5 flex items-center justify-end"><svg class="h-4 w-4 bg-gray-500 dark:bg-gray-400 hover:bg-gray-600 dark:hover:bg-gray-300" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/ellipsis-vertical.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center"></svg></button></div></div></div><div class="flex items-center h-14 py-4 px-5 lg:hidden"><button type="button" class="text-gray-500 hover:text-gray-600 dark:text-gray-400 dark:hover:text-gray-300"><span class="sr-only">Navigation</span><svg class="h-4" fill="currentColor" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M0 96C0 78.3 14.3 64 32 64H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32C14.3 128 0 113.7 0 96zM0 256c0-17.7 14.3-32 32-32H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32c-17.7 0-32-14.3-32-32zM448 416c0 17.7-14.3 32-32 32H32c-17.7 0-32-14.3-32-32s14.3-32 32-32H416c17.7 0 32 14.3 32 32z"></path></svg></button><div class="ml-4 flex text-sm leading-6 whitespace-nowrap min-w-0 space-x-3"><div class="flex items-center space-x-3"><span>SDK's</span><svg width="3" height="24" viewBox="0 -9 3 24" class="h-5 rotate-0 overflow-visible fill-gray-400"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div><div class="font-semibold text-gray-900 truncate dark:text-gray-200">Infisical Node.js SDK</div></div></div></div><div class="hidden lg:flex px-12 h-12"><div class="h-full flex text-sm space-x-6"><a class="group relative h-full flex items-center font-medium text-gray-600 dark:text-gray-400 group-hover:text-gray-800 dark:group-hover:text-gray-300" href="/docs/documentation/getting-started/introduction">Documentation<div class="absolute bottom-0 h-[1.5px] w-full group-hover:bg-gray-200 dark:group-hover:bg-gray-700"></div></a><a class="group relative h-full flex items-center font-medium text-gray-600 dark:text-gray-400 group-hover:text-gray-800 dark:group-hover:text-gray-300" href="/docs/integrations/platforms/kubernetes">Integrations<div class="absolute bottom-0 h-[1.5px] w-full group-hover:bg-gray-200 dark:group-hover:bg-gray-700"></div></a><a class="group relative h-full flex items-center font-medium text-gray-600 dark:text-gray-400 group-hover:text-gray-800 dark:group-hover:text-gray-300" href="/docs/cli/overview">CLI<div class="absolute bottom-0 h-[1.5px] w-full group-hover:bg-gray-200 dark:group-hover:bg-gray-700"></div></a><a class="group relative h-full flex items-center font-medium text-gray-600 dark:text-gray-400 group-hover:text-gray-800 dark:group-hover:text-gray-300" href="/docs/api-reference/overview/introduction">API Reference<div class="absolute bottom-0 h-[1.5px] w-full group-hover:bg-gray-200 dark:group-hover:bg-gray-700"></div></a><a class="group relative h-full flex items-center text-gray-800 dark:text-gray-200 font-semibold" href="/docs/sdks/overview">SDKs<div class="absolute bottom-0 h-[1.5px] w-full bg-primary dark:bg-primary-light"></div></a><a class="group relative h-full flex items-center font-medium text-gray-600 dark:text-gray-400 group-hover:text-gray-800 dark:group-hover:text-gray-300" href="/docs/changelog/overview">Changelog<div class="absolute bottom-0 h-[1.5px] w-full group-hover:bg-gray-200 dark:group-hover:bg-gray-700"></div></a></div></div></div></div></div><div class="px-4 mx-auto max-w-8xl lg:px-8 min-h-screen"><div class="z-20 hidden lg:block fixed bottom-0 right-auto w-[18rem] top-[7.1rem]" id="sidebar"><div class="absolute inset-0 z-10 stable-scrollbar-gutter overflow-auto pr-8 pb-10" id="sidebar-content"><div class="relative lg:text-sm lg:leading-6"><div class="sticky top-0 h-8 bg-gradient-to-b from-background-light dark:from-background-dark"></div><div id="navigation-items"><div class=""><h5 class="pl-4 mb-3.5 lg:mb-2.5 font-semibold text-gray-900 dark:text-gray-200"></h5><ul><li id="/sdks/overview" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light space-x-3 rounded-lg hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/sdks/overview"><div class="flex-1 flex items-center space-x-2.5"><div>Introduction</div></div></a></li></ul></div><div class="mt-12 lg:mt-8"><h5 class="pl-4 mb-3.5 lg:mb-2.5 font-semibold text-gray-900 dark:text-gray-200">SDK's</h5><ul><li id="https://github.com/Infisical/node-sdk-v2" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light space-x-3 rounded-lg bg-primary/10 text-primary font-semibold dark:text-primary-light dark:bg-primary-light/10" style="padding-left:1rem" target="_blank" href="https://github.com/Infisical/node-sdk-v2"><svg class="h-4 w-4 bg-primary dark:bg-primary-light" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/node.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>Node.js</div><svg class="h-2.5 text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512" fill="currentColor"><path d="M328 96c13.3 0 24 10.7 24 24V360c0 13.3-10.7 24-24 24s-24-10.7-24-24V177.9L73 409c-9.4 9.4-24.6 9.4-33.9 0s-9.4-24.6 0-33.9l231-231H88c-13.3 0-24-10.7-24-24s10.7-24 24-24H328z"></path></svg></div></a></li><li id="https://github.com/Infisical/python-sdk-official?tab=readme-ov-file#infisical-python-sdk" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light space-x-3 rounded-lg hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" target="_blank" href="https://github.com/Infisical/python-sdk-official?tab=readme-ov-file#infisical-python-sdk"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/python.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>Python</div><svg class="h-2.5 text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512" fill="currentColor"><path d="M328 96c13.3 0 24 10.7 24 24V360c0 13.3-10.7 24-24 24s-24-10.7-24-24V177.9L73 409c-9.4 9.4-24.6 9.4-33.9 0s-9.4-24.6 0-33.9l231-231H88c-13.3 0-24-10.7-24-24s10.7-24 24-24H328z"></path></svg></div></a></li><li id="/sdks/languages/go" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light space-x-3 rounded-lg hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/sdks/languages/go"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/golang.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>Go</div></div></a></li><li id="/sdks/languages/ruby" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light space-x-3 rounded-lg hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/sdks/languages/ruby"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/diamond.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>Ruby</div></div></a></li><li id="/sdks/languages/java" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light space-x-3 rounded-lg hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/sdks/languages/java"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/java.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>Java</div></div></a></li><li id="/sdks/languages/csharp" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light space-x-3 rounded-lg hover:bg-gray-600/5 dark:hover:bg-gray-200/5 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/sdks/languages/csharp"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/bars.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>.NET</div></div></a></li></ul></div></div></div></div></div><div class="" id="content-container"><div class="flex flex-row gap-12 box-border w-full pt-40 lg:pt-10"><div class="relative grow box-border flex-col w-full mx-auto px-1 lg:pl-[23.7rem] lg:-ml-12 xl:w-[calc(100%-28rem)]" id="content-area"><header id="header" class="relative"><div class="mt-0.5 space-y-2.5"><div class="eyebrow h-5 text-primary dark:text-primary-light text-sm font-semibold">SDK's</div><div class="flex items-center"><h1 class="inline-block text-2xl sm:text-3xl font-extrabold text-gray-900 tracking-tight dark:text-gray-200">Infisical Node.js SDK</h1></div></div></header><div class="flex flex-col gap-8"><div class="flex flex-col gap-6 xl:hidden [&:not(:empty)]:mt-8"></div></div><div class="relative mt-8 prose prose-gray dark:prose-invert"></div><div class="leading-6 mt-14"><div class="pb-16 w-full"><div class="flex flex-col gap-y-4 xl:flex-col xl:gap-6 min-[1400px]:flex-row md:flex-row md:justify-end"><div class="flex flex-row gap-5 items-center grow justify-between md:justify-start xl:justify-between min-[1400px]:justify-start"><p class="text-sm text-gray-600 dark:text-gray-400">Was this page helpful?</p><div class="flex flex-row gap-3 items-center"><button class="px-[14px] py-2 flex flex-row gap-[10px] items-center border rounded-lg text-gray-600 dark:text-gray-400 hover:text-gray-700 dark:hover:text-gray-300 bg-white/50 border-gray-200 dark:border-gray-800 dark:bg-codeblock/50 hover:border-gray-400 hover:dark:border-gray-500"><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16" class="fill-current"><path d="M10.1187 1.08741C8.925 0.746789 7.67813 1.43741 7.3375 2.63116L7.15938 3.25616C7.04375 3.66241 6.83438 4.03741 6.55 4.34991L4.94688 6.11241C4.66875 6.41866 4.69062 6.89366 4.99687 7.17179C5.30312 7.44991 5.77813 7.42804 6.05625 7.12179L7.65938 5.35929C8.1 4.87491 8.42188 4.29679 8.6 3.66866L8.77812 3.04366C8.89062 2.64679 9.30625 2.41554 9.70625 2.52804C10.1063 2.64054 10.3344 3.05616 10.2219 3.45616L10.0437 4.08116C9.86562 4.70304 9.58437 5.29054 9.2125 5.81554C9.05 6.04366 9.03125 6.34366 9.15938 6.59366C9.2875 6.84366 9.54375 6.99991 9.825 6.99991H14C14.275 6.99991 14.5 7.22491 14.5 7.49991C14.5 7.71241 14.3656 7.89679 14.175 7.96866C13.9438 8.05616 13.7688 8.24992 13.7094 8.49054C13.65 8.73117 13.7125 8.98429 13.875 9.16866C13.9531 9.25616 14 9.37179 14 9.49991C14 9.74366 13.825 9.94679 13.5938 9.99054C13.3375 10.0405 13.1219 10.2187 13.0312 10.4624C12.9406 10.7062 12.9813 10.9843 13.1438 11.1905C13.2094 11.2749 13.25 11.3812 13.25 11.4999C13.25 11.7093 13.1187 11.8937 12.9312 11.9655C12.5719 12.1062 12.3781 12.4937 12.4812 12.8655C12.4937 12.9062 12.5 12.953 12.5 12.9999C12.5 13.2749 12.275 13.4999 12 13.4999H8.95312C8.55937 13.4999 8.17188 13.3843 7.84375 13.1655L5.91563 11.8812C5.57188 11.6499 5.10625 11.7437 4.875 12.0905C4.64375 12.4374 4.7375 12.8999 5.08437 13.1312L7.0125 14.4155C7.5875 14.7999 8.2625 15.003 8.95312 15.003H12C13.0844 15.003 13.9656 14.1405 14 13.0655C14.4563 12.6999 14.75 12.1374 14.75 11.503C14.75 11.3624 14.7344 11.228 14.7094 11.0968C15.1906 10.7312 15.5 10.153 15.5 9.50304C15.5 9.29991 15.4688 9.10304 15.4125 8.91866C15.775 8.55304 16 8.05304 16 7.49991C16 6.39679 15.1063 5.49991 14 5.49991H11.1156C11.2625 5.17491 11.3875 4.83741 11.4844 4.49366L11.6625 3.86866C12.0031 2.67491 11.3125 1.42804 10.1187 1.08741ZM1 5.99991C0.446875 5.99991 0 6.44679 0 6.99991V13.9999C0 14.553 0.446875 14.9999 1 14.9999H3C3.55313 14.9999 4 14.553 4 13.9999V6.99991C4 6.44679 3.55313 5.99991 3 5.99991H1Z"></path></svg><small class="text-sm font-normal leading-4 ">Yes</small></button><button class="px-[14px] py-2 flex flex-row gap-[10px] items-center border rounded-lg text-gray-600 dark:text-gray-400 hover:text-gray-700 dark:hover:text-gray-300 bg-white/50 border-gray-200 dark:border-gray-800 dark:bg-codeblock/50 hover:border-gray-400 hover:dark:border-gray-500"><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16" class="fill-current"><path d="M10.1187 14.9124C8.925 15.253 7.67813 14.5624 7.3375 13.3687L7.15938 12.7437C7.04375 12.3374 6.83438 11.9624 6.55 11.6499L4.94688 9.8874C4.66875 9.58115 4.69062 9.10615 4.99687 8.82803C5.30312 8.5499 5.77813 8.57178 6.05625 8.87803L7.65938 10.6405C8.1 11.1249 8.42188 11.703 8.6 12.3312L8.77812 12.9562C8.89062 13.353 9.30625 13.5843 9.70625 13.4718C10.1063 13.3593 10.3344 12.9437 10.2219 12.5437L10.0437 11.9187C9.86562 11.2968 9.58437 10.7093 9.2125 10.1843C9.05 9.95615 9.03125 9.65615 9.15938 9.40615C9.2875 9.15615 9.54375 8.9999 9.825 8.9999H14C14.275 8.9999 14.5 8.7749 14.5 8.4999C14.5 8.2874 14.3656 8.10303 14.175 8.03115C13.9438 7.94365 13.7688 7.7499 13.7094 7.50928C13.65 7.26865 13.7125 7.01553 13.875 6.83115C13.9531 6.74365 14 6.62803 14 6.4999C14 6.25615 13.825 6.05303 13.5938 6.00928C13.3375 5.95928 13.1219 5.78115 13.0312 5.53428C12.9406 5.2874 12.9813 5.0124 13.1438 4.80615C13.2094 4.72178 13.25 4.61553 13.25 4.49678C13.25 4.2874 13.1187 4.10303 12.9312 4.03115C12.5719 3.89053 12.3781 3.50303 12.4812 3.13115C12.4937 3.09053 12.5 3.04365 12.5 2.99678C12.5 2.72178 12.275 2.49678 12 2.49678H8.95312C8.55937 2.49678 8.17188 2.6124 7.84375 2.83115L5.91563 4.11553C5.57188 4.34678 5.10625 4.25303 4.875 3.90615C4.64375 3.55928 4.7375 3.09678 5.08437 2.86553L7.0125 1.58115C7.5875 1.19678 8.2625 0.993652 8.95312 0.993652H12C13.0844 0.993652 13.9656 1.85615 14 2.93115C14.4563 3.29678 14.75 3.85928 14.75 4.49365C14.75 4.63428 14.7344 4.76865 14.7094 4.8999C15.1906 5.26553 15.5 5.84365 15.5 6.49365C15.5 6.69678 15.4688 6.89365 15.4125 7.07803C15.775 7.44678 16 7.94678 16 8.4999C16 9.60303 15.1063 10.4999 14 10.4999H11.1156C11.2625 10.8249 11.3875 11.1624 11.4844 11.5062L11.6625 12.1312C12.0031 13.3249 11.3125 14.5718 10.1187 14.9124ZM1 11.9999C0.446875 11.9999 0 11.553 0 10.9999V3.9999C0 3.44678 0.446875 2.9999 1 2.9999H3C3.55313 2.9999 4 3.44678 4 3.9999V10.9999C4 11.553 3.55313 11.9999 3 11.9999H1Z"></path></svg><small class="text-sm font-normal leading-4 ">No</small></button></div></div><div class="flex flex-row gap-3 justify-end"></div></div></div><div class="mb-12 px-0.5 flex items-center text-sm font-semibold text-gray-700 dark:text-gray-200"><a class="flex items-center space-x-3 group" href="/docs/sdks/overview"><svg viewBox="0 0 3 6" class="h-1.5 stroke-gray-400 overflow-visible group-hover:stroke-gray-600 dark:group-hover:stroke-gray-300"><path d="M3 0L0 3L3 6" fill="none" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="group-hover:text-gray-900 dark:group-hover:text-white">Introduction</span></a><a class="flex items-center ml-auto space-x-3 group" href="/docs/sdks/languages/python"><span class="group-hover:text-gray-900 dark:group-hover:text-white">Python</span><svg viewBox="0 0 3 6" class="rotate-180 h-1.5 stroke-gray-400 overflow-visible group-hover:stroke-gray-600 dark:group-hover:stroke-gray-300"><path d="M3 0L0 3L3 6" fill="none" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"></path></svg></a></div></div></div><div class="z-10 hidden xl:flex pl-10 box-border w-[19rem]" id="table-of-contents"></div></div></div></div><footer id="footer" class="flex flex-col items-center mx-auto border-t border-gray-100 dark:border-gray-800/50"><div class="flex w-full flex-col gap-12 justify-between px-8 py-16 md:py-20 lg:py-28 max-w-[984px] z-0"><div class="flex flex-col md:flex-row gap-8 justify-between min-h-[76px]"><div class="flex md:flex-col justify-between items-center md:items-start min-w-16 md:min-w-20 lg:min-w-48 md:gap-y-24"><a href="https://infisical.com"><span class="sr-only">Infisical home page</span><img class="w-auto relative object-contain block dark:hidden max-w-48 h-[26px]" src="https://mintlify.s3.us-west-1.amazonaws.com/infisical/logo/light.svg" alt="light logo"/><img class="w-auto relative object-contain hidden dark:block max-w-48 h-[26px]" src="https://mintlify.s3.us-west-1.amazonaws.com/infisical/logo/dark.svg" alt="dark logo"/></a><div class="gap-3 min-w-[140px] h-fit flex justify-end md:justify-start"><a href="https://www.twitter.com/infisical/" target="_blank"><span class="sr-only">x</span><svg class="w-5 h-5 bg-gray-500 dark:bg-gray-600 hover:bg-gray-600 dark:hover:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/x-twitter.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center"></svg></a><a href="https://www.linkedin.com/company/infisical/" target="_blank"><span class="sr-only">linkedin</span><svg class="w-5 h-5 bg-gray-500 dark:bg-gray-600 hover:bg-gray-600 dark:hover:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/linkedin.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center"></svg></a><a href="https://github.com/Infisical/infisical-cli" target="_blank"><span class="sr-only">github</span><svg class="w-5 h-5 bg-gray-500 dark:bg-gray-600 hover:bg-gray-600 dark:hover:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/github.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center"></svg></a><a href="https://infisical.com/slack" target="_blank"><span class="sr-only">slack</span><svg class="w-5 h-5 bg-gray-500 dark:bg-gray-600 hover:bg-gray-600 dark:hover:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/slack.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center"></svg></a></div></div><div class="flex flex-col sm:grid max-md:!grid-cols-2 gap-8 flex-1" style="grid-template-columns:repeat(4, minmax(0, 1fr))"><div class="flex flex-col gap-4 flex-1 whitespace-nowrap w-full md:items-center"><div class="flex gap-4 flex-col"><p class="text-sm font-semibold text-gray-950 dark:text-white mb-1">PRODUCT</p><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/" target="_blank" rel="noreferrer">Secret Management</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/radar" target="_blank" rel="noreferrer">Secret Scanning</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://app.infisical.com/share-secret" target="_blank" rel="noreferrer">Share Secrets</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/pricing" target="_blank" rel="noreferrer">Pricing</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/docs/internals/security" target="_blank" rel="noreferrer">Security</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/blog" target="_blank" rel="noreferrer">Blog</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/infisical-vs-hashicorp-vault" target="_blank" rel="noreferrer">Infisical vs Vault</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://questions.infisical.com/" target="_blank" rel="noreferrer">Forum</a></div></div><div class="flex flex-col gap-4 flex-1 whitespace-nowrap w-full md:items-center"><div class="flex gap-4 flex-col"><p class="text-sm font-semibold text-gray-950 dark:text-white mb-1">USE CASES</p><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/docs/documentation/getting-started/introduction" target="_blank" rel="noreferrer">Infisical Agent</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/docs/integrations/platforms/kubernetes" target="_blank" rel="noreferrer">Kubernetes</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/docs/documentation/platform/dynamic-secrets/overview" target="_blank" rel="noreferrer">Dynamic Secrets</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/docs/integrations/frameworks/terraform" target="_blank" rel="noreferrer">Terraform</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/docs/integrations/platforms/ansible" target="_blank" rel="noreferrer">Ansible</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/docs/integrations/cicd/jenkins" target="_blank" rel="noreferrer">Jenkins</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/docs/integrations/platforms/docker-intro" target="_blank" rel="noreferrer">Docker</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/docs/integrations/platforms/ecs-with-agent" target="_blank" rel="noreferrer">AWS ECS</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/docs/integrations/cicd/gitlab" target="_blank" rel="noreferrer">GitLab</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/docs/integrations/cicd/githubactions" target="_blank" rel="noreferrer">GitHub</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/docs/sdks/overview" target="_blank" rel="noreferrer">SDK</a></div></div><div class="flex flex-col gap-4 flex-1 whitespace-nowrap w-full md:items-center"><div class="flex gap-4 flex-col"><p class="text-sm font-semibold text-gray-950 dark:text-white mb-1">DEVELOPERS</p><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://www.infisical.com/docs/changelog" target="_blank" rel="noreferrer">Changelog</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://status.infisical.com/" target="_blank" rel="noreferrer">Status</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://github.com/Infisical/infisical/issues" target="_blank" rel="noreferrer">Feedback & Requests</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://app.vanta.com/infisical.com/trust/hoop8cr78cuarxo9sztvs" target="_blank" rel="noreferrer">Trust of Center</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/infisical-friends" target="_blank" rel="noreferrer">Open Source Friends</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://www.infisical.com/infisical-heroes" target="_blank" rel="noreferrer">How to contribute</a></div></div><div class="flex flex-col gap-4 flex-1 whitespace-nowrap w-full md:items-center"><div class="flex gap-4 flex-col"><p class="text-sm font-semibold text-gray-950 dark:text-white mb-1">OTHERS</p><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/customers/traba" target="_blank" rel="noreferrer">Customers</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/wiki/handbook/overview" target="_blank" rel="noreferrer">Company Handbook</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/careers" target="_blank" rel="noreferrer">Careers</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/terms" target="_blank" rel="noreferrer">Terms of Service</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/privacy" target="_blank" rel="noreferrer">Privacy Policy</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/subprocessors" target="_blank" rel="noreferrer">Subprocessors</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/sla" target="_blank" rel="noreferrer">SLA</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="/cdn-cgi/l/email-protection#ccb8a9ada18ca5a2aaa5bfa5afada0e2afa3a1" target="_self" rel="noreferrer">Team Email</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="/cdn-cgi/l/email-protection#c2b1a3aea7b182abaca4abb1aba1a3aeeca1adaf" target="_self" rel="noreferrer">Sales</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://infisical.com/slack" target="_blank" rel="noreferrer">Support</a></div></div></div></div><div class="h-[1px] w-full bg-gray-100 dark:bg-white/5"></div><div class="flex items-center justify-between"><div class="sm:flex"><a href="https://mintlify.com/preview-request?utm_campaign=poweredBy&utm_medium=docs&utm_source=infisical" target="_blank" rel="noreferrer" class="text-sm text-gray-500 dark:text-gray-400 hover:text-gray-700 dark:hover:text-gray-300">Powered by Mintlify</a></div></div></div></footer></div></main></div><script data-cfasync="false" src="/cdn-cgi/scripts/5c5dd728/cloudflare-static/email-decode.min.js"></script><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"mdxSource":{"compiledSource":"/*@jsxRuntime automatic @jsxImportSource react*/\n/*\nIf you're working with Node.js, the official [Infisical Node SDK](https://github.com/Infisical/sdk/tree/main/languages/node) package is the easiest way to fetch and work with secrets for your application.\n\n- [NPM Package](https://www.npmjs.com/package/@infisical/sdk)\n- [Github Repository](https://github.com/Infisical/sdk/tree/main/languages/node)\n\n## Basic Usage\n\n```js\nimport express from \"express\";\n\nimport { InfisicalClient } from \"@infisical/sdk\";\n\nconst app = express();\n\nconst PORT = 3000;\n\nconst client = new InfisicalClient({\nsiteUrl: \"https://app.infisical.com\", // Optional, defaults to https://app.infisical.com\nauth: {\nuniversalAuth: {\nclientId: \"YOUR_CLIENT_ID\",\nclientSecret: \"YOUR_CLIENT_SECRET\"\n}\n}\n});\n\napp.get(\"/\", async (req, res) =\u003e {\n// Access the secret\n\nconst name = await client.getSecret({\nenvironment: \"dev\",\nprojectId: \"PROJECT_ID\",\npath: \"/\",\ntype: \"shared\",\nsecretName: \"NAME\"\n});\n\nres.send(`Hello! My name is: ${name.secretValue}`);\n});\n\napp.listen(PORT, async () =\u003e {\n// initialize client\n\nconsole.log(`App listening on port ${PORT}`);\n});\n```\n\nThis example demonstrates how to use the Infisical Node SDK with an Express application. The application retrieves a secret named \"NAME\" and responds to requests with a greeting that includes the secret value.\n\n\u003cWarning\u003e\nWe do not recommend hardcoding your [Machine Identity Tokens](/documentation/platform/identities/overview). Setting it as an environment variable\nwould be best.\n\u003c/Warning\u003e\n\n## Installation\n\nRun `npm` to add `@infisical/sdk` to your project.\n\n```console\n$ npm install @infisical/sdk\n```\n\n## Configuration\n\nImport the SDK and create a client instance with your [Machine Identity](/documentation/platform/identities/overview).\n\n\u003cTabs\u003e\n\u003cTab title=\"ES6\"\u003e\n```js\nimport { InfisicalClient, LogLevel } from \"@infisical/sdk\";\n\nconst client = new InfisicalClient({\nauth: {\nuniversalAuth: {\nclientId: \"YOUR_CLIENT_ID\",\nclientSecret: \"YOUR_CLIENT_SECRET\"\n}\n},\nlogLevel: LogLevel.Error\n});\n```\n\n\u003c/Tab\u003e\n\u003cTab title=\"ES5\"\u003e\n```js\nconst { InfisicalClient } = require(\"@infisical/sdk\");\n\nconst client = new InfisicalClient({\nauth: {\nuniversalAuth: {\nclientId: \"YOUR_CLIENT_ID\",\nclientSecret: \"YOUR_CLIENT_SECRET\"\n}\n},\n});\n```\n\n\u003c/Tab\u003e\n\u003c/Tabs\u003e\n\n### Parameters\n\n\u003cParamField query=\"options\" type=\"object\"\u003e\n\u003cExpandable title=\"properties\"\u003e\n\u003cParamField query=\"clientId\" deprecated type=\"string\" optional\u003e\nYour machine identity client ID.\n\n**This field is deprecated and will be removed in future versions.** Please use the `auth.universalAuth.clientId` field instead.\n\u003c/ParamField\u003e\n\u003cParamField query=\"clientSecret\" deprecated type=\"string\" optional\u003e\nYour machine identity client secret.\n\n**This field is deprecated and will be removed in future versions.** Please use the `auth.universalAuth.clientSecret` field instead.\n\u003c/ParamField\u003e\n\n\u003cParamField query=\"accessToken\" deprecated type=\"string\" optional\u003e\nAn access token obtained from the machine identity login endpoint.\n\n**This field is deprecated and will be removed in future versions.** Please use the `auth.accessToken` field instead.\n\u003c/ParamField\u003e\n\n\u003cParamField query=\"cacheTtl\" type=\"number\" default=\"300\" optional\u003e\nTime-to-live (in seconds) for refreshing cached secrets.\nIf manually set to 0, caching will be disabled, this is not recommended.\n\u003c/ParamField\u003e\n\n\u003cParamField query=\"siteUrl\" type=\"string\" default=\"https://app.infisical.com\" optional\u003e\nYour self-hosted absolute site URL including the protocol (e.g. `https://app.infisical.com`)\n\u003c/ParamField\u003e\n\u003cParamField query=\"logLevel\" type=\"enum\" default=\"Error\" optional\u003e\nThe level of logs you wish to log The logs are derived from Rust, as we have written our base SDK in Rust.\n\u003c/ParamField\u003e\n\n\u003cParamField query=\"sslCertificatePath\" optional\u003e\nOptionally provide a path to a custom SSL certificate file. This can be substituted by setting the `INFISICAL_SSL_CERTIFICATE` environment variable to the contents of the certificate.\n\u003c/ParamField\u003e\n\n\u003cParamField query=\"auth\" type=\"AuthenticationOptions\"\u003e\nThe authentication object to use for the client. This is required unless you're using environment variables.\n\u003c/ParamField\u003e\n\u003c/Expandable\u003e\n\n\u003c/ParamField\u003e\n\n\n### Authentication\n\nThe SDK supports a variety of authentication methods. The most common authentication method is Universal Auth, which uses a client ID and client secret to authenticate.\n\n#### Universal Auth\n\n**Using environment variables**\n- `INFISICAL_UNIVERSAL_AUTH_CLIENT_ID` - Your machine identity client ID.\n- `INFISICAL_UNIVERSAL_AUTH_CLIENT_SECRET` - Your machine identity client secret.\n\n**Using the SDK directly**\n```js\nconst client = new InfisicalClient({\nauth: {\nuniversalAuth: {\nclientId: \"YOUR_CLIENT_ID\",\nclientSecret: \"YOUR_CLIENT_SECRET\"\n}\n}\n});\n```\n\n#### GCP ID Token Auth\n\u003cInfo\u003e\nPlease note that this authentication method will only work if you're running your application on Google Cloud Platform.\nPlease [read more](/documentation/platform/identities/gcp-auth) about this authentication method.\n\u003c/Info\u003e\n\n**Using environment variables**\n- `INFISICAL_GCP_AUTH_IDENTITY_ID` - Your Infisical Machine Identity ID.\n\n**Using the SDK directly**\n```js\nconst client = new InfisicalClient({\nauth: {\ngcpIdToken: {\nidentityId: \"YOUR_IDENTITY_ID\"\n}\n}\n});\n```\n\n#### GCP IAM Auth\n\n**Using environment variables**\n- `INFISICAL_GCP_IAM_AUTH_IDENTITY_ID` - Your Infisical Machine Identity ID.\n- `INFISICAL_GCP_IAM_SERVICE_ACCOUNT_KEY_FILE_PATH` - The path to your GCP service account key file.\n\n**Using the SDK directly**\n```js\nconst client = new InfisicalClient({\nauth: {\ngcpIam: {\nidentityId: \"YOUR_IDENTITY_ID\",\nserviceAccountKeyFilePath: \"./path/to/your/service-account-key.json\"\n}\n}\n});\n```\n\n#### AWS IAM Auth\n\u003cInfo\u003e\nPlease note that this authentication method will only work if you're running your application on AWS.\nPlease [read more](/documentation/platform/identities/aws-auth) about this authentication method.\n\u003c/Info\u003e\n\n**Using environment variables**\n- `INFISICAL_AWS_IAM_AUTH_IDENTITY_ID` - Your Infisical Machine Identity ID.\n\n**Using the SDK directly**\n```js\nconst client = new InfisicalClient({\nauth: {\nawsIam: {\nidentityId: \"YOUR_IDENTITY_ID\"\n}\n}\n});\n```\n\n#### Azure Auth\n\u003cInfo\u003e\nPlease note that this authentication method will only work if you're running your application on Azure.\nPlease [read more](/documentation/platform/identities/azure-auth) about this authentication method.\n\u003c/Info\u003e\n\n**Using environment variables**\n- `INFISICAL_AZURE_AUTH_IDENTITY_ID` - Your Infisical Machine Identity ID.\n\n**Using the SDK directly**\n```js\nconst client = new InfisicalClient({\nauth: {\nazure: {\nidentityId: \"YOUR_IDENTITY_ID\"\n}\n}\n});\n```\n\n\n#### Kubernetes Auth\n\u003cInfo\u003e\nPlease note that this authentication method will only work if you're running your application on Kubernetes.\nPlease [read more](/documentation/platform/identities/kubernetes-auth) about this authentication method.\n\u003c/Info\u003e\n\n**Using environment variables**\n- `INFISICAL_KUBERNETES_IDENTITY_ID` - Your Infisical Machine Identity ID.\n- `INFISICAL_KUBERNETES_SERVICE_ACCOUNT_TOKEN_PATH_ENV_NAME` - The environment variable name that contains the path to the service account token. This is optional and will default to `/var/run/secrets/kubernetes.io/serviceaccount/token`.\n\n**Using the SDK directly**\n```js\nconst client = new InfisicalClient({\nauth: {\nkubernetes: {\nidentityId: \"YOUR_IDENTITY_ID\",\nserviceAccountTokenPathEnvName: \"/var/run/secrets/kubernetes.io/serviceaccount/token\" // Optional\n}\n}\n});\n```\n\n### Caching\n\nTo reduce the number of API requests, the SDK temporarily stores secrets it retrieves. By default, a secret remains cached for 5 minutes after it's first fetched. Each time it's fetched again, this 5-minute timer resets. You can adjust this caching duration by setting the \"cacheTtl\" option when creating the client.\n\n## Working with Secrets\n\n### client.listSecrets(options)\n\n```js\nconst secrets = await client.listSecrets({\nenvironment: \"dev\",\nprojectId: \"PROJECT_ID\",\npath: \"/foo/bar/\",\nincludeImports: false\n});\n```\n\nRetrieve all secrets within the Infisical project and environment that client is connected to\n\n#### Parameters\n\n\u003cParamField query=\"Parameters\" type=\"object\"\u003e\n\u003cExpandable title=\"properties\"\u003e\n\u003cParamField query=\"environment\" type=\"string\" required\u003e\nThe slug name (dev, prod, etc) of the environment from where secrets should be fetched from.\n\u003c/ParamField\u003e\n\u003cParamField query=\"projectId\" type=\"string\" required\u003e\nThe project ID where the secret lives in.\n\u003c/ParamField\u003e\n\n\u003cParamField query=\"path\" type=\"string\" optional\u003e\nThe path from where secrets should be fetched from.\n\u003c/ParamField\u003e\n\n\u003cParamField query=\"attachToProcessEnv\" type=\"boolean\" default=\"false\" optional\u003e\nWhether or not to set the fetched secrets to the process environment. If true, you can access the secrets like so `process.env[\"SECRET_NAME\"]`.\n\u003c/ParamField\u003e\n\n\u003cParamField query=\"recursive\" type=\"boolean\" default=\"false\" optional\u003e\nWhether or not to fetch secrets recursively from the specified path. Please note that there's a 20-depth limit for recursive fetching.\n\u003c/ParamField\u003e\n\n\u003cParamField query=\"expandSecretReferences\" type=\"boolean\" default=\"true\" optional\u003e\nWhether or not to expand secret references in the fetched secrets. Read about [secret reference](/documentation/platform/secret-reference)\n\u003c/ParamField\u003e\n\n\u003cParamField query=\"includeImports\" type=\"false\" default=\"boolean\" optional\u003e\nWhether or not to include imported secrets from the current path. Read about [secret import](/documentation/platform/secret-reference)\n\u003c/ParamField\u003e\n\u003c/Expandable\u003e\n\n\u003c/ParamField\u003e\n\n### client.getSecret(options)\n\n```js\nconst secret = await client.getSecret({\nenvironment: \"dev\",\nprojectId: \"PROJECT_ID\",\nsecretName: \"API_KEY\",\npath: \"/\",\ntype: \"shared\"\n});\n```\n\nRetrieve a secret from Infisical.\n\nBy default, `getSecret()` fetches and returns a shared secret.\n\n#### Parameters\n\n\u003cParamField query=\"Parameters\" type=\"object\" optional\u003e\n\u003cExpandable title=\"properties\"\u003e\n\u003cParamField query=\"secretName\" type=\"string\" required\u003e\nThe key of the secret to retrieve.\n\u003c/ParamField\u003e\n\u003cParamField query=\"projectId\" type=\"string\" required\u003e\nThe project ID where the secret lives in.\n\u003c/ParamField\u003e\n\u003cParamField query=\"environment\" type=\"string\" required\u003e\nThe slug name (dev, prod, etc) of the environment from where secrets should be fetched from.\n\u003c/ParamField\u003e\n\u003cParamField query=\"path\" type=\"string\" optional\u003e\nThe path from where secret should be fetched from.\n\u003c/ParamField\u003e\n\u003cParamField query=\"type\" type=\"string\" optional\u003e\nThe type of the secret. Valid options are \"shared\" or \"personal\". If not specified, the default value is \"shared\".\n\u003c/ParamField\u003e\n\u003cParamField query=\"includeImports\" type=\"boolean\" optional\u003e\nWhether or not to include imported secrets from the current path. Read about [secret import](/documentation/platform/secret-reference)\n\u003c/ParamField\u003e\n\u003cParamField query=\"expandSecretReferences\" type=\"boolean\" default=\"true\" optional\u003e\nWhether or not to expand secret references in the fetched secrets. Read about [secret reference](/documentation/platform/secret-reference)\n\u003c/ParamField\u003e\n\u003c/Expandable\u003e\n\u003c/ParamField\u003e\n\n### client.createSecret(options)\n\n```js\nconst newApiKey = await client.createSecret({\nprojectId: \"PROJECT_ID\",\nenvironment: \"dev\",\nsecretName: \"API_KEY\",\nsecretValue: \"SECRET VALUE\",\npath: \"/\",\ntype: \"shared\"\n});\n```\n\nCreate a new secret in Infisical.\n\n\u003cParamField query=\"Parameters\" type=\"object\" optional\u003e\n\u003cExpandable title=\"properties\"\u003e\n\u003cParamField query=\"secretName\" type=\"string\" required\u003e\nThe key of the secret to create.\n\u003c/ParamField\u003e\n\u003cParamField query=\"secretValue\" type=\"string\" required\u003e\nThe value of the secret.\n\u003c/ParamField\u003e\n\u003cParamField query=\"projectId\" type=\"string\" required\u003e\nThe project ID where the secret lives in.\n\u003c/ParamField\u003e\n\u003cParamField query=\"environment\" type=\"string\" required\u003e\nThe slug name (dev, prod, etc) of the environment from where secrets should be fetched from.\n\u003c/ParamField\u003e\n\u003cParamField query=\"path\" type=\"string\" optional\u003e\nThe path from where secret should be created.\n\u003c/ParamField\u003e\n\u003cParamField query=\"type\" type=\"string\" optional\u003e\nThe type of the secret. Valid options are \"shared\" or \"personal\". If not specified, the default value is \"shared\".\n\u003c/ParamField\u003e\n\u003c/Expandable\u003e\n\u003c/ParamField\u003e\n\n### client.updateSecret(options)\n\n```js\nconst updatedApiKey = await client.updateSecret({\nsecretName: \"API_KEY\",\nsecretValue: \"NEW SECRET VALUE\",\nprojectId: \"PROJECT_ID\",\nenvironment: \"dev\",\npath: \"/\",\ntype: \"shared\"\n});\n```\n\nUpdate an existing secret in Infisical.\n\n#### Parameters\n\n\u003cParamField query=\"Parameters\" type=\"object\" optional\u003e\n\u003cExpandable title=\"properties\"\u003e\n\u003cParamField query=\"secretName\" type=\"string\" required\u003e\nThe key of the secret to update.\n\u003c/ParamField\u003e\n\u003cParamField query=\"secretValue\" type=\"string\" required\u003e\nThe new value of the secret.\n\u003c/ParamField\u003e\n\u003cParamField query=\"projectId\" type=\"string\" required\u003e\nThe project ID where the secret lives in.\n\u003c/ParamField\u003e\n\u003cParamField query=\"environment\" type=\"string\" required\u003e\nThe slug name (dev, prod, etc) of the environment from where secrets should be fetched from.\n\u003c/ParamField\u003e\n\u003cParamField query=\"path\" type=\"string\" optional\u003e\nThe path from where secret should be updated.\n\u003c/ParamField\u003e\n\u003cParamField query=\"type\" type=\"string\" optional\u003e\nThe type of the secret. Valid options are \"shared\" or \"personal\". If not specified, the default value is \"shared\".\n\u003c/ParamField\u003e\n\u003c/Expandable\u003e\n\u003c/ParamField\u003e\n\n### client.deleteSecret(options)\n\n```js\nconst deletedSecret = await client.deleteSecret({\nsecretName: \"API_KEY\",\n\nenvironment: \"dev\",\nprojectId: \"PROJECT_ID\",\npath: \"/\",\n\ntype: \"shared\"\n});\n```\n\nDelete a secret in Infisical.\n\n\u003cParamField query=\"Parameters\" type=\"object\" optional\u003e\n\u003cExpandable title=\"properties\"\u003e\n\u003cParamField query=\"secretName\" type=\"string\"\u003e\nThe key of the secret to update.\n\u003c/ParamField\u003e\n\u003cParamField query=\"projectId\" type=\"string\" required\u003e\nThe project ID where the secret lives in.\n\u003c/ParamField\u003e\n\u003cParamField query=\"environment\" type=\"string\" required\u003e\nThe slug name (dev, prod, etc) of the environment from where secrets should be fetched from.\n\u003c/ParamField\u003e\n\u003cParamField query=\"path\" type=\"string\" optional\u003e\nThe path from where secret should be deleted.\n\u003c/ParamField\u003e\n\u003cParamField query=\"type\" type=\"string\" optional\u003e\nThe type of the secret. Valid options are \"shared\" or \"personal\". If not specified, the default value is \"shared\".\n\u003c/ParamField\u003e\n\u003c/Expandable\u003e\n\u003c/ParamField\u003e\n\n## Cryptography\n\n### Create a symmetric key\n\nCreate a base64-encoded, 256-bit symmetric key to be used for encryption/decryption.\n\n```js\nconst key = client.createSymmetricKey();\n```\n\n#### Returns (string)\n`key` (string): A base64-encoded, 256-bit symmetric key, that can be used for encryption/decryption purposes.\n\n### Encrypt symmetric\n```js\nconst { iv, tag, ciphertext } = await client.encryptSymmetric({\nkey: key,\nplaintext: \"Infisical is awesome!\",\n})\n```\n\n#### Parameters\n\n\u003cParamField query=\"Parameters\" type=\"object\" required\u003e\n\u003cExpandable title=\"properties\"\u003e\n\u003cParamField query=\"plaintext\" type=\"string\"\u003e\nThe plaintext you want to encrypt.\n\u003c/ParamField\u003e\n\u003cParamField query=\"key\" type=\"string\" required\u003e\nThe symmetric key to use for encryption.\n\u003c/ParamField\u003e\n\u003c/Expandable\u003e\n\u003c/ParamField\u003e\n\n#### Returns (object)\n`tag` (string): A base64-encoded, 128-bit authentication tag.\n`iv` (string): A base64-encoded, 96-bit initialization vector.\n`ciphertext` (string): A base64-encoded, encrypted ciphertext.\n\n### Decrypt symmetric\n```js\nconst decryptedString = await client.decryptSymmetric({\nkey: key,\niv: iv,\ntag: tag,\nciphertext: ciphertext,\n});\n```\n\n#### Parameters\n\u003cParamField query=\"Parameters\" type=\"object\" required\u003e\n\u003cExpandable title=\"properties\"\u003e\n\u003cParamField query=\"ciphertext\" type=\"string\"\u003e\nThe ciphertext you want to decrypt.\n\u003c/ParamField\u003e\n\u003cParamField query=\"key\" type=\"string\" required\u003e\nThe symmetric key to use for encryption.\n\u003c/ParamField\u003e\n\u003cParamField query=\"iv\" type=\"string\" required\u003e\nThe initialization vector to use for decryption.\n\u003c/ParamField\u003e\n\u003cParamField query=\"tag\" type=\"string\" required\u003e\nThe authentication tag to use for decryption.\n\u003c/ParamField\u003e\n\u003c/Expandable\u003e\n\u003c/ParamField\u003e\n\n#### Returns (string)\n`plaintext` (string): The decrypted plaintext.\n\n*/\nconst {Fragment: _Fragment, jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n return _jsx(_Fragment, {});\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = Object.assign({}, _provideComponents(), props.components);\n return MDXLayout ? _jsx(MDXLayout, Object.assign({}, props, {\n children: _jsx(_createMdxContent, props)\n })) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{"mintConfig":{"$schema":"https://mintlify.com/schema.json","name":"Infisical","logo":{"light":"https://mintlify.s3.us-west-1.amazonaws.com/infisical/logo/light.svg","dark":"https://mintlify.s3.us-west-1.amazonaws.com/infisical/logo/dark.svg","href":"https://infisical.com"},"favicon":"/favicon.png","openapi":"https://app.infisical.com/api/docs/json","api":{"baseUrl":["https://app.infisical.com","http://localhost:8080"]},"modeToggle":{"default":"light","isHidden":true},"colors":{"primary":"#26272b","light":"#97b31d","dark":"#A1B659","background":{"light":"#ffffff","dark":"#0D1117"},"anchors":{"from":"#000000","to":"#707174"},"ultraLight":"#E7F256","ultraDark":"#8D9F4C"},"topbarCtaButton":{"name":"Start for Free","url":"https://app.infisical.com/signup"},"topbarLinks":[{"url":"https://app.infisical.com/login","name":"Log In","_id":"6746db41cbe3178400aa60e4"}],"navigation":[{"group":"Getting Started","pages":["documentation/getting-started/introduction",{"group":"Quickstart","pages":["documentation/guides/local-development"]},{"group":"Guides","pages":["documentation/guides/introduction","documentation/guides/node","documentation/guides/python","documentation/guides/nextjs-vercel","documentation/guides/microsoft-power-apps","documentation/guides/organization-structure"]}]},{"group":"Platform","pages":["documentation/platform/organization","documentation/platform/project","documentation/platform/folder",{"group":"Secrets","pages":["documentation/platform/secret-versioning","documentation/platform/pit-recovery","documentation/platform/secret-reference","documentation/platform/webhooks"]},{"group":"Internal PKI","pages":["documentation/platform/pki/overview","documentation/platform/pki/private-ca","documentation/platform/pki/certificates","documentation/platform/pki/pki-issuer","documentation/platform/pki/est","documentation/platform/pki/alerting"]},{"group":"Key Management (KMS)","pages":["documentation/platform/kms/overview","documentation/platform/kms/hsm-integration","documentation/platform/kms/kubernetes-encryption"]},{"group":"KMS Configuration","pages":["documentation/platform/kms-configuration/overview","documentation/platform/kms-configuration/aws-kms","documentation/platform/kms-configuration/aws-hsm"]},{"group":"Identities","pages":["documentation/platform/identities/overview","documentation/platform/identities/user-identities","documentation/platform/identities/machine-identities"]},{"group":"Access Control","pages":["documentation/platform/access-controls/overview","documentation/platform/access-controls/role-based-access-controls","documentation/platform/access-controls/attribute-based-access-controls","documentation/platform/access-controls/additional-privileges","documentation/platform/access-controls/temporary-access","documentation/platform/access-controls/access-requests","documentation/platform/pr-workflows","documentation/platform/groups"]},{"group":"Audit Logs","pages":["documentation/platform/audit-logs","documentation/platform/audit-log-streams/audit-log-streams","documentation/platform/audit-log-streams/audit-log-streams-with-fluentbit"]},{"group":"Secret Rotation","pages":["documentation/platform/secret-rotation/overview","documentation/platform/secret-rotation/sendgrid","documentation/platform/secret-rotation/postgres","documentation/platform/secret-rotation/mysql","documentation/platform/secret-rotation/mssql","documentation/platform/secret-rotation/aws-iam"]},{"group":"Dynamic Secrets","pages":["documentation/platform/dynamic-secrets/overview","documentation/platform/dynamic-secrets/postgresql","documentation/platform/dynamic-secrets/mysql","documentation/platform/dynamic-secrets/mssql","documentation/platform/dynamic-secrets/oracle","documentation/platform/dynamic-secrets/cassandra","documentation/platform/dynamic-secrets/redis","documentation/platform/dynamic-secrets/aws-elasticache","documentation/platform/dynamic-secrets/elastic-search","documentation/platform/dynamic-secrets/rabbit-mq","documentation/platform/dynamic-secrets/aws-iam","documentation/platform/dynamic-secrets/mongo-atlas","documentation/platform/dynamic-secrets/mongo-db","documentation/platform/dynamic-secrets/azure-entra-id","documentation/platform/dynamic-secrets/ldap","documentation/platform/dynamic-secrets/sap-ase","documentation/platform/dynamic-secrets/sap-hana","documentation/platform/dynamic-secrets/snowflake","documentation/platform/dynamic-secrets/totp"]},"documentation/platform/project-templates",{"group":"Workflow Integrations","pages":["documentation/platform/workflow-integrations/slack-integration"]},{"group":"Admin Consoles","pages":["documentation/platform/admin-panel/overview","documentation/platform/admin-panel/server-admin","documentation/platform/admin-panel/org-admin-console"]},"documentation/platform/secret-sharing"]},{"group":"Authentication Methods","pages":["documentation/platform/auth-methods/email-password","documentation/platform/token","documentation/platform/identities/token-auth","documentation/platform/identities/universal-auth","documentation/platform/identities/kubernetes-auth","documentation/platform/identities/gcp-auth","documentation/platform/identities/azure-auth","documentation/platform/identities/aws-auth",{"group":"OIDC Auth","pages":["documentation/platform/identities/oidc-auth/general","documentation/platform/identities/oidc-auth/github","documentation/platform/identities/oidc-auth/circleci","documentation/platform/identities/oidc-auth/gitlab"]},"documentation/platform/mfa",{"group":"SSO","pages":["documentation/platform/sso/overview","documentation/platform/sso/google","documentation/platform/sso/github","documentation/platform/sso/gitlab","documentation/platform/sso/okta","documentation/platform/sso/azure","documentation/platform/sso/jumpcloud","documentation/platform/sso/keycloak-saml","documentation/platform/sso/google-saml","documentation/platform/sso/keycloak-oidc","documentation/platform/sso/auth0-oidc","documentation/platform/sso/general-oidc"]},{"group":"LDAP","pages":["documentation/platform/ldap/overview","documentation/platform/ldap/jumpcloud","documentation/platform/ldap/general"]},{"group":"SCIM","pages":["documentation/platform/scim/overview","documentation/platform/scim/okta","documentation/platform/scim/azure","documentation/platform/scim/jumpcloud","documentation/platform/scim/group-mappings"]}]},{"group":"Self-host Infisical","pages":["self-hosting/overview",{"group":"Containerized installation methods","pages":["self-hosting/deployment-options/standalone-infisical","self-hosting/deployment-options/docker-swarm","self-hosting/deployment-options/docker-compose","self-hosting/deployment-options/kubernetes-helm"]},"self-hosting/configuration/envars","self-hosting/configuration/requirements",{"group":"Guides","pages":["self-hosting/configuration/schema-migrations","self-hosting/guides/mongo-to-postgres","self-hosting/guides/custom-certificates"]},{"group":"Reference architectures","pages":["self-hosting/reference-architectures/aws-ecs","self-hosting/reference-architectures/linux-deployment-ha"]},"self-hosting/ee","self-hosting/faq"]},{"group":"Command line","pages":["cli/overview","cli/usage",{"group":"Core commands","pages":["cli/commands/login","cli/commands/init","cli/commands/run","cli/commands/secrets","cli/commands/dynamic-secrets","cli/commands/export","cli/commands/token","cli/commands/service-token","cli/commands/vault","cli/commands/user","cli/commands/reset",{"group":"infisical scan","pages":["cli/commands/scan","cli/commands/scan-git-changes","cli/commands/scan-install"]}]},"cli/scanning-overview","cli/project-config","cli/faq"]},{"group":"Infrastructure Integrations","pages":[{"group":"Container orchestrators","pages":["integrations/platforms/kubernetes","integrations/platforms/docker-swarm-with-agent","integrations/platforms/ecs-with-agent"]},"integrations/platforms/infisical-agent",{"group":"Docker","pages":["integrations/platforms/docker-intro","integrations/platforms/docker","integrations/platforms/docker-pass-envs","integrations/platforms/docker-compose"]},"integrations/frameworks/terraform","integrations/platforms/ansible"]},{"group":"Native Integrations","pages":[{"group":"AWS","pages":["integrations/cloud/aws-parameter-store","integrations/cloud/aws-secret-manager","integrations/cloud/aws-amplify"]},"integrations/cloud/vercel","integrations/cloud/azure-key-vault","integrations/cloud/azure-app-configuration","integrations/cloud/azure-devops","integrations/cloud/gcp-secret-manager",{"group":"Cloudflare","pages":["integrations/cloud/cloudflare-pages","integrations/cloud/cloudflare-workers"]},"integrations/cloud/terraform-cloud","integrations/cloud/databricks",{"group":"View more","pages":["integrations/cloud/digital-ocean-app-platform","integrations/cloud/heroku","integrations/cloud/netlify","integrations/cloud/railway","integrations/cloud/flyio","integrations/cloud/render","integrations/cloud/laravel-forge","integrations/cloud/supabase","integrations/cloud/northflank","integrations/cloud/hasura-cloud","integrations/cloud/qovery","integrations/cloud/hashicorp-vault","integrations/cloud/cloud-66","integrations/cloud/windmill"]}]},{"group":"CI/CD Integrations","pages":["integrations/cicd/jenkins","integrations/cicd/githubactions","integrations/cicd/gitlab","integrations/cicd/bitbucket","integrations/cloud/teamcity",{"group":"View more","pages":["integrations/cicd/circleci","integrations/cicd/travisci","integrations/cicd/rundeck","integrations/cicd/codefresh","integrations/cloud/checkly","integrations/cicd/octopus-deploy"]}]},{"group":"Framework Integrations","pages":["integrations/frameworks/spring-boot-maven","integrations/frameworks/react","integrations/frameworks/vue","integrations/frameworks/express",{"group":"View more","pages":["integrations/frameworks/nextjs","integrations/frameworks/nestjs","integrations/frameworks/sveltekit","integrations/frameworks/nuxt","integrations/frameworks/gatsby","integrations/frameworks/remix","integrations/frameworks/vite","integrations/frameworks/fiber","integrations/frameworks/django","integrations/frameworks/flask","integrations/frameworks/laravel","integrations/frameworks/rails","integrations/frameworks/dotnet","integrations/platforms/pm2"]}]},{"group":"Build Tool Integrations","pages":["integrations/build-tools/gradle"]},{"group":"","pages":["sdks/overview"]},{"group":"SDK's","pages":["sdks/languages/node","sdks/languages/python","sdks/languages/go","sdks/languages/ruby","sdks/languages/java","sdks/languages/csharp"]},{"group":"Overview","pages":["api-reference/overview/introduction","api-reference/overview/authentication",{"group":"Examples","pages":["api-reference/overview/examples/integration"]}]},{"group":"Endpoints","pages":[{"group":"Identities","pages":["api-reference/endpoints/identities/create","api-reference/endpoints/identities/update","api-reference/endpoints/identities/delete","api-reference/endpoints/identities/get-by-id","api-reference/endpoints/identities/list"]},{"group":"Token Auth","pages":["api-reference/endpoints/token-auth/attach","api-reference/endpoints/token-auth/retrieve","api-reference/endpoints/token-auth/update","api-reference/endpoints/token-auth/revoke","api-reference/endpoints/token-auth/get-tokens","api-reference/endpoints/token-auth/create-token","api-reference/endpoints/token-auth/update-token","api-reference/endpoints/token-auth/revoke-token"]},{"group":"Universal Auth","pages":["api-reference/endpoints/universal-auth/login","api-reference/endpoints/universal-auth/attach","api-reference/endpoints/universal-auth/retrieve","api-reference/endpoints/universal-auth/update","api-reference/endpoints/universal-auth/revoke","api-reference/endpoints/universal-auth/create-client-secret","api-reference/endpoints/universal-auth/list-client-secrets","api-reference/endpoints/universal-auth/revoke-client-secret","api-reference/endpoints/universal-auth/get-client-secret-by-id","api-reference/endpoints/universal-auth/renew-access-token","api-reference/endpoints/universal-auth/revoke-access-token"]},{"group":"GCP Auth","pages":["api-reference/endpoints/gcp-auth/login","api-reference/endpoints/gcp-auth/attach","api-reference/endpoints/gcp-auth/retrieve","api-reference/endpoints/gcp-auth/update","api-reference/endpoints/gcp-auth/revoke"]},{"group":"AWS Auth","pages":["api-reference/endpoints/aws-auth/login","api-reference/endpoints/aws-auth/attach","api-reference/endpoints/aws-auth/retrieve","api-reference/endpoints/aws-auth/update","api-reference/endpoints/aws-auth/revoke"]},{"group":"Azure Auth","pages":["api-reference/endpoints/azure-auth/login","api-reference/endpoints/azure-auth/attach","api-reference/endpoints/azure-auth/retrieve","api-reference/endpoints/azure-auth/update","api-reference/endpoints/azure-auth/revoke"]},{"group":"Kubernetes Auth","pages":["api-reference/endpoints/kubernetes-auth/login","api-reference/endpoints/kubernetes-auth/attach","api-reference/endpoints/kubernetes-auth/retrieve","api-reference/endpoints/kubernetes-auth/update","api-reference/endpoints/kubernetes-auth/revoke"]},{"group":"OIDC Auth","pages":["api-reference/endpoints/oidc-auth/login","api-reference/endpoints/oidc-auth/attach","api-reference/endpoints/oidc-auth/retrieve","api-reference/endpoints/oidc-auth/update","api-reference/endpoints/oidc-auth/revoke"]},{"group":"Groups","pages":["api-reference/endpoints/groups/create","api-reference/endpoints/groups/update","api-reference/endpoints/groups/delete","api-reference/endpoints/groups/get","api-reference/endpoints/groups/get-by-id","api-reference/endpoints/groups/add-group-user","api-reference/endpoints/groups/remove-group-user","api-reference/endpoints/groups/list-group-users"]},{"group":"Organizations","pages":["api-reference/endpoints/organizations/memberships","api-reference/endpoints/organizations/update-membership","api-reference/endpoints/organizations/delete-membership","api-reference/endpoints/organizations/list-identity-memberships","api-reference/endpoints/organizations/workspaces"]},{"group":"Projects","pages":["api-reference/endpoints/workspaces/create-workspace","api-reference/endpoints/workspaces/delete-workspace","api-reference/endpoints/workspaces/get-workspace","api-reference/endpoints/workspaces/update-workspace","api-reference/endpoints/workspaces/secret-snapshots","api-reference/endpoints/workspaces/rollback-snapshot"]},{"group":"Project Users","pages":["api-reference/endpoints/project-users/invite-member-to-workspace","api-reference/endpoints/project-users/remove-member-from-workspace","api-reference/endpoints/project-users/memberships","api-reference/endpoints/project-users/get-by-username","api-reference/endpoints/project-users/update-membership"]},{"group":"Project Groups","pages":["api-reference/endpoints/project-groups/create","api-reference/endpoints/project-groups/delete","api-reference/endpoints/project-groups/get-by-id","api-reference/endpoints/project-groups/list","api-reference/endpoints/project-groups/update"]},{"group":"Project Identities","pages":["api-reference/endpoints/project-identities/add-identity-membership","api-reference/endpoints/project-identities/list-identity-memberships","api-reference/endpoints/project-identities/get-by-id","api-reference/endpoints/project-identities/update-identity-membership","api-reference/endpoints/project-identities/delete-identity-membership"]},{"group":"Project Roles","pages":["api-reference/endpoints/project-roles/create","api-reference/endpoints/project-roles/update","api-reference/endpoints/project-roles/delete","api-reference/endpoints/project-roles/get-by-slug","api-reference/endpoints/project-roles/list"]},{"group":"Project Templates","pages":["api-reference/endpoints/project-templates/create","api-reference/endpoints/project-templates/update","api-reference/endpoints/project-templates/delete","api-reference/endpoints/project-templates/get-by-id","api-reference/endpoints/project-templates/list"]},{"group":"Environments","pages":["api-reference/endpoints/environments/create","api-reference/endpoints/environments/update","api-reference/endpoints/environments/delete"]},{"group":"Folders","pages":["api-reference/endpoints/folders/list","api-reference/endpoints/folders/get-by-id","api-reference/endpoints/folders/create","api-reference/endpoints/folders/update","api-reference/endpoints/folders/delete"]},{"group":"Secret Tags","pages":["api-reference/endpoints/secret-tags/list","api-reference/endpoints/secret-tags/get-by-id","api-reference/endpoints/secret-tags/get-by-slug","api-reference/endpoints/secret-tags/create","api-reference/endpoints/secret-tags/update","api-reference/endpoints/secret-tags/delete"]},{"group":"Secrets","pages":["api-reference/endpoints/secrets/list","api-reference/endpoints/secrets/create","api-reference/endpoints/secrets/read","api-reference/endpoints/secrets/update","api-reference/endpoints/secrets/delete","api-reference/endpoints/secrets/create-many","api-reference/endpoints/secrets/update-many","api-reference/endpoints/secrets/delete-many","api-reference/endpoints/secrets/attach-tags","api-reference/endpoints/secrets/detach-tags"]},{"group":"Dynamic Secrets","pages":["api-reference/endpoints/dynamic-secrets/create","api-reference/endpoints/dynamic-secrets/update","api-reference/endpoints/dynamic-secrets/delete","api-reference/endpoints/dynamic-secrets/get","api-reference/endpoints/dynamic-secrets/list","api-reference/endpoints/dynamic-secrets/list-leases","api-reference/endpoints/dynamic-secrets/create-lease","api-reference/endpoints/dynamic-secrets/delete-lease","api-reference/endpoints/dynamic-secrets/renew-lease","api-reference/endpoints/dynamic-secrets/get-lease"]},{"group":"Secret Imports","pages":["api-reference/endpoints/secret-imports/list","api-reference/endpoints/secret-imports/create","api-reference/endpoints/secret-imports/update","api-reference/endpoints/secret-imports/delete"]},{"group":"Identity Specific Privilege","pages":["api-reference/endpoints/identity-specific-privilege/create-permanent","api-reference/endpoints/identity-specific-privilege/create-temporary","api-reference/endpoints/identity-specific-privilege/update","api-reference/endpoints/identity-specific-privilege/delete","api-reference/endpoints/identity-specific-privilege/find-by-slug","api-reference/endpoints/identity-specific-privilege/list"]},{"group":"Integrations","pages":["api-reference/endpoints/integrations/create-auth","api-reference/endpoints/integrations/list-auth","api-reference/endpoints/integrations/find-auth","api-reference/endpoints/integrations/delete-auth","api-reference/endpoints/integrations/delete-auth-by-id","api-reference/endpoints/integrations/create","api-reference/endpoints/integrations/update","api-reference/endpoints/integrations/delete","api-reference/endpoints/integrations/list-project-integrations"]},{"group":"Service Tokens","pages":["api-reference/endpoints/service-tokens/get"]},{"group":"Audit Logs","pages":["api-reference/endpoints/audit-logs/export-audit-log"]}]},{"group":"Infisical PKI","pages":[{"group":"Certificate Authorities","pages":["api-reference/endpoints/certificate-authorities/list","api-reference/endpoints/certificate-authorities/create","api-reference/endpoints/certificate-authorities/read","api-reference/endpoints/certificate-authorities/update","api-reference/endpoints/certificate-authorities/delete","api-reference/endpoints/certificate-authorities/renew","api-reference/endpoints/certificate-authorities/list-ca-certs","api-reference/endpoints/certificate-authorities/csr","api-reference/endpoints/certificate-authorities/cert","api-reference/endpoints/certificate-authorities/sign-intermediate","api-reference/endpoints/certificate-authorities/import-cert","api-reference/endpoints/certificate-authorities/issue-cert","api-reference/endpoints/certificate-authorities/sign-cert","api-reference/endpoints/certificate-authorities/crl"]},{"group":"Certificates","pages":["api-reference/endpoints/certificates/list","api-reference/endpoints/certificates/read","api-reference/endpoints/certificates/revoke","api-reference/endpoints/certificates/delete","api-reference/endpoints/certificates/cert-body","api-reference/endpoints/certificates/issue-certificate","api-reference/endpoints/certificates/sign-certificate"]},{"group":"Certificate Templates","pages":["api-reference/endpoints/certificate-templates/create","api-reference/endpoints/certificate-templates/update","api-reference/endpoints/certificate-templates/get-by-id","api-reference/endpoints/certificate-templates/delete"]},{"group":"Certificate Collections","pages":["api-reference/endpoints/pki-collections/create","api-reference/endpoints/pki-collections/read","api-reference/endpoints/pki-collections/update","api-reference/endpoints/pki-collections/delete","api-reference/endpoints/pki-collections/add-item","api-reference/endpoints/pki-collections/list-items","api-reference/endpoints/pki-collections/delete-item"]},{"group":"PKI Alerting","pages":["api-reference/endpoints/pki-alerts/create","api-reference/endpoints/pki-alerts/read","api-reference/endpoints/pki-alerts/update","api-reference/endpoints/pki-alerts/delete"]}]},{"group":"Infisical KMS","pages":[{"group":"Keys","pages":["api-reference/endpoints/kms/keys/list","api-reference/endpoints/kms/keys/create","api-reference/endpoints/kms/keys/update","api-reference/endpoints/kms/keys/delete","api-reference/endpoints/kms/keys/encrypt","api-reference/endpoints/kms/keys/decrypt"]}]},{"group":"Internals","pages":["internals/overview","internals/permissions","internals/components","internals/flows","internals/security","internals/service-tokens"]},{"group":"","pages":["changelog/overview"]},{"group":"Contributing","pages":[{"group":"Getting Started","pages":["contributing/getting-started/overview","contributing/getting-started/code-of-conduct","contributing/getting-started/pull-requests","contributing/getting-started/faq"]},{"group":"Contributing to platform","pages":["contributing/platform/developing","contributing/platform/backend/how-to-create-a-feature","contributing/platform/backend/folder-structure"]},{"group":"Contributing to SDK","pages":["contributing/sdk/developing"]}]}],"tabs":[{"name":"Integrations","url":"integrations","_id":"6746db41cbe3178400aa60df"},{"name":"CLI","url":"cli","_id":"6746db41cbe3178400aa60e0"},{"name":"API Reference","url":"api-reference","_id":"6746db41cbe3178400aa60e1"},{"name":"SDKs","url":"sdks","_id":"6746db41cbe3178400aa60e2"},{"name":"Changelog","url":"changelog","_id":"6746db41cbe3178400aa60e3"}],"footer":{"socials":{"x":"https://www.twitter.com/infisical/","linkedin":"https://www.linkedin.com/company/infisical/","github":"https://github.com/Infisical/infisical-cli","slack":"https://infisical.com/slack"},"links":[{"title":"PRODUCT","links":[{"label":"Secret Management","url":"https://infisical.com/"},{"label":"Secret Scanning","url":"https://infisical.com/radar"},{"label":"Share Secrets","url":"https://app.infisical.com/share-secret"},{"label":"Pricing","url":"https://infisical.com/pricing"},{"label":"Security","url":"https://infisical.com/docs/internals/security"},{"label":"Blog","url":"https://infisical.com/blog"},{"label":"Infisical vs Vault","url":"https://infisical.com/infisical-vs-hashicorp-vault"},{"label":"Forum","url":"https://questions.infisical.com/"}]},{"title":"USE CASES","links":[{"label":"Infisical Agent","url":"https://infisical.com/docs/documentation/getting-started/introduction"},{"label":"Kubernetes","url":"https://infisical.com/docs/integrations/platforms/kubernetes"},{"label":"Dynamic Secrets","url":"https://infisical.com/docs/documentation/platform/dynamic-secrets/overview"},{"label":"Terraform","url":"https://infisical.com/docs/integrations/frameworks/terraform"},{"label":"Ansible","url":"https://infisical.com/docs/integrations/platforms/ansible"},{"label":"Jenkins","url":"https://infisical.com/docs/integrations/cicd/jenkins"},{"label":"Docker","url":"https://infisical.com/docs/integrations/platforms/docker-intro"},{"label":"AWS ECS","url":"https://infisical.com/docs/integrations/platforms/ecs-with-agent"},{"label":"GitLab","url":"https://infisical.com/docs/integrations/cicd/gitlab"},{"label":"GitHub","url":"https://infisical.com/docs/integrations/cicd/githubactions"},{"label":"SDK","url":"https://infisical.com/docs/sdks/overview"}]},{"title":"DEVELOPERS","links":[{"label":"Changelog","url":"https://www.infisical.com/docs/changelog"},{"label":"Status","url":"https://status.infisical.com/"},{"label":"Feedback \u0026 Requests","url":"https://github.com/Infisical/infisical/issues"},{"label":"Trust of Center","url":"https://app.vanta.com/infisical.com/trust/hoop8cr78cuarxo9sztvs"},{"label":"Open Source Friends","url":"https://infisical.com/infisical-friends"},{"label":"How to contribute","url":"https://www.infisical.com/infisical-heroes"}]},{"title":"OTHERS","links":[{"label":"Customers","url":"https://infisical.com/customers/traba"},{"label":"Company Handbook","url":"https://infisical.com/wiki/handbook/overview"},{"label":"Careers","url":"https://infisical.com/careers"},{"label":"Terms of Service","url":"https://infisical.com/terms"},{"label":"Privacy Policy","url":"https://infisical.com/privacy"},{"label":"Subprocessors","url":"https://infisical.com/subprocessors"},{"label":"SLA","url":"https://infisical.com/sla"},{"label":"Team Email","url":"mailto:team@infisical.com"},{"label":"Sales","url":"mailto:sales@infisical.com"},{"label":"Support","url":"https://infisical.com/slack"}]}]},"feedback":{"thumbsRating":true,"suggestEdit":true,"raiseIssue":true},"analytics":{"posthog":{"apiKey":"phc_Q0xfB3LeOqo7ySk4DE6zLNwDzHFesKcmigknCy4fTdV"},"koala":{"publicApiKey":"pk_b50d7184e0e39ddd5cdb43cf6abeadd9b97d"}},"integrations":{"intercom":"hsg644ru"},"repo":{"github":{"owner":"infisical","repo":"infisical","contentDirectory":"docs","deployBranch":"main"}}},"pageMetadata":{"title":"Infisical Node.js SDK","description":null,"sidebarTitle":"Node.js","url":"https://github.com/Infisical/node-sdk-v2","icon":"node","href":"/sdks/languages/node"}}},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"description":null,"pageData":{"navWithMetadata":[{"group":"Getting Started","pages":[{"title":"What is Infisical?","description":"An Introduction to the Infisical secret management platform.","sidebarTitle":"What is Infisical?","href":"/documentation/getting-started/introduction"},{"group":"Quickstart","pages":[{"title":"Secret Management in Development Environments","description":"Learn how to manage secrets in local development environments.","sidebarTitle":"Local Development","href":"/documentation/guides/local-development"}]},{"group":"Guides","pages":[{"title":"Introduction","description":null,"href":"/documentation/guides/introduction"},{"title":"Node","description":null,"href":"/documentation/guides/node"},{"title":"Python","description":null,"href":"/documentation/guides/python"},{"title":"Next.js + Vercel","description":null,"href":"/documentation/guides/nextjs-vercel"},{"title":"Microsoft Power Apps","description":"Learn how to manage secrets in Microsoft Power Apps with Infisical.","href":"/documentation/guides/microsoft-power-apps"},{"title":"Infisical Organizational Structure Blueprint","description":"Learn how to structure your projects, secrets, and other resources within Infisical.","sidebarTitle":"Organization Structure","href":"/documentation/guides/organization-structure"}]}]},{"group":"Platform","pages":[{"title":"Organizations","description":"Learn more and understand the concept of Infisical organizations.","href":"/documentation/platform/organization"},{"title":"Projects","description":"Learn more and understand the concept of Infisical projects.","href":"/documentation/platform/project"},{"title":"Folders","description":"Learn how to organize secrets with folders.","href":"/documentation/platform/folder"},{"group":"Secrets","pages":[{"title":"Secret Versioning","description":"Learn how secret versioning works in Infisical.","href":"/documentation/platform/secret-versioning"},{"title":"Point-in-Time Recovery","description":"Learn how to rollback secrets and configurations to any snapshot with Infisical.","href":"/documentation/platform/pit-recovery"},{"title":"Secret Referencing and Importing","description":"Learn the fundamentals of secret referencing and importing in Infisical.","sidebarTitle":"Referencing and Importing","href":"/documentation/platform/secret-reference"},{"title":"Webhooks","description":"Learn the fundamentals of Infisical webhooks.","href":"/documentation/platform/webhooks"}]},{"group":"Internal PKI","pages":[{"title":"Internal PKI","description":"Learn how to create a Private CA hierarchy and issue X.509 certificates.","sidebarTitle":"Overview","href":"/documentation/platform/pki/overview"},{"title":"Private CA","description":"Learn how to create a Private CA hierarchy with Infisical.","sidebarTitle":"Private CA","href":"/documentation/platform/pki/private-ca"},{"title":"Certificates","description":"Learn how to issue X.509 certificates with Infisical.","sidebarTitle":"Certificates","href":"/documentation/platform/pki/certificates"},{"title":"Kubernetes Issuer","description":"Learn how to automatically provision and manage TLS certificates for in Kubernetes using Infisical PKI","sidebarTitle":"Certificates for Kubernetes","href":"/documentation/platform/pki/pki-issuer"},{"title":"Enrollment over Secure Transport (EST)","description":"Learn how to manage certificate enrollment of clients using EST","sidebarTitle":"Enrollment over Secure Transport (EST)","href":"/documentation/platform/pki/est"},{"title":"Alerting","description":"Learn how to set up alerting for expiring certificates with Infisical","href":"/documentation/platform/pki/alerting"}]},{"group":"Key Management (KMS)","pages":[{"title":"Key Management Service (KMS)","description":"Learn how to manage and use cryptographic keys with Infisical.","sidebarTitle":"Overview","href":"/documentation/platform/kms/overview"},{"title":"HSM Integration","description":"Learn more about integrating an HSM with Infisical KMS.","href":"/documentation/platform/kms/hsm-integration"},{"title":"Kubernetes Encryption with KMS","description":null,"sidebarTitle":"Kubernetes Encryption","url":"https://github.com/Infisical/k8-kms-plugin","href":"/documentation/platform/kms/kubernetes-encryption"}]},{"group":"KMS Configuration","pages":[{"title":"Key Management Service (KMS) Configuration","description":"Learn how to configure your project's encryption","sidebarTitle":"Overview","href":"/documentation/platform/kms-configuration/overview"},{"title":"AWS Key Management Service","description":"Learn how to manage encryption using AWS KMS","href":"/documentation/platform/kms-configuration/aws-kms"},{"title":"AWS CloudHSM","description":"Learn how to manage encryption using AWS CloudHSM","href":"/documentation/platform/kms-configuration/aws-hsm"}]},{"group":"Identities","pages":[{"title":"User and Machine Identities","description":"Learn more about identities to interact with resources in Infisical.","sidebarTitle":"Overview","href":"/documentation/platform/identities/overview"},{"title":"User Identities","description":"Read more about the concept of user identities in Infisical.","href":"/documentation/platform/identities/user-identities"},{"title":"Machine Identities","description":"Learn how to use Machine Identities to programmatically interact with Infisical.","href":"/documentation/platform/identities/machine-identities"}]},{"group":"Access Control","pages":[{"title":"Access Controls","description":"Learn about Infisical's access control toolset.","sidebarTitle":"Overview","href":"/documentation/platform/access-controls/overview"},{"title":"Role-based Access Controls","description":"Learn how to use RBAC to manage user permissions.","href":"/documentation/platform/access-controls/role-based-access-controls"},{"title":"Attribute-based Access Controls","description":"Learn how to use ABAC to manage permissions based on identity attributes.","href":"/documentation/platform/access-controls/attribute-based-access-controls"},{"title":"Additional Privileges","description":"Learn how to add specific privileges on top of predefined roles.","href":"/documentation/platform/access-controls/additional-privileges"},{"title":"Temporary Access","description":"Learn how to set up timed access to sensitive resources for user and machine identities.","href":"/documentation/platform/access-controls/temporary-access"},{"title":"Access Requests","description":"Learn how to request access to sensitive resources in Infisical.","href":"/documentation/platform/access-controls/access-requests"},{"title":"Approval Workflows","description":"Learn how to enable a set of policies to manage changes to sensitive secrets and environments.","href":"/documentation/platform/pr-workflows"},{"title":"User Groups","description":"Manage user groups in Infisical.","href":"/documentation/platform/groups"}]},{"group":"Audit Logs","pages":[{"title":"Overview","description":"Track evert event action performed within Infisical projects.","href":"/documentation/platform/audit-logs"},{"title":"Audit Log Streams","description":"Learn how to stream Infisical Audit Logs to external logging providers.","href":"/documentation/platform/audit-log-streams/audit-log-streams"},{"title":"Stream to Non-HTTP providers","description":"How to stream Infisical Audit Logs to Non-HTTP log providers","href":"/documentation/platform/audit-log-streams/audit-log-streams-with-fluentbit"}]},{"group":"Secret Rotation","pages":[{"title":"Secret Rotation","description":"Learn how to set up automated secret rotation in Infisical.","sidebarTitle":"Overview","href":"/documentation/platform/secret-rotation/overview"},{"title":"Twilio SendGrid","description":"Find out how to rotate Twilio SendGrid API keys.","href":"/documentation/platform/secret-rotation/sendgrid"},{"title":"PostgreSQL/CockroachDB","description":"Learn how to automatically rotate PostgreSQL/CockroachDB user passwords.","href":"/documentation/platform/secret-rotation/postgres"},{"title":"MySQL/MariaDB","description":"Learn how to automatically rotate MySQL/MariaDB user passwords.","href":"/documentation/platform/secret-rotation/mysql"},{"title":"Microsoft SQL Server","description":"Learn how to automatically rotate Microsoft SQL Server user passwords.","href":"/documentation/platform/secret-rotation/mssql"},{"title":"AWS IAM User","description":"Learn how to automatically rotate Access Key Id and Secret Key of AWS IAM Users.","href":"/documentation/platform/secret-rotation/aws-iam"}]},{"group":"Dynamic Secrets","pages":[{"title":"Dynamic Secrets","description":"Learn how to generate secrets dynamically on-demand.","sidebarTitle":"Overview","href":"/documentation/platform/dynamic-secrets/overview"},{"title":"PostgreSQL","description":"Learn how to dynamically generate PostgreSQL database users.","href":"/documentation/platform/dynamic-secrets/postgresql"},{"title":"MySQL","description":"Learn how to dynamically generate MySQL Database user credentials.","href":"/documentation/platform/dynamic-secrets/mysql"},{"title":"MS SQL","description":"Learn how to dynamically generate MS SQL database user credentials.","href":"/documentation/platform/dynamic-secrets/mssql"},{"title":"Oracle","description":"Learn how to dynamically generate Oracle Database user credentials.","href":"/documentation/platform/dynamic-secrets/oracle"},{"title":"Cassandra","description":"Learn how to dynamically generate Cassandra database user credentials","href":"/documentation/platform/dynamic-secrets/cassandra"},{"title":"Redis","description":"Learn how to dynamically generate Redis Database user credentials.","href":"/documentation/platform/dynamic-secrets/redis"},{"title":"AWS ElastiCache","description":"Learn how to dynamically generate AWS ElastiCache user credentials.","href":"/documentation/platform/dynamic-secrets/aws-elasticache"},{"title":"Elasticsearch","description":"Learn how to dynamically generate Elasticsearch user credentials.","href":"/documentation/platform/dynamic-secrets/elastic-search"},{"title":"RabbitMQ","description":"Learn how to dynamically generate RabbitMQ user credentials.","href":"/documentation/platform/dynamic-secrets/rabbit-mq"},{"title":"AWS IAM","description":"Learn how to dynamically generate AWS IAM Users.","href":"/documentation/platform/dynamic-secrets/aws-iam"},{"title":"Mongo Atlas","description":"Learn how to dynamically generate Mongo Atlas Database user credentials.","href":"/documentation/platform/dynamic-secrets/mongo-atlas"},{"title":"Mongo DB","description":"Learn how to dynamically generate Mongo DB Database user credentials.","href":"/documentation/platform/dynamic-secrets/mongo-db"},{"title":"Azure Entra Id","description":"Learn how to dynamically generate Azure Entra Id user credentials.","href":"/documentation/platform/dynamic-secrets/azure-entra-id"},{"title":"LDAP","description":"Learn how to dynamically generate user credentials via LDAP.","href":"/documentation/platform/dynamic-secrets/ldap"},{"title":"SAP ASE","description":"Learn how to dynamically generate SAP ASE database account credentials.","href":"/documentation/platform/dynamic-secrets/sap-ase"},{"title":"SAP HANA","description":"Learn how to dynamically generate SAP HANA database account credentials.","href":"/documentation/platform/dynamic-secrets/sap-hana"},{"title":"Snowflake","description":"Learn how to dynamically generate Snowflake user credentials.","href":"/documentation/platform/dynamic-secrets/snowflake"},{"title":"TOTP","description":"Learn how to dynamically generate time-based one-time passwords.","href":"/documentation/platform/dynamic-secrets/totp"}]},{"title":"Project Templates","description":"Learn how to manage and apply project templates","sidebarTitle":"Project Templates","href":"/documentation/platform/project-templates"},{"group":"Workflow Integrations","pages":[{"title":"Slack integration","description":"Learn how to setup Slack integration","href":"/documentation/platform/workflow-integrations/slack-integration"}]},{"group":"Admin Consoles","pages":[{"title":null,"description":"Learn about Infisical's Admin Consoles","href":"/documentation/platform/admin-panel/overview"},{"title":"Server Admin Console","description":"Configure and manage server related features","href":"/documentation/platform/admin-panel/server-admin"},{"title":"Organization Admin Console","description":"View and manage resources across your organization","href":"/documentation/platform/admin-panel/org-admin-console"}]},{"title":"Secret Sharing","description":"Learn how to share time \u0026 view-count bound secrets securely with anyone on the internet.","sidebarTitle":"Secret Sharing","href":"/documentation/platform/secret-sharing"}]},{"group":"Authentication Methods","pages":[{"title":"Email and Password","description":"Learn how to authenticate into Infisical with email and password.","href":"/documentation/platform/auth-methods/email-password"},{"title":"Service Token","description":"Infisical service tokens allow users to programmatically interact with Infisical.","href":"/documentation/platform/token"},{"title":"Token Auth","description":"Learn how to authenticate to Infisical from any platform or environment using an access token.","href":"/documentation/platform/identities/token-auth"},{"title":"Universal Auth","description":"Learn how to authenticate to Infisical from any platform or environment.","href":"/documentation/platform/identities/universal-auth"},{"title":"Kubernetes Auth","description":"Learn how to authenticate with Infisical in Kubernetes","href":"/documentation/platform/identities/kubernetes-auth"},{"title":"GCP Auth","description":"Learn how to authenticate with Infisical for services on Google Cloud Platform","href":"/documentation/platform/identities/gcp-auth"},{"title":"Azure Auth","description":"Learn how to authenticate with Infisical for services on Azure","href":"/documentation/platform/identities/azure-auth"},{"title":"AWS Auth","description":"Learn how to authenticate with Infisical for EC2 instances, Lambda functions, and other IAM principals.","href":"/documentation/platform/identities/aws-auth"},{"group":"OIDC Auth","pages":[{"title":"General","description":"Learn how to authenticate with Infisical from any platform or environment using OpenID Connect (OIDC).","href":"/documentation/platform/identities/oidc-auth/general"},{"title":"Github","description":"Learn how to authenticate Github workflows with Infisical using OpenID Connect (OIDC).","href":"/documentation/platform/identities/oidc-auth/github"},{"title":"CircleCI","description":"Learn how to authenticate CircleCI jobs with Infisical using OpenID Connect (OIDC).","href":"/documentation/platform/identities/oidc-auth/circleci"},{"title":"GitLab","description":"Learn how to authenticate GitLab pipelines with Infisical using OpenID Connect (OIDC).","href":"/documentation/platform/identities/oidc-auth/gitlab"}]},{"title":"Multi-factor Authentication","description":"Learn how to secure your Infisical account with MFA.","sidebarTitle":"MFA","href":"/documentation/platform/mfa"},{"group":"SSO","pages":[{"title":"SSO Overview","description":"Learn how to log in to Infisical via SSO protocols.","sidebarTitle":"Overview","href":"/documentation/platform/sso/overview"},{"title":"Google SSO","description":"Learn how to configure Google SSO for Infisical.","href":"/documentation/platform/sso/google"},{"title":"GitHub SSO","description":"Learn how to configure GitHub SSO for Infisical.","href":"/documentation/platform/sso/github"},{"title":"GitLab SSO","description":"Learn how to configure GitLab SSO for Infisical.","href":"/documentation/platform/sso/gitlab"},{"title":"Okta SAML","description":"Learn how to configure Okta SAML 2.0 for Infisical SSO.","href":"/documentation/platform/sso/okta"},{"title":"Entra ID / Azure AD SAML","description":"Learn how to configure Microsoft Entra ID for Infisical SSO.","href":"/documentation/platform/sso/azure"},{"title":"JumpCloud SAML","description":"Learn how to configure JumpCloud SAML for Infisical SSO.","href":"/documentation/platform/sso/jumpcloud"},{"title":"Keycloak SAML","description":"Learn how to configure Keycloak SAML for Infisical SSO.","href":"/documentation/platform/sso/keycloak-saml"},{"title":"Google SAML","description":"Learn how to configure Google SAML for Infisical SSO.","href":"/documentation/platform/sso/google-saml"},{"title":"Keycloak OIDC","description":"Learn how to configure Keycloak OIDC for Infisical SSO.","href":"/documentation/platform/sso/keycloak-oidc"},{"title":"Auth0 OIDC","description":"Learn how to configure Auth0 OIDC for Infisical SSO.","href":"/documentation/platform/sso/auth0-oidc"},{"title":"General OIDC","description":"Learn how to configure OIDC for Infisical SSO with any OIDC-compliant identity provider","href":"/documentation/platform/sso/general-oidc"}]},{"group":"LDAP","pages":[{"title":"LDAP Overview","description":"Learn how to authenticate into Infisical with LDAP.","sidebarTitle":"Overview","href":"/documentation/platform/ldap/overview"},{"title":"JumpCloud LDAP","description":"Learn how to configure JumpCloud LDAP for authenticating into Infisical.","href":"/documentation/platform/ldap/jumpcloud"},{"title":"General LDAP","description":"Learn how to log in to Infisical with LDAP.","href":"/documentation/platform/ldap/general"}]},{"group":"SCIM","pages":[{"title":"SCIM Overview","description":"Learn how to provision users for Infisical via SCIM.","href":"/documentation/platform/scim/overview"},{"title":"Okta SCIM","description":"Learn how to configure SCIM provisioning with Okta for Infisical.","href":"/documentation/platform/scim/okta"},{"title":"Azure SCIM","description":"Learn how to configure SCIM provisioning with Azure for Infisical.","href":"/documentation/platform/scim/azure"},{"title":"JumpCloud SCIM","description":"Learn how to configure SCIM provisioning with JumpCloud for Infisical.","href":"/documentation/platform/scim/jumpcloud"},{"title":"SCIM Group Mappings","description":"Learn how to enhance your SCIM implementation using group mappings","href":"/documentation/platform/scim/group-mappings"}]}]},{"group":"Self-host Infisical","pages":[{"title":"","description":"Learn how to self-host Infisical on your own infrastructure.","sidebarTitle":"Introduction","href":"/self-hosting/overview"},{"group":"Containerized installation methods","pages":[{"title":"Docker","description":"Learn how to run Infisical with Docker.","href":"/self-hosting/deployment-options/standalone-infisical"},{"title":"Docker Swarm","description":"How to self-host Infisical with Docker Swarm (HA).","href":"/self-hosting/deployment-options/docker-swarm"},{"title":"Docker Compose","description":"Read how to run Infisical with Docker Compose template.","href":"/self-hosting/deployment-options/docker-compose"},{"title":"Kubernetes via Helm Chart","description":"Learn how to use Helm chart to install Infisical on your Kubernetes cluster.","href":"/self-hosting/deployment-options/kubernetes-helm"}]},{"title":"Configurations","description":"Read how to configure environment variables for self-hosted Infisical.","href":"/self-hosting/configuration/envars"},{"title":"Hardware requirements","description":"Find out the minimal requirements for operating Infisical.","href":"/self-hosting/configuration/requirements"},{"group":"Guides","pages":[{"title":"Schema migration","description":"Learn how to run Postgres schema migrations.","href":"/self-hosting/configuration/schema-migrations"},{"title":"Migrate Mongo to Postgres","description":"Learn how to migrate Infisical from MongoDB to PostgreSQL.","href":"/self-hosting/guides/mongo-to-postgres"},{"title":"Adding Custom Certificates","description":"Learn how to configure Infisical with custom certificates","href":"/self-hosting/guides/custom-certificates"}]},{"group":"Reference architectures","pages":[{"title":"AWS ECS (HA)","description":"Reference architecture for self-hosting Infisical on AWS ECS","href":"/self-hosting/reference-architectures/aws-ecs"},{"title":"Linux (HA)","description":"Infisical High Availability Deployment architecture for Linux","href":"/self-hosting/reference-architectures/linux-deployment-ha"}]},{"title":"Infisical Enterprise","description":"Find out how to activate Infisical Enterprise edition (EE) features.","href":"/self-hosting/ee"},{"title":"FAQ","description":"Frequently Asked Questions about self-hosting Infisical.","href":"/self-hosting/faq"}]},{"group":"Command line","pages":[{"title":"Install","description":"Infisical's CLI is one of the best way to manage environments and secrets. Install it here","href":"/cli/overview"},{"title":"Quickstart","description":"Manage secrets with Infisical CLI","href":"/cli/usage"},{"group":"Core commands","pages":[{"title":"infisical login","description":"Login into Infisical from the CLI","href":"/cli/commands/login"},{"title":"infisical init","description":"Switch between Infisical projects within CLI","href":"/cli/commands/init"},{"title":"infisical run","description":"The command that injects your secrets into local environment","href":"/cli/commands/run"},{"title":"infisical secrets","description":"Perform CRUD operations with Infisical secrets","href":"/cli/commands/secrets"},{"title":"infisical dynamic-secrets","description":"Perform dynamic secret operations directly with the CLI","href":"/cli/commands/dynamic-secrets"},{"title":"infisical export","description":"Export Infisical secrets from CLI into different file formats","href":"/cli/commands/export"},{"title":"infisical token","description":"Manage your Infisical identity access tokens","href":"/cli/commands/token"},{"title":"infisical service-token","description":"Manage Infisical service tokens","href":"/cli/commands/service-token"},{"title":"infisical vault","description":"Change the vault type in Infisical","href":"/cli/commands/vault"},{"title":"infisical user","description":"Manage logged in users","href":"/cli/commands/user"},{"title":"infisical reset","description":"Reset Infisical","href":"/cli/commands/reset"},{"group":"infisical scan","pages":[{"title":"scan","description":"Scan git history, directories, and files for secrets","href":"/cli/commands/scan"},{"title":"scan git-changes","description":"Scan for secrets in your uncommitted code","href":"/cli/commands/scan-git-changes"},{"title":"scan install","description":"Add various scanning tools seamlessly into your development lifecycle","href":"/cli/commands/scan-install"}]}]},{"title":"Secret scanning","description":"Scan and prevent secret leaks in your code base","href":"/cli/scanning-overview"},{"title":"Project config file","description":"Project config file \u0026 customization options","href":"/cli/project-config"},{"title":"FAQ","description":"Frequently Asked Questions about Infisical CLI","href":"/cli/faq"}]},{"group":"Infrastructure Integrations","pages":[{"group":"Container orchestrators","pages":[{"title":"Kubernetes Operator","description":"How to use Infisical to inject secrets into Kubernetes clusters.","href":"/integrations/platforms/kubernetes"},{"title":"Docker Swarm","description":"Learn how to manage secrets in Docker Swarm services.","href":"/integrations/platforms/docker-swarm-with-agent"},{"title":"Amazon ECS","description":"Learn how to deliver secrets to Amazon Elastic Container Service.","href":"/integrations/platforms/ecs-with-agent"}]},{"title":"Infisical Agent","description":"This page describes how to manage secrets using Infisical Agent.","href":"/integrations/platforms/infisical-agent"},{"group":"Docker","pages":[{"title":"Docker","description":"Learn how to feed secrets from Infisical into your Docker application.","href":"/integrations/platforms/docker-intro"},{"title":"Docker Entrypoint","description":"Learn how to use Infisical to inject environment variables into a Docker container.","href":"/integrations/platforms/docker"},{"title":"Docker Run","description":"Learn how to pass secrets to your docker container at run time.","href":"/integrations/platforms/docker-pass-envs"},{"title":"Docker Compose","description":"Find out how to use Infisical to inject environment variables into services defined in your Docker Compose file.","href":"/integrations/platforms/docker-compose"}]},{"title":"Terraform Provider","description":"Learn how to fetch Secrets From Infisical With Terraform.","url":"https://registry.terraform.io/providers/Infisical/infisical/latest/docs","href":"/integrations/frameworks/terraform"},{"title":"Ansible","description":"Learn how to use Infisical for secret management in Ansible.","href":"/integrations/platforms/ansible"}]},{"group":"Native Integrations","pages":[{"group":"AWS","pages":[{"title":"AWS Parameter Store","description":"Learn how to sync secrets from Infisical to AWS Parameter Store.","href":"/integrations/cloud/aws-parameter-store"},{"title":"AWS Secrets Manager","description":"Learn how to sync secrets from Infisical to AWS Secrets Manager.","href":"/integrations/cloud/aws-secret-manager"},{"title":"AWS Amplify","description":"Learn how to sync secrets from Infisical to AWS Amplify.","href":"/integrations/cloud/aws-amplify"}]},{"title":"Vercel","description":"How to sync secrets from Infisical to Vercel","href":"/integrations/cloud/vercel"},{"title":"Azure Key Vault","description":"How to sync secrets from Infisical to Azure Key Vault","href":"/integrations/cloud/azure-key-vault"},{"title":"Azure App Configuration","description":"How to sync secrets from Infisical to Azure App Configuration","href":"/integrations/cloud/azure-app-configuration"},{"title":"Azure DevOps","description":"How to sync secrets from Infisical to Azure DevOps","href":"/integrations/cloud/azure-devops"},{"title":"GCP Secret Manager","description":"How to sync secrets from Infisical to GCP Secret Manager","href":"/integrations/cloud/gcp-secret-manager"},{"group":"Cloudflare","pages":[{"title":"Cloudflare Pages","description":"How to sync secrets from Infisical to Cloudflare Pages","href":"/integrations/cloud/cloudflare-pages"},{"title":"Cloudflare Workers","description":"How to sync secrets from Infisical to Cloudflare Workers","href":"/integrations/cloud/cloudflare-workers"}]},{"title":"Terraform Cloud","description":"How to sync secrets from Infisical to Terraform Cloud","href":"/integrations/cloud/terraform-cloud"},{"title":"Databricks","description":"Learn how to sync secrets from Infisical to Databricks.","href":"/integrations/cloud/databricks"},{"group":"View more","pages":[{"title":"Digital Ocean App Platform","description":"How to sync secrets from Infisical to Digital Ocean App Platform","href":"/integrations/cloud/digital-ocean-app-platform"},{"title":"Heroku","description":"How to sync secrets from Infisical to Heroku","href":"/integrations/cloud/heroku"},{"title":"Netlify","description":"How to sync secrets from Infisical to Netlify","href":"/integrations/cloud/netlify"},{"title":"Railway","description":"How to sync secrets from Infisical to Railway","href":"/integrations/cloud/railway"},{"title":"Fly.io","description":"How to sync secrets from Infisical to Fly.io","href":"/integrations/cloud/flyio"},{"title":"Render","description":"How to sync secrets from Infisical to Render","href":"/integrations/cloud/render"},{"title":"Laravel Forge","description":"How to sync secrets from Infisical to Laravel Forge","href":"/integrations/cloud/laravel-forge"},{"title":"Supabase","description":"How to sync secrets from Infisical to Supabase","href":"/integrations/cloud/supabase"},{"title":"Northflank","description":"How to sync secrets from Infisical to Northflank","href":"/integrations/cloud/northflank"},{"title":"Hasura Cloud","description":"How to sync secrets from Infisical to Hasura Cloud","href":"/integrations/cloud/hasura-cloud"},{"title":"Qovery","description":"How to sync secrets from Infisical to Qovery","href":"/integrations/cloud/qovery"},{"title":"HashiCorp Vault","description":"How to sync secrets from Infisical to HashiCorp Vault","href":"/integrations/cloud/hashicorp-vault"},{"title":"Cloud 66","description":"How to sync secrets from Infisical to Cloud 66","href":"/integrations/cloud/cloud-66"},{"title":"Windmill","description":"How to sync secrets from Infisical to Windmill","href":"/integrations/cloud/windmill"}]}]},{"group":"CI/CD Integrations","pages":[{"title":"Jenkins Plugin","description":"How to effectively and securely manage secrets in Jenkins using Infisical","href":"/integrations/cicd/jenkins"},{"title":"GitHub Actions","description":"How to sync secrets from Infisical to GitHub Actions","href":"/integrations/cicd/githubactions"},{"title":"GitLab","description":"How to sync secrets from Infisical to GitLab","href":"/integrations/cicd/gitlab"},{"title":"Bitbucket","description":"How to sync secrets from Infisical to Bitbucket","href":"/integrations/cicd/bitbucket"},{"title":"TeamCity","description":"How to sync secrets from Infisical to TeamCity","href":"/integrations/cloud/teamcity"},{"group":"View more","pages":[{"title":"CircleCI","description":"How to sync secrets from Infisical to CircleCI","href":"/integrations/cicd/circleci"},{"title":"Travis CI","description":"How to sync secrets from Infisical to Travis CI","href":"/integrations/cicd/travisci"},{"title":"Rundeck","description":"How to sync secrets from Infisical to Rundeck","href":"/integrations/cicd/rundeck"},{"title":"Codefresh","description":"How to sync secrets from Infisical to Codefresh","href":"/integrations/cicd/codefresh"},{"title":"Checkly","description":"How to sync secrets from Infisical to Checkly","href":"/integrations/cloud/checkly"},{"title":"Octopus Deploy","description":"Learn how to sync secrets from Infisical to Octopus Deploy","href":"/integrations/cicd/octopus-deploy"}]}]},{"group":"Framework Integrations","pages":[{"title":"Spring Boot with Maven","description":"How to use Infisical to inject environment variables into Java Spring Boot","href":"/integrations/frameworks/spring-boot-maven"},{"title":"React","description":"How to use Infisical to inject environment variables and secrets into a React app.","href":"/integrations/frameworks/react"},{"title":"Vue","description":"How to use Infisical to inject environment variables and secrets into a Vue.js app.","href":"/integrations/frameworks/vue"},{"title":"Express, Fastify, Koa","description":"How to use Infisical to inject environment variables and secrets into an Express app.","href":"/integrations/frameworks/express"},{"group":"View more","pages":[{"title":"Next.js","description":"How to use Infisical to inject environment variables and secrets into a Next.js app.","href":"/integrations/frameworks/nextjs"},{"title":"NestJS","description":"How to use Infisical to inject environment variables and secrets into a NestJS app.","href":"/integrations/frameworks/nestjs"},{"title":"SvelteKit","description":"How to use Infisical to inject environment variables and secrets into a SvelteKit app.","href":"/integrations/frameworks/sveltekit"},{"title":"Nuxt","description":"How to use Infisical to inject environment variables and secrets into a Nuxt app.","href":"/integrations/frameworks/nuxt"},{"title":"Gatsby","description":"How to use Infisical to inject environment variables and secrets into a Gatsby app.","href":"/integrations/frameworks/gatsby"},{"title":"Remix","description":"How to use Infisical to inject environment variables and secrets into a Remix app.","href":"/integrations/frameworks/remix"},{"title":"Vite","description":"How to use Infisical to inject environment variables and secrets into a Vite app.","href":"/integrations/frameworks/vite"},{"title":"Fiber","description":"How to use Infisical to inject environment variables and secrets into a Fiber app.","href":"/integrations/frameworks/fiber"},{"title":"Django","description":"How to use Infisical to inject environment variables and secrets into a Django app.","href":"/integrations/frameworks/django"},{"title":"Flask","description":"How to use Infisical to inject environment variables and secrets into a Flask app.","href":"/integrations/frameworks/flask"},{"title":"Laravel","description":"How to use Infisical to inject environment variables and secrets into a Laravel app.","href":"/integrations/frameworks/laravel"},{"title":"Ruby on Rails","description":"How to use Infisical to inject environment variables and secrets into a Ruby on Rails app.","href":"/integrations/frameworks/rails"},{"title":".NET","description":"How to use Infisical to inject environment variables and secrets into a .NET app.","href":"/integrations/frameworks/dotnet"},{"title":"PM2","description":"How to use Infisical to inject environment variables and secrets with PM2 into a Node.js app","href":"/integrations/platforms/pm2"}]}]},{"group":"Build Tool Integrations","pages":[{"title":"Gradle","description":"How to use Infisical to inject environment variables with Gradle","href":"/integrations/build-tools/gradle"}]},{"group":"","pages":[{"title":"SDKs","description":null,"sidebarTitle":"Introduction","href":"/sdks/overview"}]},{"group":"SDK's","pages":[{"title":"Infisical Node.js SDK","description":null,"sidebarTitle":"Node.js","url":"https://github.com/Infisical/node-sdk-v2","icon":"node","href":"/sdks/languages/node"},{"title":"Infisical Python SDK","description":null,"sidebarTitle":"Python","url":"https://github.com/Infisical/python-sdk-official?tab=readme-ov-file#infisical-python-sdk","icon":"python","href":"/sdks/languages/python"},{"title":"Infisical Go SDK","description":null,"sidebarTitle":"Go","icon":"golang","href":"/sdks/languages/go"},{"title":"Infisical Ruby SDK","description":null,"sidebarTitle":"Ruby","icon":"diamond","href":"/sdks/languages/ruby"},{"title":"Infisical Java SDK","description":null,"sidebarTitle":"Java","icon":"java","href":"/sdks/languages/java"},{"title":"Infisical .NET SDK","description":null,"sidebarTitle":".NET","icon":"bars","href":"/sdks/languages/csharp"}]},{"group":"Overview","pages":[{"title":"API Reference","description":null,"sidebarTitle":"Introduction","href":"/api-reference/overview/introduction"},{"title":"Authentication","description":"Learn how to authenticate with the Infisical Public API.","href":"/api-reference/overview/authentication"},{"group":"Examples","pages":[{"title":"Configure native integrations via API","description":"How to use Infisical API to sync secrets to external secret managers","href":"/api-reference/overview/examples/integration"}]}]},{"group":"Endpoints","pages":[{"group":"Identities","pages":[{"title":"Create","description":"Create identity","openapi":"POST /api/v1/identities","href":"/api-reference/endpoints/identities/create"},{"title":"Update","description":"Update identity","openapi":"PATCH /api/v1/identities/{identityId}","href":"/api-reference/endpoints/identities/update"},{"title":"Delete","description":"Delete identity","openapi":"DELETE /api/v1/identities/{identityId}","href":"/api-reference/endpoints/identities/delete"},{"title":"Get By ID","description":"Get an identity by id","openapi":"GET /api/v1/identities/{identityId}","href":"/api-reference/endpoints/identities/get-by-id"},{"title":"List","description":"List identities","openapi":"GET /api/v1/identities","href":"/api-reference/endpoints/identities/list"}]},{"group":"Token Auth","pages":[{"title":"Attach","description":"Attach Token Auth configuration onto identity","openapi":"POST /api/v1/auth/token-auth/identities/{identityId}","href":"/api-reference/endpoints/token-auth/attach"},{"title":"Retrieve","description":"Retrieve Token Auth configuration on identity","openapi":"GET /api/v1/auth/token-auth/identities/{identityId}","href":"/api-reference/endpoints/token-auth/retrieve"},{"title":"Update","description":"Update Token Auth configuration on identity","openapi":"PATCH /api/v1/auth/token-auth/identities/{identityId}","href":"/api-reference/endpoints/token-auth/update"},{"title":"Revoke","description":"Delete Token Auth configuration on identity","openapi":"DELETE /api/v1/auth/token-auth/identities/{identityId}","href":"/api-reference/endpoints/token-auth/revoke"},{"title":"Get Tokens","description":"Get tokens for identity with Token Auth","openapi":"GET /api/v1/auth/token-auth/identities/{identityId}/tokens","href":"/api-reference/endpoints/token-auth/get-tokens"},{"title":"Create Token","description":"Create token for identity with Token Auth","openapi":"POST /api/v1/auth/token-auth/identities/{identityId}/tokens","href":"/api-reference/endpoints/token-auth/create-token"},{"title":"Update Token","description":"Update token for identity with Token Auth","openapi":"PATCH /api/v1/auth/token-auth/tokens/{tokenId}","href":"/api-reference/endpoints/token-auth/update-token"},{"title":"Revoke Token","description":"Revoke token for identity with Token Auth","openapi":"POST /api/v1/auth/token-auth/tokens/{tokenId}/revoke","href":"/api-reference/endpoints/token-auth/revoke-token"}]},{"group":"Universal Auth","pages":[{"title":"Login","description":"Login with Universal Auth","openapi":"POST /api/v1/auth/universal-auth/login","href":"/api-reference/endpoints/universal-auth/login"},{"title":"Attach","description":"Attach Universal Auth configuration onto identity","openapi":"POST /api/v1/auth/universal-auth/identities/{identityId}","href":"/api-reference/endpoints/universal-auth/attach"},{"title":"Retrieve","description":"Retrieve Universal Auth configuration on identity","openapi":"GET /api/v1/auth/universal-auth/identities/{identityId}","href":"/api-reference/endpoints/universal-auth/retrieve"},{"title":"Update","description":"Update Universal Auth configuration on identity","openapi":"PATCH /api/v1/auth/universal-auth/identities/{identityId}","href":"/api-reference/endpoints/universal-auth/update"},{"title":"Revoke","description":"Delete Universal Auth configuration on identity","openapi":"DELETE /api/v1/auth/universal-auth/identities/{identityId}","href":"/api-reference/endpoints/universal-auth/revoke"},{"title":"Create Client Secret","description":"Create Universal Auth Client Secret for identity","openapi":"POST /api/v1/auth/universal-auth/identities/{identityId}/client-secrets","href":"/api-reference/endpoints/universal-auth/create-client-secret"},{"title":"List Client Secrets","description":"List Universal Auth Client Secrets for identity","openapi":"GET /api/v1/auth/universal-auth/identities/{identityId}/client-secrets","href":"/api-reference/endpoints/universal-auth/list-client-secrets"},{"title":"Revoke Client Secret","description":"Revoke Universal Auth Client Secrets for identity","openapi":"POST /api/v1/auth/universal-auth/identities/{identityId}/client-secrets/{clientSecretId}/revoke","href":"/api-reference/endpoints/universal-auth/revoke-client-secret"},{"title":"Get Client Secret By ID","description":"Get Universal Auth Client Secret for identity","openapi":"GET /api/v1/auth/universal-auth/identities/{identityId}/client-secrets/{clientSecretId}","href":"/api-reference/endpoints/universal-auth/get-client-secret-by-id"},{"title":"Renew Access Token","description":"Renew access token","openapi":"POST /api/v1/auth/token/renew","href":"/api-reference/endpoints/universal-auth/renew-access-token"},{"title":"Revoke Access Token","description":"Revoke access token","openapi":"POST /api/v1/auth/token/revoke","href":"/api-reference/endpoints/universal-auth/revoke-access-token"}]},{"group":"GCP Auth","pages":[{"title":"Login","description":"Login with GCP Auth","openapi":"POST /api/v1/auth/gcp-auth/login","href":"/api-reference/endpoints/gcp-auth/login"},{"title":"Attach","description":"Attach GCP Auth configuration onto identity","openapi":"POST /api/v1/auth/gcp-auth/identities/{identityId}","href":"/api-reference/endpoints/gcp-auth/attach"},{"title":"Retrieve","description":"Retrieve GCP Auth configuration on identity","openapi":"GET /api/v1/auth/gcp-auth/identities/{identityId}","href":"/api-reference/endpoints/gcp-auth/retrieve"},{"title":"Update","description":"Update GCP Auth configuration on identity","openapi":"PATCH /api/v1/auth/gcp-auth/identities/{identityId}","href":"/api-reference/endpoints/gcp-auth/update"},{"title":"Revoke","description":"Delete GCP Auth configuration on identity","openapi":"DELETE /api/v1/auth/gcp-auth/identities/{identityId}","href":"/api-reference/endpoints/gcp-auth/revoke"}]},{"group":"AWS Auth","pages":[{"title":"Login","description":"Login with AWS Auth","openapi":"POST /api/v1/auth/aws-auth/login","href":"/api-reference/endpoints/aws-auth/login"},{"title":"Attach","description":"Attach AWS Auth configuration onto identity","openapi":"POST /api/v1/auth/aws-auth/identities/{identityId}","href":"/api-reference/endpoints/aws-auth/attach"},{"title":"Retrieve","description":"Retrieve AWS Auth configuration on identity","openapi":"GET /api/v1/auth/aws-auth/identities/{identityId}","href":"/api-reference/endpoints/aws-auth/retrieve"},{"title":"Update","description":"Update AWS Auth configuration on identity","openapi":"PATCH /api/v1/auth/aws-auth/identities/{identityId}","href":"/api-reference/endpoints/aws-auth/update"},{"title":"Revoke","description":"Delete AWS Auth configuration on identity","openapi":"DELETE /api/v1/auth/aws-auth/identities/{identityId}","href":"/api-reference/endpoints/aws-auth/revoke"}]},{"group":"Azure Auth","pages":[{"title":"Login","description":"Login with Azure Auth","openapi":"POST /api/v1/auth/azure-auth/login","href":"/api-reference/endpoints/azure-auth/login"},{"title":"Attach","description":"Attach Azure Auth configuration onto identity","openapi":"POST /api/v1/auth/azure-auth/identities/{identityId}","href":"/api-reference/endpoints/azure-auth/attach"},{"title":"Retrieve","description":"Retrieve Azure Auth configuration on identity","openapi":"GET /api/v1/auth/azure-auth/identities/{identityId}","href":"/api-reference/endpoints/azure-auth/retrieve"},{"title":"Update","description":"Update Azure Auth configuration on identity","openapi":"PATCH /api/v1/auth/azure-auth/identities/{identityId}","href":"/api-reference/endpoints/azure-auth/update"},{"title":"Revoke","description":"Delete Azure Auth configuration on identity","openapi":"DELETE /api/v1/auth/azure-auth/identities/{identityId}","href":"/api-reference/endpoints/azure-auth/revoke"}]},{"group":"Kubernetes Auth","pages":[{"title":"Login","description":"Login with Kubernetes Auth","openapi":"POST /api/v1/auth/kubernetes-auth/login","href":"/api-reference/endpoints/kubernetes-auth/login"},{"title":"Attach","description":"Attach Kubernetes Auth configuration onto identity","openapi":"POST /api/v1/auth/kubernetes-auth/identities/{identityId}","href":"/api-reference/endpoints/kubernetes-auth/attach"},{"title":"Retrieve","description":"Retrieve Kubernetes Auth configuration on identity","openapi":"GET /api/v1/auth/kubernetes-auth/identities/{identityId}","href":"/api-reference/endpoints/kubernetes-auth/retrieve"},{"title":"Update","description":"Update Kubernetes Auth configuration on identity","openapi":"PATCH /api/v1/auth/kubernetes-auth/identities/{identityId}","href":"/api-reference/endpoints/kubernetes-auth/update"},{"title":"Revoke","description":"Delete Kubernetes Auth configuration on identity","openapi":"DELETE /api/v1/auth/kubernetes-auth/identities/{identityId}","href":"/api-reference/endpoints/kubernetes-auth/revoke"}]},{"group":"OIDC Auth","pages":[{"title":"Login","description":"Login with OIDC Auth","openapi":"POST /api/v1/auth/oidc-auth/login","href":"/api-reference/endpoints/oidc-auth/login"},{"title":"Attach","description":"Attach OIDC Auth configuration onto identity","openapi":"POST /api/v1/auth/oidc-auth/identities/{identityId}","href":"/api-reference/endpoints/oidc-auth/attach"},{"title":"Retrieve","description":"Retrieve OIDC Auth configuration on identity","openapi":"GET /api/v1/auth/oidc-auth/identities/{identityId}","href":"/api-reference/endpoints/oidc-auth/retrieve"},{"title":"Update","description":"Update OIDC Auth configuration on identity","openapi":"PATCH /api/v1/auth/oidc-auth/identities/{identityId}","href":"/api-reference/endpoints/oidc-auth/update"},{"title":"Revoke","description":"Delete OIDC Auth configuration on identity","openapi":"DELETE /api/v1/auth/oidc-auth/identities/{identityId}","href":"/api-reference/endpoints/oidc-auth/revoke"}]},{"group":"Groups","pages":[{"title":"Create","description":null,"openapi":"POST /api/v1/groups","href":"/api-reference/endpoints/groups/create"},{"title":"Update","description":null,"openapi":"PATCH /api/v1/groups/{id}","href":"/api-reference/endpoints/groups/update"},{"title":"Delete","description":null,"openapi":"DELETE /api/v1/groups/{id}","href":"/api-reference/endpoints/groups/delete"},{"title":"Get Groups in Organization","description":null,"openapi":"GET /api/v1/groups","href":"/api-reference/endpoints/groups/get"},{"title":"Get By ID","description":null,"openapi":"GET /api/v1/groups/{id}","href":"/api-reference/endpoints/groups/get-by-id"},{"title":"Add Group User","description":null,"openapi":"POST /api/v1/groups/{id}/users/{username}","href":"/api-reference/endpoints/groups/add-group-user"},{"title":"Remove Group User","description":null,"openapi":"DELETE /api/v1/groups/{id}/users/{username}","href":"/api-reference/endpoints/groups/remove-group-user"},{"title":"List Group Users","description":null,"openapi":"GET /api/v1/groups/{id}/users","href":"/api-reference/endpoints/groups/list-group-users"}]},{"group":"Organizations","pages":[{"title":"Get User Memberships","description":"Return organization user memberships","openapi":"GET /api/v2/organizations/{organizationId}/memberships","href":"/api-reference/endpoints/organizations/memberships"},{"title":"Update User Membership","description":"Update organization user memberships","openapi":"PATCH /api/v2/organizations/{organizationId}/memberships/{membershipId}","href":"/api-reference/endpoints/organizations/update-membership"},{"title":"Delete User Membership","description":"Delete organization user memberships","openapi":"DELETE /api/v2/organizations/{organizationId}/memberships/{membershipId}","href":"/api-reference/endpoints/organizations/delete-membership"},{"title":"List Identity Memberships","description":"Return organization identity memberships","openapi":"GET /api/v2/organizations/{orgId}/identity-memberships","href":"/api-reference/endpoints/organizations/list-identity-memberships"},{"title":"Get Projects","description":"Return projects in organization that user is apart of","openapi":"GET /api/v2/organizations/{organizationId}/workspaces","href":"/api-reference/endpoints/organizations/workspaces"}]},{"group":"Projects","pages":[{"title":"Create Project","description":"Create a new project","openapi":"POST /api/v2/workspace","href":"/api-reference/endpoints/workspaces/create-workspace"},{"title":"Delete Project","description":"Delete project","openapi":"DELETE /api/v1/workspace/{workspaceId}","href":"/api-reference/endpoints/workspaces/delete-workspace"},{"title":"Get Project","description":"Get project","openapi":"GET /api/v1/workspace/{workspaceId}","href":"/api-reference/endpoints/workspaces/get-workspace"},{"title":"Update Project","description":"Update project","openapi":"PATCH /api/v1/workspace/{workspaceId}","href":"/api-reference/endpoints/workspaces/update-workspace"},{"title":"Get Snapshots","description":"Return project secret snapshots ids","openapi":"GET /api/v1/workspace/{workspaceId}/secret-snapshots","href":"/api-reference/endpoints/workspaces/secret-snapshots"},{"title":"Roll Back to Snapshot","description":"Roll back project secrets to those captured in a secret snapshot version.","openapi":"POST /api/v1/secret-snapshot/{secretSnapshotId}/rollback","href":"/api-reference/endpoints/workspaces/rollback-snapshot"}]},{"group":"Project Users","pages":[{"title":"Invite Member","description":"Invite members to project","openapi":"POST /api/v2/workspace/{projectId}/memberships","href":"/api-reference/endpoints/project-users/invite-member-to-workspace"},{"title":"Remove Member","description":"Remove members from project","openapi":"DELETE /api/v2/workspace/{projectId}/memberships","href":"/api-reference/endpoints/project-users/remove-member-from-workspace"},{"title":"Get User Memberships","description":"Return project user memberships","openapi":"GET /api/v1/workspace/{workspaceId}/memberships","href":"/api-reference/endpoints/project-users/memberships"},{"title":"Get By Username","description":"Return project user memberships","openapi":"POST /api/v1/workspace/{workspaceId}/memberships/details","href":"/api-reference/endpoints/project-users/get-by-username"},{"title":"Update User Membership","description":"Update project user membership","openapi":"PATCH /api/v1/workspace/{workspaceId}/memberships/{membershipId}","href":"/api-reference/endpoints/project-users/update-membership"}]},{"group":"Project Groups","pages":[{"title":"Create Project Membership","description":"Add group to project","openapi":"POST /api/v2/workspace/{projectId}/groups/{groupId}","href":"/api-reference/endpoints/project-groups/create"},{"title":"Delete Project Membership","description":"Remove group from project","openapi":"DELETE /api/v2/workspace/{projectId}/groups/{groupId}","href":"/api-reference/endpoints/project-groups/delete"},{"title":"Get Project Membership","description":"Return project group","openapi":"GET /api/v2/workspace/{projectId}/groups/{groupId}","href":"/api-reference/endpoints/project-groups/get-by-id"},{"title":"List Project Memberships","description":"Return list of groups in project","openapi":"GET /api/v2/workspace/{projectId}/groups","href":"/api-reference/endpoints/project-groups/list"},{"title":"Update Project Membership","description":"Update group in project","openapi":"PATCH /api/v2/workspace/{projectId}/groups/{groupId}","href":"/api-reference/endpoints/project-groups/update"}]},{"group":"Project Identities","pages":[{"title":"Create Identity Membership","description":"Create project identity membership","openapi":"POST /api/v2/workspace/{projectId}/identity-memberships/{identityId}","href":"/api-reference/endpoints/project-identities/add-identity-membership"},{"title":"List Identity Memberships","description":"Return project identity memberships","openapi":"GET /api/v2/workspace/{projectId}/identity-memberships","href":"/api-reference/endpoints/project-identities/list-identity-memberships"},{"title":"Get Identity by ID","description":"Return project identity membership","openapi":"GET /api/v2/workspace/{projectId}/identity-memberships/{identityId}","href":"/api-reference/endpoints/project-identities/get-by-id"},{"title":"Update Identity Membership","description":"Update project identity memberships","openapi":"PATCH /api/v2/workspace/{projectId}/identity-memberships/{identityId}","href":"/api-reference/endpoints/project-identities/update-identity-membership"},{"title":"Delete Identity Membership","description":"Delete project identity memberships","openapi":"DELETE /api/v2/workspace/{projectId}/identity-memberships/{identityId}","href":"/api-reference/endpoints/project-identities/delete-identity-membership"}]},{"group":"Project Roles","pages":[{"title":"Create","description":"Create a project role","openapi":"POST /api/v1/workspace/{projectSlug}/roles","href":"/api-reference/endpoints/project-roles/create"},{"title":"Update","description":"Update a project role","openapi":"PATCH /api/v1/workspace/{projectSlug}/roles/{roleId}","href":"/api-reference/endpoints/project-roles/update"},{"title":"Delete","description":"Delete a project role","openapi":"DELETE /api/v1/workspace/{projectSlug}/roles/{roleId}","href":"/api-reference/endpoints/project-roles/delete"},{"title":"Get By Slug","description":null,"openapi":"GET /api/v1/workspace/{projectSlug}/roles/slug/{slug}","href":"/api-reference/endpoints/project-roles/get-by-slug"},{"title":"List","description":"List project role","openapi":"GET /api/v1/workspace/{projectSlug}/roles","href":"/api-reference/endpoints/project-roles/list"}]},{"group":"Project Templates","pages":[{"title":"Create","description":"Create a project template.","openapi":"POST /api/v1/project-templates","href":"/api-reference/endpoints/project-templates/create"},{"title":"Update","description":"Update a project template.","openapi":"PATCH /api/v1/project-templates/{templateId}","href":"/api-reference/endpoints/project-templates/update"},{"title":"Delete","description":"Delete a project template.","openapi":"DELETE /api/v1/project-templates/{templateId}","href":"/api-reference/endpoints/project-templates/delete"},{"title":"Get By ID","description":"Get a project template by ID.","openapi":"GET /api/v1/project-templates/{templateId}","href":"/api-reference/endpoints/project-templates/get-by-id"},{"title":"List","description":"List project templates for the current organization.","openapi":"GET /api/v1/project-templates","href":"/api-reference/endpoints/project-templates/list"}]},{"group":"Environments","pages":[{"title":"Create","description":"Create environment","openapi":"POST /api/v1/workspace/{workspaceId}/environments","href":"/api-reference/endpoints/environments/create"},{"title":"Update","description":"Update environment","openapi":"PATCH /api/v1/workspace/{workspaceId}/environments/{id}","href":"/api-reference/endpoints/environments/update"},{"title":"Delete","description":"Delete environment","openapi":"DELETE /api/v1/workspace/{workspaceId}/environments/{id}","href":"/api-reference/endpoints/environments/delete"}]},{"group":"Folders","pages":[{"title":"List","description":"Get folders","openapi":"GET /api/v1/folders","href":"/api-reference/endpoints/folders/list"},{"title":"Get by ID","description":"Get folder by id","openapi":"GET /api/v1/folders/{id}","href":"/api-reference/endpoints/folders/get-by-id"},{"title":"Create","description":"Create folders","openapi":"POST /api/v1/folders","href":"/api-reference/endpoints/folders/create"},{"title":"Update","description":"Update folder","openapi":"PATCH /api/v1/folders/{folderId}","href":"/api-reference/endpoints/folders/update"},{"title":"Delete","description":"Delete a folder","openapi":"DELETE /api/v1/folders/{folderIdOrName}","href":"/api-reference/endpoints/folders/delete"}]},{"group":"Secret Tags","pages":[{"title":"List","description":null,"openapi":"GET /api/v1/workspace/{projectId}/tags","href":"/api-reference/endpoints/secret-tags/list"},{"title":"Get By ID","description":null,"openapi":"GET /api/v1/workspace/{projectId}/tags/{tagId}","href":"/api-reference/endpoints/secret-tags/get-by-id"},{"title":"Get By Slug","description":null,"openapi":"GET /api/v1/workspace/{projectId}/tags/slug/{tagSlug}","href":"/api-reference/endpoints/secret-tags/get-by-slug"},{"title":"Create","description":null,"openapi":"POST /api/v1/workspace/{projectId}/tags","href":"/api-reference/endpoints/secret-tags/create"},{"title":"Update","description":null,"openapi":"PATCH /api/v1/workspace/{projectId}/tags/{tagId}","href":"/api-reference/endpoints/secret-tags/update"},{"title":"Delete","description":null,"openapi":"DELETE /api/v1/workspace/{projectId}/tags/{tagId}","href":"/api-reference/endpoints/secret-tags/delete"}]},{"group":"Secrets","pages":[{"title":"List","description":"List secrets","openapi":"GET /api/v3/secrets/raw","href":"/api-reference/endpoints/secrets/list"},{"title":"Create","description":"Create secret","openapi":"POST /api/v3/secrets/raw/{secretName}","href":"/api-reference/endpoints/secrets/create"},{"title":"Retrieve","description":"Get a secret by name","openapi":"GET /api/v3/secrets/raw/{secretName}","href":"/api-reference/endpoints/secrets/read"},{"title":"Update","description":"Update secret","openapi":"PATCH /api/v3/secrets/raw/{secretName}","href":"/api-reference/endpoints/secrets/update"},{"title":"Delete","description":"Delete secret","openapi":"DELETE /api/v3/secrets/raw/{secretName}","href":"/api-reference/endpoints/secrets/delete"},{"title":"Bulk Create","description":"Create many secrets","openapi":"POST /api/v3/secrets/batch/raw","href":"/api-reference/endpoints/secrets/create-many"},{"title":"Bulk Update","description":"Update many secrets","openapi":"PATCH /api/v3/secrets/batch/raw","href":"/api-reference/endpoints/secrets/update-many"},{"title":"Bulk Delete","description":"Delete many secrets","openapi":"DELETE /api/v3/secrets/batch/raw","href":"/api-reference/endpoints/secrets/delete-many"},{"title":"Attach tags","description":"Attach tags to a secret","openapi":"POST /api/v3/secrets/tags/{secretName}","href":"/api-reference/endpoints/secrets/attach-tags"},{"title":"Detach tags","description":"Detach tags from a secret","openapi":"DELETE /api/v3/secrets/tags/{secretName}","href":"/api-reference/endpoints/secrets/detach-tags"}]},{"group":"Dynamic Secrets","pages":[{"title":"Create","description":null,"openapi":"POST /api/v1/dynamic-secrets","href":"/api-reference/endpoints/dynamic-secrets/create"},{"title":"Update","description":null,"openapi":"PATCH /api/v1/dynamic-secrets/{name}","href":"/api-reference/endpoints/dynamic-secrets/update"},{"title":"Delete","description":null,"openapi":"DELETE /api/v1/dynamic-secrets/{name}","href":"/api-reference/endpoints/dynamic-secrets/delete"},{"title":"Get","description":null,"openapi":"GET /api/v1/dynamic-secrets/{name}","href":"/api-reference/endpoints/dynamic-secrets/get"},{"title":"List","description":null,"openapi":"GET /api/v1/dynamic-secrets","href":"/api-reference/endpoints/dynamic-secrets/list"},{"title":"List Leases","description":null,"openapi":"GET /api/v1/dynamic-secrets/{name}/leases","href":"/api-reference/endpoints/dynamic-secrets/list-leases"},{"title":"Create Lease","description":null,"openapi":"POST /api/v1/dynamic-secrets/leases","href":"/api-reference/endpoints/dynamic-secrets/create-lease"},{"title":"Delete Lease","description":null,"openapi":"DELETE /api/v1/dynamic-secrets/leases/{leaseId}","href":"/api-reference/endpoints/dynamic-secrets/delete-lease"},{"title":"Renew Lease","description":null,"openapi":"POST /api/v1/dynamic-secrets/leases/{leaseId}/renew","href":"/api-reference/endpoints/dynamic-secrets/renew-lease"},{"title":"Get Lease","description":null,"openapi":"GET /api/v1/dynamic-secrets/leases/{leaseId}","href":"/api-reference/endpoints/dynamic-secrets/get-lease"}]},{"group":"Secret Imports","pages":[{"title":"List","description":"Get secret imports","openapi":"GET /api/v1/secret-imports","href":"/api-reference/endpoints/secret-imports/list"},{"title":"Create","description":"Create secret imports","openapi":"POST /api/v1/secret-imports","href":"/api-reference/endpoints/secret-imports/create"},{"title":"Update","description":"Update secret imports","openapi":"PATCH /api/v1/secret-imports/{secretImportId}","href":"/api-reference/endpoints/secret-imports/update"},{"title":"Delete","description":"Delete secret imports","openapi":"DELETE /api/v1/secret-imports/{secretImportId}","href":"/api-reference/endpoints/secret-imports/delete"}]},{"group":"Identity Specific Privilege","pages":[{"title":"Create Permanent","description":"Create a permanent or a non expiry specific privilege for identity.","openapi":"POST /api/v1/additional-privilege/identity/permanent","href":"/api-reference/endpoints/identity-specific-privilege/create-permanent"},{"title":"Create Temporary","description":"Create a temporary or a expiring specific privilege for identity.","openapi":"POST /api/v1/additional-privilege/identity/temporary","href":"/api-reference/endpoints/identity-specific-privilege/create-temporary"},{"title":"Update","description":"Update a specific privilege of an identity.","openapi":"PATCH /api/v1/additional-privilege/identity","href":"/api-reference/endpoints/identity-specific-privilege/update"},{"title":"Delete","description":"Delete a specific privilege of an identity.","openapi":"DELETE /api/v1/additional-privilege/identity","href":"/api-reference/endpoints/identity-specific-privilege/delete"},{"title":"Find By Privilege Slug","description":"Retrieve details of a specific privilege by privilege slug.","openapi":"GET /api/v1/additional-privilege/identity/{privilegeSlug}","href":"/api-reference/endpoints/identity-specific-privilege/find-by-slug"},{"title":"List","description":"List of a specific privilege of an identity in a project.","openapi":"GET /api/v1/additional-privilege/identity","href":"/api-reference/endpoints/identity-specific-privilege/list"}]},{"group":"Integrations","pages":[{"title":"Create Auth","description":"Create the integration authentication object required for syncing secrets.","openapi":"POST /api/v1/integration-auth/access-token","href":"/api-reference/endpoints/integrations/create-auth"},{"title":"List Auth","description":"List integration auth objects for a workspace.","openapi":"GET /api/v1/workspace/{workspaceId}/authorizations","href":"/api-reference/endpoints/integrations/list-auth"},{"title":"Get Auth By ID","description":"Get details of an integration authorization by auth object id.","openapi":"GET /api/v1/integration-auth/{integrationAuthId}","href":"/api-reference/endpoints/integrations/find-auth"},{"title":"Delete Auth","description":"Remove all integration's auth object from the project.","openapi":"DELETE /api/v1/integration-auth","href":"/api-reference/endpoints/integrations/delete-auth"},{"title":"Delete Auth By ID","description":"Remove an integration auth object by object id.","openapi":"DELETE /api/v1/integration-auth/{integrationAuthId}","href":"/api-reference/endpoints/integrations/delete-auth-by-id"},{"title":"Create","description":"Create an integration to sync secrets.","openapi":"POST /api/v1/integration","href":"/api-reference/endpoints/integrations/create"},{"title":"Update","description":"Update an integration by integration id","openapi":"PATCH /api/v1/integration/{integrationId}","href":"/api-reference/endpoints/integrations/update"},{"title":"Delete","description":"Remove an integration using the integration object ID","openapi":"DELETE /api/v1/integration/{integrationId}","href":"/api-reference/endpoints/integrations/delete"},{"title":"List Project Integrations","description":"List integrations for a project.","openapi":"GET /api/v1/workspace/{workspaceId}/integrations","href":"/api-reference/endpoints/integrations/list-project-integrations"}]},{"group":"Service Tokens","pages":[{"title":"Get","description":"Return Infisical Token data","openapi":"GET /api/v2/service-token","href":"/api-reference/endpoints/service-tokens/get"}]},{"group":"Audit Logs","pages":[{"title":"Export","description":"Get all audit logs for an organization","openapi":"GET /api/v1/organization/audit-logs","href":"/api-reference/endpoints/audit-logs/export-audit-log"}]}]},{"group":"Infisical PKI","pages":[{"group":"Certificate Authorities","pages":[{"title":"List","description":null,"openapi":"GET /api/v2/workspace/{slug}/cas","href":"/api-reference/endpoints/certificate-authorities/list"},{"title":"Create","description":"Create CA","openapi":"POST /api/v1/pki/ca","href":"/api-reference/endpoints/certificate-authorities/create"},{"title":"Retrieve","description":"Get CA","openapi":"GET /api/v1/pki/ca/{caId}","href":"/api-reference/endpoints/certificate-authorities/read"},{"title":"Update","description":"Update CA","openapi":"PATCH /api/v1/pki/ca/{caId}","href":"/api-reference/endpoints/certificate-authorities/update"},{"title":"Delete","description":"Delete CA","openapi":"DELETE /api/v1/pki/ca/{caId}","href":"/api-reference/endpoints/certificate-authorities/delete"},{"title":"Renew","description":"Perform CA certificate renewal","openapi":"POST /api/v1/pki/ca/{caId}/renew","href":"/api-reference/endpoints/certificate-authorities/renew"},{"title":"List CA certificates","description":"Get list of past and current CA certificates for a CA","openapi":"GET /api/v1/pki/ca/{caId}/ca-certificates","href":"/api-reference/endpoints/certificate-authorities/list-ca-certs"},{"title":"Get CSR","description":"Get CA CSR","openapi":"GET /api/v1/pki/ca/{caId}/csr","href":"/api-reference/endpoints/certificate-authorities/csr"},{"title":"Retrieve certificate / chain","description":"Get current CA cert and cert chain of a CA","openapi":"GET /api/v1/pki/ca/{caId}/certificate","href":"/api-reference/endpoints/certificate-authorities/cert"},{"title":"Sign intermediate certificate","description":"Create intermediate CA certificate from parent CA","openapi":"POST /api/v1/pki/ca/{caId}/sign-intermediate","href":"/api-reference/endpoints/certificate-authorities/sign-intermediate"},{"title":"Import certificate","description":"Import certificate and chain to CA","openapi":"POST /api/v1/pki/ca/{caId}/import-certificate","href":"/api-reference/endpoints/certificate-authorities/import-cert"},{"title":"Issue certificate","description":"Issue certificate from CA","openapi":"POST /api/v1/pki/ca/{caId}/issue-certificate","href":"/api-reference/endpoints/certificate-authorities/issue-cert"},{"title":"Sign certificate","description":"Sign certificate from CA","openapi":"POST /api/v1/pki/ca/{caId}/sign-certificate","href":"/api-reference/endpoints/certificate-authorities/sign-cert"},{"title":"List CRLs","description":"Get list of CRLs of the CA","openapi":"GET /api/v1/pki/ca/{caId}/crls","href":"/api-reference/endpoints/certificate-authorities/crl"}]},{"group":"Certificates","pages":[{"title":"List","description":null,"openapi":"GET /api/v2/workspace/{slug}/certificates","href":"/api-reference/endpoints/certificates/list"},{"title":"Retrieve","description":"Get certificate","openapi":"GET /api/v1/pki/certificates/{serialNumber}","href":"/api-reference/endpoints/certificates/read"},{"title":"Revoke","description":"Revoke","openapi":"POST /api/v1/pki/certificates/{serialNumber}/revoke","href":"/api-reference/endpoints/certificates/revoke"},{"title":"Delete","description":"Delete certificate","openapi":"DELETE /api/v1/pki/certificates/{serialNumber}","href":"/api-reference/endpoints/certificates/delete"},{"title":"Get Certificate Body / Chain","description":"Get certificate body of certificate","openapi":"GET /api/v1/pki/certificates/{serialNumber}/certificate","href":"/api-reference/endpoints/certificates/cert-body"},{"title":"Issue Certificate","description":"Issue certificate","openapi":"POST /api/v1/pki/certificates/issue-certificate","href":"/api-reference/endpoints/certificates/issue-certificate"},{"title":"Sign Certificate","description":"Sign certificate","openapi":"POST /api/v1/pki/certificates/sign-certificate","href":"/api-reference/endpoints/certificates/sign-certificate"}]},{"group":"Certificate Templates","pages":[{"title":"Create","description":null,"openapi":"POST /api/v1/pki/certificate-templates","href":"/api-reference/endpoints/certificate-templates/create"},{"title":"Update","description":null,"openapi":"PATCH /api/v1/pki/certificate-templates/{certificateTemplateId}","href":"/api-reference/endpoints/certificate-templates/update"},{"title":"Get by ID","description":null,"openapi":"GET /api/v1/pki/certificate-templates/{certificateTemplateId}","href":"/api-reference/endpoints/certificate-templates/get-by-id"},{"title":"Delete","description":null,"openapi":"DELETE /api/v1/pki/certificate-templates/{certificateTemplateId}","href":"/api-reference/endpoints/certificate-templates/delete"}]},{"group":"Certificate Collections","pages":[{"title":"Create","description":"Create PKI collection","openapi":"POST /api/v1/pki/collections","href":"/api-reference/endpoints/pki-collections/create"},{"title":"Retrieve","description":"Get PKI collection","openapi":"GET /api/v1/pki/collections/{collectionId}","href":"/api-reference/endpoints/pki-collections/read"},{"title":"Update","description":"Update PKI collection","openapi":"PATCH /api/v1/pki/collections/{collectionId}","href":"/api-reference/endpoints/pki-collections/update"},{"title":"Delete","description":"Delete PKI collection","openapi":"DELETE /api/v1/pki/collections/{collectionId}","href":"/api-reference/endpoints/pki-collections/delete"},{"title":"Add Collection Item","description":"Add item to PKI collection","openapi":"POST /api/v1/pki/collections/{collectionId}/items","href":"/api-reference/endpoints/pki-collections/add-item"},{"title":"Retrieve","description":"Get items in PKI collection","openapi":"GET /api/v1/pki/collections/{collectionId}/items","href":"/api-reference/endpoints/pki-collections/list-items"},{"title":"Delete Collection Item","description":"Remove item from PKI collection","openapi":"DELETE /api/v1/pki/collections/{collectionId}/items/{collectionItemId}","href":"/api-reference/endpoints/pki-collections/delete-item"}]},{"group":"PKI Alerting","pages":[{"title":"Create","description":"Create PKI alert","openapi":"POST /api/v1/pki/alerts","href":"/api-reference/endpoints/pki-alerts/create"},{"title":"Retrieve","description":"Get PKI alert","openapi":"GET /api/v1/pki/alerts/{alertId}","href":"/api-reference/endpoints/pki-alerts/read"},{"title":"Update","description":"Update PKI alert","openapi":"PATCH /api/v1/pki/alerts/{alertId}","href":"/api-reference/endpoints/pki-alerts/update"},{"title":"Delete","description":"Delete PKI alert","openapi":"DELETE /api/v1/pki/alerts/{alertId}","href":"/api-reference/endpoints/pki-alerts/delete"}]}]},{"group":"Infisical KMS","pages":[{"group":"Keys","pages":[{"title":"List Keys","description":"List KMS keys","openapi":"Get /api/v1/kms/keys","href":"/api-reference/endpoints/kms/keys/list"},{"title":"Create Key","description":"Create KMS key","openapi":"POST /api/v1/kms/keys","href":"/api-reference/endpoints/kms/keys/create"},{"title":"Update Key","description":"Update KMS key","openapi":"PATCH /api/v1/kms/keys/{keyId}","href":"/api-reference/endpoints/kms/keys/update"},{"title":"Delete Key","description":"Delete KMS key","openapi":"DELETE /api/v1/kms/keys/{keyId}","href":"/api-reference/endpoints/kms/keys/delete"},{"title":"Encrypt Data","description":"Encrypt data with KMS key","openapi":"POST /api/v1/kms/keys/{keyId}/encrypt","href":"/api-reference/endpoints/kms/keys/encrypt"},{"title":"Decrypt Data","description":"Decrypt data with KMS key","openapi":"POST /api/v1/kms/keys/{keyId}/decrypt","href":"/api-reference/endpoints/kms/keys/decrypt"}]}]},{"group":"Internals","pages":[{"title":"Overview","description":"Read how Infisical works under the hood.","href":"/internals/overview"},{"title":"Permissions","description":"Infisical's permissions system provides granular access control.","href":"/internals/permissions"},{"title":"Components","description":"Infisical's components span multiple clients, an API, and a storage backend.","href":"/internals/components"},{"title":"Flows","description":"Infisical's core flows have strong cryptographic underpinnings.","href":"/internals/flows"},{"title":"Security","description":"Infisical's security model includes many considerations and initiatives.","href":"/internals/security"},{"title":"Service tokens","description":"Understanding service tokens and their best practices.","href":"/internals/service-tokens"}]},{"group":"","pages":[{"title":"Changelog","description":null,"href":"/changelog/overview"}]},{"group":"Contributing","pages":[{"group":"Getting Started","pages":[{"title":"Overview","description":"Contributing to the Infisical ecosystem.","href":"/contributing/getting-started/overview"},{"title":"Code of Conduct","description":"What you should know before contributing to Infisical?","href":"/contributing/getting-started/code-of-conduct"},{"title":"Pull requests","description":"This guide walks through the code submission process for Infisical.","href":"/contributing/getting-started/pull-requests"},{"title":"FAQ","description":"Frequently Asked Questions about contributing to Infisical","href":"/contributing/getting-started/faq"}]},{"group":"Contributing to platform","pages":[{"title":"Local development","description":"This guide will help you set up and run the Infisical platform in local development.","href":"/contributing/platform/developing"},{"title":"Backend development guide","description":null,"href":"/contributing/platform/backend/how-to-create-a-feature"},{"title":"Backend folder structure","description":null,"href":"/contributing/platform/backend/folder-structure"}]},{"group":"Contributing to SDK","pages":[{"title":"Local development","description":"This guide will help you contribute to the Infisical SDK.","href":"/contributing/sdk/developing"}]}]}],"pageMetadata":{"title":"Infisical Node.js SDK","description":null,"sidebarTitle":"Node.js","url":"https://github.com/Infisical/node-sdk-v2","icon":"node","href":"/sdks/languages/node"},"mintConfig":{"layout":"topnav","sidebar":{"items":"container"},"topbar":{"style":"default"},"search":{"location":"top"},"rounded":"default","codeBlock":{"mode":"dark"},"topbarCtaButton":{"name":"Start for Free","url":"https://app.infisical.com/signup","style":"pill","arrow":true},"$schema":"https://mintlify.com/schema.json","name":"Infisical","logo":{"light":"https://mintlify.s3.us-west-1.amazonaws.com/infisical/logo/light.svg","dark":"https://mintlify.s3.us-west-1.amazonaws.com/infisical/logo/dark.svg","href":"https://infisical.com"},"favicon":"/favicon.png","openapi":"https://app.infisical.com/api/docs/json","api":{"baseUrl":["https://app.infisical.com","http://localhost:8080"]},"modeToggle":{"default":"light","isHidden":true},"colors":{"primary":"#26272b","light":"#97b31d","dark":"#A1B659","background":{"light":"#ffffff","dark":"#0D1117"},"anchors":{"from":"#000000","to":"#707174"},"ultraLight":"#E7F256","ultraDark":"#8D9F4C"},"topbarLinks":[{"url":"https://app.infisical.com/login","name":"Log In","_id":"6746db41cbe3178400aa60e4"}],"navigation":[{"group":"Getting Started","pages":["documentation/getting-started/introduction",{"group":"Quickstart","pages":["documentation/guides/local-development"]},{"group":"Guides","pages":["documentation/guides/introduction","documentation/guides/node","documentation/guides/python","documentation/guides/nextjs-vercel","documentation/guides/microsoft-power-apps","documentation/guides/organization-structure"]}]},{"group":"Platform","pages":["documentation/platform/organization","documentation/platform/project","documentation/platform/folder",{"group":"Secrets","pages":["documentation/platform/secret-versioning","documentation/platform/pit-recovery","documentation/platform/secret-reference","documentation/platform/webhooks"]},{"group":"Internal PKI","pages":["documentation/platform/pki/overview","documentation/platform/pki/private-ca","documentation/platform/pki/certificates","documentation/platform/pki/pki-issuer","documentation/platform/pki/est","documentation/platform/pki/alerting"]},{"group":"Key Management (KMS)","pages":["documentation/platform/kms/overview","documentation/platform/kms/hsm-integration","documentation/platform/kms/kubernetes-encryption"]},{"group":"KMS Configuration","pages":["documentation/platform/kms-configuration/overview","documentation/platform/kms-configuration/aws-kms","documentation/platform/kms-configuration/aws-hsm"]},{"group":"Identities","pages":["documentation/platform/identities/overview","documentation/platform/identities/user-identities","documentation/platform/identities/machine-identities"]},{"group":"Access Control","pages":["documentation/platform/access-controls/overview","documentation/platform/access-controls/role-based-access-controls","documentation/platform/access-controls/attribute-based-access-controls","documentation/platform/access-controls/additional-privileges","documentation/platform/access-controls/temporary-access","documentation/platform/access-controls/access-requests","documentation/platform/pr-workflows","documentation/platform/groups"]},{"group":"Audit Logs","pages":["documentation/platform/audit-logs","documentation/platform/audit-log-streams/audit-log-streams","documentation/platform/audit-log-streams/audit-log-streams-with-fluentbit"]},{"group":"Secret Rotation","pages":["documentation/platform/secret-rotation/overview","documentation/platform/secret-rotation/sendgrid","documentation/platform/secret-rotation/postgres","documentation/platform/secret-rotation/mysql","documentation/platform/secret-rotation/mssql","documentation/platform/secret-rotation/aws-iam"]},{"group":"Dynamic Secrets","pages":["documentation/platform/dynamic-secrets/overview","documentation/platform/dynamic-secrets/postgresql","documentation/platform/dynamic-secrets/mysql","documentation/platform/dynamic-secrets/mssql","documentation/platform/dynamic-secrets/oracle","documentation/platform/dynamic-secrets/cassandra","documentation/platform/dynamic-secrets/redis","documentation/platform/dynamic-secrets/aws-elasticache","documentation/platform/dynamic-secrets/elastic-search","documentation/platform/dynamic-secrets/rabbit-mq","documentation/platform/dynamic-secrets/aws-iam","documentation/platform/dynamic-secrets/mongo-atlas","documentation/platform/dynamic-secrets/mongo-db","documentation/platform/dynamic-secrets/azure-entra-id","documentation/platform/dynamic-secrets/ldap","documentation/platform/dynamic-secrets/sap-ase","documentation/platform/dynamic-secrets/sap-hana","documentation/platform/dynamic-secrets/snowflake","documentation/platform/dynamic-secrets/totp"]},"documentation/platform/project-templates",{"group":"Workflow Integrations","pages":["documentation/platform/workflow-integrations/slack-integration"]},{"group":"Admin Consoles","pages":["documentation/platform/admin-panel/overview","documentation/platform/admin-panel/server-admin","documentation/platform/admin-panel/org-admin-console"]},"documentation/platform/secret-sharing"]},{"group":"Authentication Methods","pages":["documentation/platform/auth-methods/email-password","documentation/platform/token","documentation/platform/identities/token-auth","documentation/platform/identities/universal-auth","documentation/platform/identities/kubernetes-auth","documentation/platform/identities/gcp-auth","documentation/platform/identities/azure-auth","documentation/platform/identities/aws-auth",{"group":"OIDC Auth","pages":["documentation/platform/identities/oidc-auth/general","documentation/platform/identities/oidc-auth/github","documentation/platform/identities/oidc-auth/circleci","documentation/platform/identities/oidc-auth/gitlab"]},"documentation/platform/mfa",{"group":"SSO","pages":["documentation/platform/sso/overview","documentation/platform/sso/google","documentation/platform/sso/github","documentation/platform/sso/gitlab","documentation/platform/sso/okta","documentation/platform/sso/azure","documentation/platform/sso/jumpcloud","documentation/platform/sso/keycloak-saml","documentation/platform/sso/google-saml","documentation/platform/sso/keycloak-oidc","documentation/platform/sso/auth0-oidc","documentation/platform/sso/general-oidc"]},{"group":"LDAP","pages":["documentation/platform/ldap/overview","documentation/platform/ldap/jumpcloud","documentation/platform/ldap/general"]},{"group":"SCIM","pages":["documentation/platform/scim/overview","documentation/platform/scim/okta","documentation/platform/scim/azure","documentation/platform/scim/jumpcloud","documentation/platform/scim/group-mappings"]}]},{"group":"Self-host Infisical","pages":["self-hosting/overview",{"group":"Containerized installation methods","pages":["self-hosting/deployment-options/standalone-infisical","self-hosting/deployment-options/docker-swarm","self-hosting/deployment-options/docker-compose","self-hosting/deployment-options/kubernetes-helm"]},"self-hosting/configuration/envars","self-hosting/configuration/requirements",{"group":"Guides","pages":["self-hosting/configuration/schema-migrations","self-hosting/guides/mongo-to-postgres","self-hosting/guides/custom-certificates"]},{"group":"Reference architectures","pages":["self-hosting/reference-architectures/aws-ecs","self-hosting/reference-architectures/linux-deployment-ha"]},"self-hosting/ee","self-hosting/faq"]},{"group":"Command line","pages":["cli/overview","cli/usage",{"group":"Core commands","pages":["cli/commands/login","cli/commands/init","cli/commands/run","cli/commands/secrets","cli/commands/dynamic-secrets","cli/commands/export","cli/commands/token","cli/commands/service-token","cli/commands/vault","cli/commands/user","cli/commands/reset",{"group":"infisical scan","pages":["cli/commands/scan","cli/commands/scan-git-changes","cli/commands/scan-install"]}]},"cli/scanning-overview","cli/project-config","cli/faq"]},{"group":"Infrastructure Integrations","pages":[{"group":"Container orchestrators","pages":["integrations/platforms/kubernetes","integrations/platforms/docker-swarm-with-agent","integrations/platforms/ecs-with-agent"]},"integrations/platforms/infisical-agent",{"group":"Docker","pages":["integrations/platforms/docker-intro","integrations/platforms/docker","integrations/platforms/docker-pass-envs","integrations/platforms/docker-compose"]},"integrations/frameworks/terraform","integrations/platforms/ansible"]},{"group":"Native Integrations","pages":[{"group":"AWS","pages":["integrations/cloud/aws-parameter-store","integrations/cloud/aws-secret-manager","integrations/cloud/aws-amplify"]},"integrations/cloud/vercel","integrations/cloud/azure-key-vault","integrations/cloud/azure-app-configuration","integrations/cloud/azure-devops","integrations/cloud/gcp-secret-manager",{"group":"Cloudflare","pages":["integrations/cloud/cloudflare-pages","integrations/cloud/cloudflare-workers"]},"integrations/cloud/terraform-cloud","integrations/cloud/databricks",{"group":"View more","pages":["integrations/cloud/digital-ocean-app-platform","integrations/cloud/heroku","integrations/cloud/netlify","integrations/cloud/railway","integrations/cloud/flyio","integrations/cloud/render","integrations/cloud/laravel-forge","integrations/cloud/supabase","integrations/cloud/northflank","integrations/cloud/hasura-cloud","integrations/cloud/qovery","integrations/cloud/hashicorp-vault","integrations/cloud/cloud-66","integrations/cloud/windmill"]}]},{"group":"CI/CD Integrations","pages":["integrations/cicd/jenkins","integrations/cicd/githubactions","integrations/cicd/gitlab","integrations/cicd/bitbucket","integrations/cloud/teamcity",{"group":"View more","pages":["integrations/cicd/circleci","integrations/cicd/travisci","integrations/cicd/rundeck","integrations/cicd/codefresh","integrations/cloud/checkly","integrations/cicd/octopus-deploy"]}]},{"group":"Framework Integrations","pages":["integrations/frameworks/spring-boot-maven","integrations/frameworks/react","integrations/frameworks/vue","integrations/frameworks/express",{"group":"View more","pages":["integrations/frameworks/nextjs","integrations/frameworks/nestjs","integrations/frameworks/sveltekit","integrations/frameworks/nuxt","integrations/frameworks/gatsby","integrations/frameworks/remix","integrations/frameworks/vite","integrations/frameworks/fiber","integrations/frameworks/django","integrations/frameworks/flask","integrations/frameworks/laravel","integrations/frameworks/rails","integrations/frameworks/dotnet","integrations/platforms/pm2"]}]},{"group":"Build Tool Integrations","pages":["integrations/build-tools/gradle"]},{"group":"","pages":["sdks/overview"]},{"group":"SDK's","pages":["sdks/languages/node","sdks/languages/python","sdks/languages/go","sdks/languages/ruby","sdks/languages/java","sdks/languages/csharp"]},{"group":"Overview","pages":["api-reference/overview/introduction","api-reference/overview/authentication",{"group":"Examples","pages":["api-reference/overview/examples/integration"]}]},{"group":"Endpoints","pages":[{"group":"Identities","pages":["api-reference/endpoints/identities/create","api-reference/endpoints/identities/update","api-reference/endpoints/identities/delete","api-reference/endpoints/identities/get-by-id","api-reference/endpoints/identities/list"]},{"group":"Token Auth","pages":["api-reference/endpoints/token-auth/attach","api-reference/endpoints/token-auth/retrieve","api-reference/endpoints/token-auth/update","api-reference/endpoints/token-auth/revoke","api-reference/endpoints/token-auth/get-tokens","api-reference/endpoints/token-auth/create-token","api-reference/endpoints/token-auth/update-token","api-reference/endpoints/token-auth/revoke-token"]},{"group":"Universal Auth","pages":["api-reference/endpoints/universal-auth/login","api-reference/endpoints/universal-auth/attach","api-reference/endpoints/universal-auth/retrieve","api-reference/endpoints/universal-auth/update","api-reference/endpoints/universal-auth/revoke","api-reference/endpoints/universal-auth/create-client-secret","api-reference/endpoints/universal-auth/list-client-secrets","api-reference/endpoints/universal-auth/revoke-client-secret","api-reference/endpoints/universal-auth/get-client-secret-by-id","api-reference/endpoints/universal-auth/renew-access-token","api-reference/endpoints/universal-auth/revoke-access-token"]},{"group":"GCP Auth","pages":["api-reference/endpoints/gcp-auth/login","api-reference/endpoints/gcp-auth/attach","api-reference/endpoints/gcp-auth/retrieve","api-reference/endpoints/gcp-auth/update","api-reference/endpoints/gcp-auth/revoke"]},{"group":"AWS Auth","pages":["api-reference/endpoints/aws-auth/login","api-reference/endpoints/aws-auth/attach","api-reference/endpoints/aws-auth/retrieve","api-reference/endpoints/aws-auth/update","api-reference/endpoints/aws-auth/revoke"]},{"group":"Azure Auth","pages":["api-reference/endpoints/azure-auth/login","api-reference/endpoints/azure-auth/attach","api-reference/endpoints/azure-auth/retrieve","api-reference/endpoints/azure-auth/update","api-reference/endpoints/azure-auth/revoke"]},{"group":"Kubernetes Auth","pages":["api-reference/endpoints/kubernetes-auth/login","api-reference/endpoints/kubernetes-auth/attach","api-reference/endpoints/kubernetes-auth/retrieve","api-reference/endpoints/kubernetes-auth/update","api-reference/endpoints/kubernetes-auth/revoke"]},{"group":"OIDC Auth","pages":["api-reference/endpoints/oidc-auth/login","api-reference/endpoints/oidc-auth/attach","api-reference/endpoints/oidc-auth/retrieve","api-reference/endpoints/oidc-auth/update","api-reference/endpoints/oidc-auth/revoke"]},{"group":"Groups","pages":["api-reference/endpoints/groups/create","api-reference/endpoints/groups/update","api-reference/endpoints/groups/delete","api-reference/endpoints/groups/get","api-reference/endpoints/groups/get-by-id","api-reference/endpoints/groups/add-group-user","api-reference/endpoints/groups/remove-group-user","api-reference/endpoints/groups/list-group-users"]},{"group":"Organizations","pages":["api-reference/endpoints/organizations/memberships","api-reference/endpoints/organizations/update-membership","api-reference/endpoints/organizations/delete-membership","api-reference/endpoints/organizations/list-identity-memberships","api-reference/endpoints/organizations/workspaces"]},{"group":"Projects","pages":["api-reference/endpoints/workspaces/create-workspace","api-reference/endpoints/workspaces/delete-workspace","api-reference/endpoints/workspaces/get-workspace","api-reference/endpoints/workspaces/update-workspace","api-reference/endpoints/workspaces/secret-snapshots","api-reference/endpoints/workspaces/rollback-snapshot"]},{"group":"Project Users","pages":["api-reference/endpoints/project-users/invite-member-to-workspace","api-reference/endpoints/project-users/remove-member-from-workspace","api-reference/endpoints/project-users/memberships","api-reference/endpoints/project-users/get-by-username","api-reference/endpoints/project-users/update-membership"]},{"group":"Project Groups","pages":["api-reference/endpoints/project-groups/create","api-reference/endpoints/project-groups/delete","api-reference/endpoints/project-groups/get-by-id","api-reference/endpoints/project-groups/list","api-reference/endpoints/project-groups/update"]},{"group":"Project Identities","pages":["api-reference/endpoints/project-identities/add-identity-membership","api-reference/endpoints/project-identities/list-identity-memberships","api-reference/endpoints/project-identities/get-by-id","api-reference/endpoints/project-identities/update-identity-membership","api-reference/endpoints/project-identities/delete-identity-membership"]},{"group":"Project Roles","pages":["api-reference/endpoints/project-roles/create","api-reference/endpoints/project-roles/update","api-reference/endpoints/project-roles/delete","api-reference/endpoints/project-roles/get-by-slug","api-reference/endpoints/project-roles/list"]},{"group":"Project Templates","pages":["api-reference/endpoints/project-templates/create","api-reference/endpoints/project-templates/update","api-reference/endpoints/project-templates/delete","api-reference/endpoints/project-templates/get-by-id","api-reference/endpoints/project-templates/list"]},{"group":"Environments","pages":["api-reference/endpoints/environments/create","api-reference/endpoints/environments/update","api-reference/endpoints/environments/delete"]},{"group":"Folders","pages":["api-reference/endpoints/folders/list","api-reference/endpoints/folders/get-by-id","api-reference/endpoints/folders/create","api-reference/endpoints/folders/update","api-reference/endpoints/folders/delete"]},{"group":"Secret Tags","pages":["api-reference/endpoints/secret-tags/list","api-reference/endpoints/secret-tags/get-by-id","api-reference/endpoints/secret-tags/get-by-slug","api-reference/endpoints/secret-tags/create","api-reference/endpoints/secret-tags/update","api-reference/endpoints/secret-tags/delete"]},{"group":"Secrets","pages":["api-reference/endpoints/secrets/list","api-reference/endpoints/secrets/create","api-reference/endpoints/secrets/read","api-reference/endpoints/secrets/update","api-reference/endpoints/secrets/delete","api-reference/endpoints/secrets/create-many","api-reference/endpoints/secrets/update-many","api-reference/endpoints/secrets/delete-many","api-reference/endpoints/secrets/attach-tags","api-reference/endpoints/secrets/detach-tags"]},{"group":"Dynamic Secrets","pages":["api-reference/endpoints/dynamic-secrets/create","api-reference/endpoints/dynamic-secrets/update","api-reference/endpoints/dynamic-secrets/delete","api-reference/endpoints/dynamic-secrets/get","api-reference/endpoints/dynamic-secrets/list","api-reference/endpoints/dynamic-secrets/list-leases","api-reference/endpoints/dynamic-secrets/create-lease","api-reference/endpoints/dynamic-secrets/delete-lease","api-reference/endpoints/dynamic-secrets/renew-lease","api-reference/endpoints/dynamic-secrets/get-lease"]},{"group":"Secret Imports","pages":["api-reference/endpoints/secret-imports/list","api-reference/endpoints/secret-imports/create","api-reference/endpoints/secret-imports/update","api-reference/endpoints/secret-imports/delete"]},{"group":"Identity Specific Privilege","pages":["api-reference/endpoints/identity-specific-privilege/create-permanent","api-reference/endpoints/identity-specific-privilege/create-temporary","api-reference/endpoints/identity-specific-privilege/update","api-reference/endpoints/identity-specific-privilege/delete","api-reference/endpoints/identity-specific-privilege/find-by-slug","api-reference/endpoints/identity-specific-privilege/list"]},{"group":"Integrations","pages":["api-reference/endpoints/integrations/create-auth","api-reference/endpoints/integrations/list-auth","api-reference/endpoints/integrations/find-auth","api-reference/endpoints/integrations/delete-auth","api-reference/endpoints/integrations/delete-auth-by-id","api-reference/endpoints/integrations/create","api-reference/endpoints/integrations/update","api-reference/endpoints/integrations/delete","api-reference/endpoints/integrations/list-project-integrations"]},{"group":"Service Tokens","pages":["api-reference/endpoints/service-tokens/get"]},{"group":"Audit Logs","pages":["api-reference/endpoints/audit-logs/export-audit-log"]}]},{"group":"Infisical PKI","pages":[{"group":"Certificate Authorities","pages":["api-reference/endpoints/certificate-authorities/list","api-reference/endpoints/certificate-authorities/create","api-reference/endpoints/certificate-authorities/read","api-reference/endpoints/certificate-authorities/update","api-reference/endpoints/certificate-authorities/delete","api-reference/endpoints/certificate-authorities/renew","api-reference/endpoints/certificate-authorities/list-ca-certs","api-reference/endpoints/certificate-authorities/csr","api-reference/endpoints/certificate-authorities/cert","api-reference/endpoints/certificate-authorities/sign-intermediate","api-reference/endpoints/certificate-authorities/import-cert","api-reference/endpoints/certificate-authorities/issue-cert","api-reference/endpoints/certificate-authorities/sign-cert","api-reference/endpoints/certificate-authorities/crl"]},{"group":"Certificates","pages":["api-reference/endpoints/certificates/list","api-reference/endpoints/certificates/read","api-reference/endpoints/certificates/revoke","api-reference/endpoints/certificates/delete","api-reference/endpoints/certificates/cert-body","api-reference/endpoints/certificates/issue-certificate","api-reference/endpoints/certificates/sign-certificate"]},{"group":"Certificate Templates","pages":["api-reference/endpoints/certificate-templates/create","api-reference/endpoints/certificate-templates/update","api-reference/endpoints/certificate-templates/get-by-id","api-reference/endpoints/certificate-templates/delete"]},{"group":"Certificate Collections","pages":["api-reference/endpoints/pki-collections/create","api-reference/endpoints/pki-collections/read","api-reference/endpoints/pki-collections/update","api-reference/endpoints/pki-collections/delete","api-reference/endpoints/pki-collections/add-item","api-reference/endpoints/pki-collections/list-items","api-reference/endpoints/pki-collections/delete-item"]},{"group":"PKI Alerting","pages":["api-reference/endpoints/pki-alerts/create","api-reference/endpoints/pki-alerts/read","api-reference/endpoints/pki-alerts/update","api-reference/endpoints/pki-alerts/delete"]}]},{"group":"Infisical KMS","pages":[{"group":"Keys","pages":["api-reference/endpoints/kms/keys/list","api-reference/endpoints/kms/keys/create","api-reference/endpoints/kms/keys/update","api-reference/endpoints/kms/keys/delete","api-reference/endpoints/kms/keys/encrypt","api-reference/endpoints/kms/keys/decrypt"]}]},{"group":"Internals","pages":["internals/overview","internals/permissions","internals/components","internals/flows","internals/security","internals/service-tokens"]},{"group":"","pages":["changelog/overview"]},{"group":"Contributing","pages":[{"group":"Getting Started","pages":["contributing/getting-started/overview","contributing/getting-started/code-of-conduct","contributing/getting-started/pull-requests","contributing/getting-started/faq"]},{"group":"Contributing to platform","pages":["contributing/platform/developing","contributing/platform/backend/how-to-create-a-feature","contributing/platform/backend/folder-structure"]},{"group":"Contributing to SDK","pages":["contributing/sdk/developing"]}]}],"tabs":[{"name":"Integrations","url":"integrations","_id":"6746db41cbe3178400aa60df"},{"name":"CLI","url":"cli","_id":"6746db41cbe3178400aa60e0"},{"name":"API Reference","url":"api-reference","_id":"6746db41cbe3178400aa60e1"},{"name":"SDKs","url":"sdks","_id":"6746db41cbe3178400aa60e2"},{"name":"Changelog","url":"changelog","_id":"6746db41cbe3178400aa60e3"}],"footer":{"socials":{"x":"https://www.twitter.com/infisical/","linkedin":"https://www.linkedin.com/company/infisical/","github":"https://github.com/Infisical/infisical-cli","slack":"https://infisical.com/slack"},"links":[{"title":"PRODUCT","links":[{"label":"Secret Management","url":"https://infisical.com/"},{"label":"Secret Scanning","url":"https://infisical.com/radar"},{"label":"Share Secrets","url":"https://app.infisical.com/share-secret"},{"label":"Pricing","url":"https://infisical.com/pricing"},{"label":"Security","url":"https://infisical.com/docs/internals/security"},{"label":"Blog","url":"https://infisical.com/blog"},{"label":"Infisical vs Vault","url":"https://infisical.com/infisical-vs-hashicorp-vault"},{"label":"Forum","url":"https://questions.infisical.com/"}]},{"title":"USE CASES","links":[{"label":"Infisical Agent","url":"https://infisical.com/docs/documentation/getting-started/introduction"},{"label":"Kubernetes","url":"https://infisical.com/docs/integrations/platforms/kubernetes"},{"label":"Dynamic Secrets","url":"https://infisical.com/docs/documentation/platform/dynamic-secrets/overview"},{"label":"Terraform","url":"https://infisical.com/docs/integrations/frameworks/terraform"},{"label":"Ansible","url":"https://infisical.com/docs/integrations/platforms/ansible"},{"label":"Jenkins","url":"https://infisical.com/docs/integrations/cicd/jenkins"},{"label":"Docker","url":"https://infisical.com/docs/integrations/platforms/docker-intro"},{"label":"AWS ECS","url":"https://infisical.com/docs/integrations/platforms/ecs-with-agent"},{"label":"GitLab","url":"https://infisical.com/docs/integrations/cicd/gitlab"},{"label":"GitHub","url":"https://infisical.com/docs/integrations/cicd/githubactions"},{"label":"SDK","url":"https://infisical.com/docs/sdks/overview"}]},{"title":"DEVELOPERS","links":[{"label":"Changelog","url":"https://www.infisical.com/docs/changelog"},{"label":"Status","url":"https://status.infisical.com/"},{"label":"Feedback \u0026 Requests","url":"https://github.com/Infisical/infisical/issues"},{"label":"Trust of Center","url":"https://app.vanta.com/infisical.com/trust/hoop8cr78cuarxo9sztvs"},{"label":"Open Source Friends","url":"https://infisical.com/infisical-friends"},{"label":"How to contribute","url":"https://www.infisical.com/infisical-heroes"}]},{"title":"OTHERS","links":[{"label":"Customers","url":"https://infisical.com/customers/traba"},{"label":"Company Handbook","url":"https://infisical.com/wiki/handbook/overview"},{"label":"Careers","url":"https://infisical.com/careers"},{"label":"Terms of Service","url":"https://infisical.com/terms"},{"label":"Privacy Policy","url":"https://infisical.com/privacy"},{"label":"Subprocessors","url":"https://infisical.com/subprocessors"},{"label":"SLA","url":"https://infisical.com/sla"},{"label":"Team Email","url":"mailto:team@infisical.com"},{"label":"Sales","url":"mailto:sales@infisical.com"},{"label":"Support","url":"https://infisical.com/slack"}]}]},"feedback":{"thumbsRating":true,"suggestEdit":true,"raiseIssue":true},"analytics":{"posthog":{"apiKey":"phc_Q0xfB3LeOqo7ySk4DE6zLNwDzHFesKcmigknCy4fTdV"},"koala":{"publicApiKey":"pk_b50d7184e0e39ddd5cdb43cf6abeadd9b97d"}},"integrations":{"intercom":"hsg644ru"},"repo":{"github":{"owner":"infisical","repo":"infisical","contentDirectory":"docs","deployBranch":"main"}}},"apiReferenceData":{}},"favicons":{"icons":[{"rel":"apple-touch-icon","sizes":"180x180","href":"https://mintlify.s3-us-west-1.amazonaws.com/infisical/_generated/favicon/apple-touch-icon.png?v=3","type":"image/png"},{"rel":"icon","sizes":"32x32","href":"https://mintlify.s3-us-west-1.amazonaws.com/infisical/_generated/favicon/favicon-32x32.png?v=3","type":"image/png"},{"rel":"icon","sizes":"16x16","href":"https://mintlify.s3-us-west-1.amazonaws.com/infisical/_generated/favicon/favicon-16x16.png?v=3","type":"image/png"},{"rel":"shortcut icon","href":"https://mintlify.s3-us-west-1.amazonaws.com/infisical/_generated/favicon/favicon.ico?v=3","type":"image/x-icon"}],"browserconfig":"https://mintlify.s3-us-west-1.amazonaws.com/infisical/_generated/favicon/browserconfig.xml?v=3"},"subdomain":"infisical","internalAnalyticsWriteKey":"phc_TXdpocbGVeZVm5VJmAsHTMrCofBQu3e0kN8HGMNGTVW","inkeep":{"integrationApiKey":"a2e2846da1a227961e3519816ce2bfb868f7d86467d289de"},"trieve":{"chatEnabled":true,"datasetId":"cdc6f647-bdca-43d9-a3e5-f398c156d553"},"shouldIndex":true,"org":{"plan":"growth"},"cssFiles":[{"_id":"660a571a3a6c5022ffe07306","filePath":"style.css","subdomain":"infisical","__v":0,"content":"#navbar .max-w-8xl {\n max-width: 100%;\n border-bottom: 1px solid #ebebeb;\n background-color: #F4F3EF;\n}\n\n.max-w-8xl {\n /* background-color: #f5f5f5; */\n}\n\n#sidebar {\n left: 0;\n padding-right: 30px;\n border-right: 1px;\n border-color: #cdd64b;\n background-color: #F4F3EF;\n border-right: 1px solid #ebebeb;\n}\n\n#sidebar-content {\n padding-left: 2rem;\n}\n\n#sidebar .relative .sticky {\n opacity: 0;\n}\n\n#sidebar li \u003e div.mt-2 {\n border-radius: 0;\n padding: 5px;\n}\n\n#sidebar li \u003e a.text-primary {\n border-radius: 0;\n background-color: #FBFFCC;\n border-left: 4px solid #EFFF33;\n padding: 5px;\n}\n\n#sidebar li \u003e a.mt-2 {\n border-radius: 0;\n padding: 5px;\n}\n\n#sidebar li \u003e a.leading-6 {\n border-radius: 0;\n padding: 0px;\n}\n\n/* #sidebar ul \u003e div.mt-12 {\n padding-top: 30px;\n position: relative;\n}\n\n#sidebar ul \u003e div.mt-12 h5 {\n position: absolute;\n left: -12px;\n top: -0px;\n} */\n\n#header {\n border-left: 4px solid #EFFF33;\n padding-left: 16px;\n padding-right: 16px;\n background-color: #FDFFE5;\n padding-bottom: 10px;\n padding-top: 10px;\n}\n\n#content-area .mt-8 .block{\n border-radius: 0;\n border-width: 1px;\n background-color: #FCFBFA;\n border-color: #ebebeb;\n}\n\n/* #content-area:hover .mt-8 .block:hover{\n border-radius: 0;\n border-width: 1px;\n background-color: #FDFFE5;\n border-color: #EFFF33;\n} */\n\n#content-area .mt-8 .rounded-xl{\n border-radius: 0;\n}\n\n#content-area .mt-8 .rounded-lg{\n border-radius: 0;\n}\n\n#content-area .mt-6 .rounded-xl{\n border-radius: 0;\n}\n\n#content-area .mt-6 .rounded-lg{\n border-radius: 0;\n}\n\n#content-area .mt-6 .rounded-md{\n border-radius: 0;\n}\n\n#content-area .mt-8 .rounded-md{\n border-radius: 0;\n}\n\n#content-area div.my-4{\n border-radius: 0;\n border-width: 1px;\n}\n\n#content-area div.flex-1 {\n /* text-transform: uppercase; */\n opacity: 0.8;\n font-weight: 400;\n}\n\n#content-area button {\n border-radius: 0;\n}\n\n#content-area a {\n border-radius: 0;\n}\n\n#content-area .not-prose {\n border-radius: 0;\n}\n\n/* .eyebrow {\n text-transform: uppercase;\n font-weight: 400;\n color: red;\n} */\n\n#content-container {\n /* background-color: #f5f5f5; */\n margin-top: 2rem;\n}\n\n#topbar-cta-button .group .absolute {\n background-color: black;\n border-radius: 0px;\n}\n\n/* #topbar-cta-button .group .absolute:hover {\n background-color: white;\n border-radius: 0px;\n} */\n\n#topbar-cta-button .group .flex {\n margin-top: 5px;\n margin-bottom: 5px;\n font-size: medium;\n}\n\n.flex-1 .flex .items-center {\n /* background-color: #f5f5f5; */\n}\n"}],"jsFiles":[],"mdxSourceWithNoJs":{"compiledSource":"/*@jsxRuntime automatic @jsxImportSource react*/\n/*\nIf you're working with Node.js, the official [Infisical Node SDK](https://github.com/Infisical/sdk/tree/main/languages/node) package is the easiest way to fetch and work with secrets for your application.\n\n- [NPM Package](https://www.npmjs.com/package/@infisical/sdk)\n- [Github Repository](https://github.com/Infisical/sdk/tree/main/languages/node)\n\n## Basic Usage\n\n```js\nimport express from \"express\";\n\nimport { InfisicalClient } from \"@infisical/sdk\";\n\nconst app = express();\n\nconst PORT = 3000;\n\nconst client = new InfisicalClient({\nsiteUrl: \"https://app.infisical.com\", // Optional, defaults to https://app.infisical.com\nauth: {\nuniversalAuth: {\nclientId: \"YOUR_CLIENT_ID\",\nclientSecret: \"YOUR_CLIENT_SECRET\"\n}\n}\n});\n\napp.get(\"/\", async (req, res) =\u003e {\n// Access the secret\n\nconst name = await client.getSecret({\nenvironment: \"dev\",\nprojectId: \"PROJECT_ID\",\npath: \"/\",\ntype: \"shared\",\nsecretName: \"NAME\"\n});\n\nres.send(`Hello! My name is: ${name.secretValue}`);\n});\n\napp.listen(PORT, async () =\u003e {\n// initialize client\n\nconsole.log(`App listening on port ${PORT}`);\n});\n```\n\nThis example demonstrates how to use the Infisical Node SDK with an Express application. The application retrieves a secret named \"NAME\" and responds to requests with a greeting that includes the secret value.\n\n\u003cWarning\u003e\nWe do not recommend hardcoding your [Machine Identity Tokens](/documentation/platform/identities/overview). Setting it as an environment variable\nwould be best.\n\u003c/Warning\u003e\n\n## Installation\n\nRun `npm` to add `@infisical/sdk` to your project.\n\n```console\n$ npm install @infisical/sdk\n```\n\n## Configuration\n\nImport the SDK and create a client instance with your [Machine Identity](/documentation/platform/identities/overview).\n\n\u003cTabs\u003e\n\u003cTab title=\"ES6\"\u003e\n```js\nimport { InfisicalClient, LogLevel } from \"@infisical/sdk\";\n\nconst client = new InfisicalClient({\nauth: {\nuniversalAuth: {\nclientId: \"YOUR_CLIENT_ID\",\nclientSecret: \"YOUR_CLIENT_SECRET\"\n}\n},\nlogLevel: LogLevel.Error\n});\n```\n\n\u003c/Tab\u003e\n\u003cTab title=\"ES5\"\u003e\n```js\nconst { InfisicalClient } = require(\"@infisical/sdk\");\n\nconst client = new InfisicalClient({\nauth: {\nuniversalAuth: {\nclientId: \"YOUR_CLIENT_ID\",\nclientSecret: \"YOUR_CLIENT_SECRET\"\n}\n},\n});\n```\n\n\u003c/Tab\u003e\n\u003c/Tabs\u003e\n\n### Parameters\n\n\u003cParamField query=\"options\" type=\"object\"\u003e\n\u003cExpandable title=\"properties\"\u003e\n\u003cParamField query=\"clientId\" deprecated type=\"string\" optional\u003e\nYour machine identity client ID.\n\n**This field is deprecated and will be removed in future versions.** Please use the `auth.universalAuth.clientId` field instead.\n\u003c/ParamField\u003e\n\u003cParamField query=\"clientSecret\" deprecated type=\"string\" optional\u003e\nYour machine identity client secret.\n\n**This field is deprecated and will be removed in future versions.** Please use the `auth.universalAuth.clientSecret` field instead.\n\u003c/ParamField\u003e\n\n\u003cParamField query=\"accessToken\" deprecated type=\"string\" optional\u003e\nAn access token obtained from the machine identity login endpoint.\n\n**This field is deprecated and will be removed in future versions.** Please use the `auth.accessToken` field instead.\n\u003c/ParamField\u003e\n\n\u003cParamField query=\"cacheTtl\" type=\"number\" default=\"300\" optional\u003e\nTime-to-live (in seconds) for refreshing cached secrets.\nIf manually set to 0, caching will be disabled, this is not recommended.\n\u003c/ParamField\u003e\n\n\u003cParamField query=\"siteUrl\" type=\"string\" default=\"https://app.infisical.com\" optional\u003e\nYour self-hosted absolute site URL including the protocol (e.g. `https://app.infisical.com`)\n\u003c/ParamField\u003e\n\u003cParamField query=\"logLevel\" type=\"enum\" default=\"Error\" optional\u003e\nThe level of logs you wish to log The logs are derived from Rust, as we have written our base SDK in Rust.\n\u003c/ParamField\u003e\n\n\u003cParamField query=\"sslCertificatePath\" optional\u003e\nOptionally provide a path to a custom SSL certificate file. This can be substituted by setting the `INFISICAL_SSL_CERTIFICATE` environment variable to the contents of the certificate.\n\u003c/ParamField\u003e\n\n\u003cParamField query=\"auth\" type=\"AuthenticationOptions\"\u003e\nThe authentication object to use for the client. This is required unless you're using environment variables.\n\u003c/ParamField\u003e\n\u003c/Expandable\u003e\n\n\u003c/ParamField\u003e\n\n\n### Authentication\n\nThe SDK supports a variety of authentication methods. The most common authentication method is Universal Auth, which uses a client ID and client secret to authenticate.\n\n#### Universal Auth\n\n**Using environment variables**\n- `INFISICAL_UNIVERSAL_AUTH_CLIENT_ID` - Your machine identity client ID.\n- `INFISICAL_UNIVERSAL_AUTH_CLIENT_SECRET` - Your machine identity client secret.\n\n**Using the SDK directly**\n```js\nconst client = new InfisicalClient({\nauth: {\nuniversalAuth: {\nclientId: \"YOUR_CLIENT_ID\",\nclientSecret: \"YOUR_CLIENT_SECRET\"\n}\n}\n});\n```\n\n#### GCP ID Token Auth\n\u003cInfo\u003e\nPlease note that this authentication method will only work if you're running your application on Google Cloud Platform.\nPlease [read more](/documentation/platform/identities/gcp-auth) about this authentication method.\n\u003c/Info\u003e\n\n**Using environment variables**\n- `INFISICAL_GCP_AUTH_IDENTITY_ID` - Your Infisical Machine Identity ID.\n\n**Using the SDK directly**\n```js\nconst client = new InfisicalClient({\nauth: {\ngcpIdToken: {\nidentityId: \"YOUR_IDENTITY_ID\"\n}\n}\n});\n```\n\n#### GCP IAM Auth\n\n**Using environment variables**\n- `INFISICAL_GCP_IAM_AUTH_IDENTITY_ID` - Your Infisical Machine Identity ID.\n- `INFISICAL_GCP_IAM_SERVICE_ACCOUNT_KEY_FILE_PATH` - The path to your GCP service account key file.\n\n**Using the SDK directly**\n```js\nconst client = new InfisicalClient({\nauth: {\ngcpIam: {\nidentityId: \"YOUR_IDENTITY_ID\",\nserviceAccountKeyFilePath: \"./path/to/your/service-account-key.json\"\n}\n}\n});\n```\n\n#### AWS IAM Auth\n\u003cInfo\u003e\nPlease note that this authentication method will only work if you're running your application on AWS.\nPlease [read more](/documentation/platform/identities/aws-auth) about this authentication method.\n\u003c/Info\u003e\n\n**Using environment variables**\n- `INFISICAL_AWS_IAM_AUTH_IDENTITY_ID` - Your Infisical Machine Identity ID.\n\n**Using the SDK directly**\n```js\nconst client = new InfisicalClient({\nauth: {\nawsIam: {\nidentityId: \"YOUR_IDENTITY_ID\"\n}\n}\n});\n```\n\n#### Azure Auth\n\u003cInfo\u003e\nPlease note that this authentication method will only work if you're running your application on Azure.\nPlease [read more](/documentation/platform/identities/azure-auth) about this authentication method.\n\u003c/Info\u003e\n\n**Using environment variables**\n- `INFISICAL_AZURE_AUTH_IDENTITY_ID` - Your Infisical Machine Identity ID.\n\n**Using the SDK directly**\n```js\nconst client = new InfisicalClient({\nauth: {\nazure: {\nidentityId: \"YOUR_IDENTITY_ID\"\n}\n}\n});\n```\n\n\n#### Kubernetes Auth\n\u003cInfo\u003e\nPlease note that this authentication method will only work if you're running your application on Kubernetes.\nPlease [read more](/documentation/platform/identities/kubernetes-auth) about this authentication method.\n\u003c/Info\u003e\n\n**Using environment variables**\n- `INFISICAL_KUBERNETES_IDENTITY_ID` - Your Infisical Machine Identity ID.\n- `INFISICAL_KUBERNETES_SERVICE_ACCOUNT_TOKEN_PATH_ENV_NAME` - The environment variable name that contains the path to the service account token. This is optional and will default to `/var/run/secrets/kubernetes.io/serviceaccount/token`.\n\n**Using the SDK directly**\n```js\nconst client = new InfisicalClient({\nauth: {\nkubernetes: {\nidentityId: \"YOUR_IDENTITY_ID\",\nserviceAccountTokenPathEnvName: \"/var/run/secrets/kubernetes.io/serviceaccount/token\" // Optional\n}\n}\n});\n```\n\n### Caching\n\nTo reduce the number of API requests, the SDK temporarily stores secrets it retrieves. By default, a secret remains cached for 5 minutes after it's first fetched. Each time it's fetched again, this 5-minute timer resets. You can adjust this caching duration by setting the \"cacheTtl\" option when creating the client.\n\n## Working with Secrets\n\n### client.listSecrets(options)\n\n```js\nconst secrets = await client.listSecrets({\nenvironment: \"dev\",\nprojectId: \"PROJECT_ID\",\npath: \"/foo/bar/\",\nincludeImports: false\n});\n```\n\nRetrieve all secrets within the Infisical project and environment that client is connected to\n\n#### Parameters\n\n\u003cParamField query=\"Parameters\" type=\"object\"\u003e\n\u003cExpandable title=\"properties\"\u003e\n\u003cParamField query=\"environment\" type=\"string\" required\u003e\nThe slug name (dev, prod, etc) of the environment from where secrets should be fetched from.\n\u003c/ParamField\u003e\n\u003cParamField query=\"projectId\" type=\"string\" required\u003e\nThe project ID where the secret lives in.\n\u003c/ParamField\u003e\n\n\u003cParamField query=\"path\" type=\"string\" optional\u003e\nThe path from where secrets should be fetched from.\n\u003c/ParamField\u003e\n\n\u003cParamField query=\"attachToProcessEnv\" type=\"boolean\" default=\"false\" optional\u003e\nWhether or not to set the fetched secrets to the process environment. If true, you can access the secrets like so `process.env[\"SECRET_NAME\"]`.\n\u003c/ParamField\u003e\n\n\u003cParamField query=\"recursive\" type=\"boolean\" default=\"false\" optional\u003e\nWhether or not to fetch secrets recursively from the specified path. Please note that there's a 20-depth limit for recursive fetching.\n\u003c/ParamField\u003e\n\n\u003cParamField query=\"expandSecretReferences\" type=\"boolean\" default=\"true\" optional\u003e\nWhether or not to expand secret references in the fetched secrets. Read about [secret reference](/documentation/platform/secret-reference)\n\u003c/ParamField\u003e\n\n\u003cParamField query=\"includeImports\" type=\"false\" default=\"boolean\" optional\u003e\nWhether or not to include imported secrets from the current path. Read about [secret import](/documentation/platform/secret-reference)\n\u003c/ParamField\u003e\n\u003c/Expandable\u003e\n\n\u003c/ParamField\u003e\n\n### client.getSecret(options)\n\n```js\nconst secret = await client.getSecret({\nenvironment: \"dev\",\nprojectId: \"PROJECT_ID\",\nsecretName: \"API_KEY\",\npath: \"/\",\ntype: \"shared\"\n});\n```\n\nRetrieve a secret from Infisical.\n\nBy default, `getSecret()` fetches and returns a shared secret.\n\n#### Parameters\n\n\u003cParamField query=\"Parameters\" type=\"object\" optional\u003e\n\u003cExpandable title=\"properties\"\u003e\n\u003cParamField query=\"secretName\" type=\"string\" required\u003e\nThe key of the secret to retrieve.\n\u003c/ParamField\u003e\n\u003cParamField query=\"projectId\" type=\"string\" required\u003e\nThe project ID where the secret lives in.\n\u003c/ParamField\u003e\n\u003cParamField query=\"environment\" type=\"string\" required\u003e\nThe slug name (dev, prod, etc) of the environment from where secrets should be fetched from.\n\u003c/ParamField\u003e\n\u003cParamField query=\"path\" type=\"string\" optional\u003e\nThe path from where secret should be fetched from.\n\u003c/ParamField\u003e\n\u003cParamField query=\"type\" type=\"string\" optional\u003e\nThe type of the secret. Valid options are \"shared\" or \"personal\". If not specified, the default value is \"shared\".\n\u003c/ParamField\u003e\n\u003cParamField query=\"includeImports\" type=\"boolean\" optional\u003e\nWhether or not to include imported secrets from the current path. Read about [secret import](/documentation/platform/secret-reference)\n\u003c/ParamField\u003e\n\u003cParamField query=\"expandSecretReferences\" type=\"boolean\" default=\"true\" optional\u003e\nWhether or not to expand secret references in the fetched secrets. Read about [secret reference](/documentation/platform/secret-reference)\n\u003c/ParamField\u003e\n\u003c/Expandable\u003e\n\u003c/ParamField\u003e\n\n### client.createSecret(options)\n\n```js\nconst newApiKey = await client.createSecret({\nprojectId: \"PROJECT_ID\",\nenvironment: \"dev\",\nsecretName: \"API_KEY\",\nsecretValue: \"SECRET VALUE\",\npath: \"/\",\ntype: \"shared\"\n});\n```\n\nCreate a new secret in Infisical.\n\n\u003cParamField query=\"Parameters\" type=\"object\" optional\u003e\n\u003cExpandable title=\"properties\"\u003e\n\u003cParamField query=\"secretName\" type=\"string\" required\u003e\nThe key of the secret to create.\n\u003c/ParamField\u003e\n\u003cParamField query=\"secretValue\" type=\"string\" required\u003e\nThe value of the secret.\n\u003c/ParamField\u003e\n\u003cParamField query=\"projectId\" type=\"string\" required\u003e\nThe project ID where the secret lives in.\n\u003c/ParamField\u003e\n\u003cParamField query=\"environment\" type=\"string\" required\u003e\nThe slug name (dev, prod, etc) of the environment from where secrets should be fetched from.\n\u003c/ParamField\u003e\n\u003cParamField query=\"path\" type=\"string\" optional\u003e\nThe path from where secret should be created.\n\u003c/ParamField\u003e\n\u003cParamField query=\"type\" type=\"string\" optional\u003e\nThe type of the secret. Valid options are \"shared\" or \"personal\". If not specified, the default value is \"shared\".\n\u003c/ParamField\u003e\n\u003c/Expandable\u003e\n\u003c/ParamField\u003e\n\n### client.updateSecret(options)\n\n```js\nconst updatedApiKey = await client.updateSecret({\nsecretName: \"API_KEY\",\nsecretValue: \"NEW SECRET VALUE\",\nprojectId: \"PROJECT_ID\",\nenvironment: \"dev\",\npath: \"/\",\ntype: \"shared\"\n});\n```\n\nUpdate an existing secret in Infisical.\n\n#### Parameters\n\n\u003cParamField query=\"Parameters\" type=\"object\" optional\u003e\n\u003cExpandable title=\"properties\"\u003e\n\u003cParamField query=\"secretName\" type=\"string\" required\u003e\nThe key of the secret to update.\n\u003c/ParamField\u003e\n\u003cParamField query=\"secretValue\" type=\"string\" required\u003e\nThe new value of the secret.\n\u003c/ParamField\u003e\n\u003cParamField query=\"projectId\" type=\"string\" required\u003e\nThe project ID where the secret lives in.\n\u003c/ParamField\u003e\n\u003cParamField query=\"environment\" type=\"string\" required\u003e\nThe slug name (dev, prod, etc) of the environment from where secrets should be fetched from.\n\u003c/ParamField\u003e\n\u003cParamField query=\"path\" type=\"string\" optional\u003e\nThe path from where secret should be updated.\n\u003c/ParamField\u003e\n\u003cParamField query=\"type\" type=\"string\" optional\u003e\nThe type of the secret. Valid options are \"shared\" or \"personal\". If not specified, the default value is \"shared\".\n\u003c/ParamField\u003e\n\u003c/Expandable\u003e\n\u003c/ParamField\u003e\n\n### client.deleteSecret(options)\n\n```js\nconst deletedSecret = await client.deleteSecret({\nsecretName: \"API_KEY\",\n\nenvironment: \"dev\",\nprojectId: \"PROJECT_ID\",\npath: \"/\",\n\ntype: \"shared\"\n});\n```\n\nDelete a secret in Infisical.\n\n\u003cParamField query=\"Parameters\" type=\"object\" optional\u003e\n\u003cExpandable title=\"properties\"\u003e\n\u003cParamField query=\"secretName\" type=\"string\"\u003e\nThe key of the secret to update.\n\u003c/ParamField\u003e\n\u003cParamField query=\"projectId\" type=\"string\" required\u003e\nThe project ID where the secret lives in.\n\u003c/ParamField\u003e\n\u003cParamField query=\"environment\" type=\"string\" required\u003e\nThe slug name (dev, prod, etc) of the environment from where secrets should be fetched from.\n\u003c/ParamField\u003e\n\u003cParamField query=\"path\" type=\"string\" optional\u003e\nThe path from where secret should be deleted.\n\u003c/ParamField\u003e\n\u003cParamField query=\"type\" type=\"string\" optional\u003e\nThe type of the secret. Valid options are \"shared\" or \"personal\". If not specified, the default value is \"shared\".\n\u003c/ParamField\u003e\n\u003c/Expandable\u003e\n\u003c/ParamField\u003e\n\n## Cryptography\n\n### Create a symmetric key\n\nCreate a base64-encoded, 256-bit symmetric key to be used for encryption/decryption.\n\n```js\nconst key = client.createSymmetricKey();\n```\n\n#### Returns (string)\n`key` (string): A base64-encoded, 256-bit symmetric key, that can be used for encryption/decryption purposes.\n\n### Encrypt symmetric\n```js\nconst { iv, tag, ciphertext } = await client.encryptSymmetric({\nkey: key,\nplaintext: \"Infisical is awesome!\",\n})\n```\n\n#### Parameters\n\n\u003cParamField query=\"Parameters\" type=\"object\" required\u003e\n\u003cExpandable title=\"properties\"\u003e\n\u003cParamField query=\"plaintext\" type=\"string\"\u003e\nThe plaintext you want to encrypt.\n\u003c/ParamField\u003e\n\u003cParamField query=\"key\" type=\"string\" required\u003e\nThe symmetric key to use for encryption.\n\u003c/ParamField\u003e\n\u003c/Expandable\u003e\n\u003c/ParamField\u003e\n\n#### Returns (object)\n`tag` (string): A base64-encoded, 128-bit authentication tag.\n`iv` (string): A base64-encoded, 96-bit initialization vector.\n`ciphertext` (string): A base64-encoded, encrypted ciphertext.\n\n### Decrypt symmetric\n```js\nconst decryptedString = await client.decryptSymmetric({\nkey: key,\niv: iv,\ntag: tag,\nciphertext: ciphertext,\n});\n```\n\n#### Parameters\n\u003cParamField query=\"Parameters\" type=\"object\" required\u003e\n\u003cExpandable title=\"properties\"\u003e\n\u003cParamField query=\"ciphertext\" type=\"string\"\u003e\nThe ciphertext you want to decrypt.\n\u003c/ParamField\u003e\n\u003cParamField query=\"key\" type=\"string\" required\u003e\nThe symmetric key to use for encryption.\n\u003c/ParamField\u003e\n\u003cParamField query=\"iv\" type=\"string\" required\u003e\nThe initialization vector to use for decryption.\n\u003c/ParamField\u003e\n\u003cParamField query=\"tag\" type=\"string\" required\u003e\nThe authentication tag to use for decryption.\n\u003c/ParamField\u003e\n\u003c/Expandable\u003e\n\u003c/ParamField\u003e\n\n#### Returns (string)\n`plaintext` (string): The decrypted plaintext.\n\n*/\nconst {Fragment: _Fragment, jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n return _jsx(_Fragment, {});\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = Object.assign({}, _provideComponents(), props.components);\n return MDXLayout ? _jsx(MDXLayout, Object.assign({}, props, {\n children: _jsx(_createMdxContent, props)\n })) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{"mintConfig":{"$schema":"https://mintlify.com/schema.json","name":"Infisical","logo":{"light":"https://mintlify.s3.us-west-1.amazonaws.com/infisical/logo/light.svg","dark":"https://mintlify.s3.us-west-1.amazonaws.com/infisical/logo/dark.svg","href":"https://infisical.com"},"favicon":"/favicon.png","openapi":"https://app.infisical.com/api/docs/json","api":{"baseUrl":["https://app.infisical.com","http://localhost:8080"]},"modeToggle":{"default":"light","isHidden":true},"colors":{"primary":"#26272b","light":"#97b31d","dark":"#A1B659","background":{"light":"#ffffff","dark":"#0D1117"},"anchors":{"from":"#000000","to":"#707174"},"ultraLight":"#E7F256","ultraDark":"#8D9F4C"},"topbarCtaButton":{"name":"Start for Free","url":"https://app.infisical.com/signup"},"topbarLinks":[{"url":"https://app.infisical.com/login","name":"Log In","_id":"6746db41cbe3178400aa60e4"}],"navigation":[{"group":"Getting Started","pages":["documentation/getting-started/introduction",{"group":"Quickstart","pages":["documentation/guides/local-development"]},{"group":"Guides","pages":["documentation/guides/introduction","documentation/guides/node","documentation/guides/python","documentation/guides/nextjs-vercel","documentation/guides/microsoft-power-apps","documentation/guides/organization-structure"]}]},{"group":"Platform","pages":["documentation/platform/organization","documentation/platform/project","documentation/platform/folder",{"group":"Secrets","pages":["documentation/platform/secret-versioning","documentation/platform/pit-recovery","documentation/platform/secret-reference","documentation/platform/webhooks"]},{"group":"Internal PKI","pages":["documentation/platform/pki/overview","documentation/platform/pki/private-ca","documentation/platform/pki/certificates","documentation/platform/pki/pki-issuer","documentation/platform/pki/est","documentation/platform/pki/alerting"]},{"group":"Key Management (KMS)","pages":["documentation/platform/kms/overview","documentation/platform/kms/hsm-integration","documentation/platform/kms/kubernetes-encryption"]},{"group":"KMS Configuration","pages":["documentation/platform/kms-configuration/overview","documentation/platform/kms-configuration/aws-kms","documentation/platform/kms-configuration/aws-hsm"]},{"group":"Identities","pages":["documentation/platform/identities/overview","documentation/platform/identities/user-identities","documentation/platform/identities/machine-identities"]},{"group":"Access Control","pages":["documentation/platform/access-controls/overview","documentation/platform/access-controls/role-based-access-controls","documentation/platform/access-controls/attribute-based-access-controls","documentation/platform/access-controls/additional-privileges","documentation/platform/access-controls/temporary-access","documentation/platform/access-controls/access-requests","documentation/platform/pr-workflows","documentation/platform/groups"]},{"group":"Audit Logs","pages":["documentation/platform/audit-logs","documentation/platform/audit-log-streams/audit-log-streams","documentation/platform/audit-log-streams/audit-log-streams-with-fluentbit"]},{"group":"Secret Rotation","pages":["documentation/platform/secret-rotation/overview","documentation/platform/secret-rotation/sendgrid","documentation/platform/secret-rotation/postgres","documentation/platform/secret-rotation/mysql","documentation/platform/secret-rotation/mssql","documentation/platform/secret-rotation/aws-iam"]},{"group":"Dynamic Secrets","pages":["documentation/platform/dynamic-secrets/overview","documentation/platform/dynamic-secrets/postgresql","documentation/platform/dynamic-secrets/mysql","documentation/platform/dynamic-secrets/mssql","documentation/platform/dynamic-secrets/oracle","documentation/platform/dynamic-secrets/cassandra","documentation/platform/dynamic-secrets/redis","documentation/platform/dynamic-secrets/aws-elasticache","documentation/platform/dynamic-secrets/elastic-search","documentation/platform/dynamic-secrets/rabbit-mq","documentation/platform/dynamic-secrets/aws-iam","documentation/platform/dynamic-secrets/mongo-atlas","documentation/platform/dynamic-secrets/mongo-db","documentation/platform/dynamic-secrets/azure-entra-id","documentation/platform/dynamic-secrets/ldap","documentation/platform/dynamic-secrets/sap-ase","documentation/platform/dynamic-secrets/sap-hana","documentation/platform/dynamic-secrets/snowflake","documentation/platform/dynamic-secrets/totp"]},"documentation/platform/project-templates",{"group":"Workflow Integrations","pages":["documentation/platform/workflow-integrations/slack-integration"]},{"group":"Admin Consoles","pages":["documentation/platform/admin-panel/overview","documentation/platform/admin-panel/server-admin","documentation/platform/admin-panel/org-admin-console"]},"documentation/platform/secret-sharing"]},{"group":"Authentication Methods","pages":["documentation/platform/auth-methods/email-password","documentation/platform/token","documentation/platform/identities/token-auth","documentation/platform/identities/universal-auth","documentation/platform/identities/kubernetes-auth","documentation/platform/identities/gcp-auth","documentation/platform/identities/azure-auth","documentation/platform/identities/aws-auth",{"group":"OIDC Auth","pages":["documentation/platform/identities/oidc-auth/general","documentation/platform/identities/oidc-auth/github","documentation/platform/identities/oidc-auth/circleci","documentation/platform/identities/oidc-auth/gitlab"]},"documentation/platform/mfa",{"group":"SSO","pages":["documentation/platform/sso/overview","documentation/platform/sso/google","documentation/platform/sso/github","documentation/platform/sso/gitlab","documentation/platform/sso/okta","documentation/platform/sso/azure","documentation/platform/sso/jumpcloud","documentation/platform/sso/keycloak-saml","documentation/platform/sso/google-saml","documentation/platform/sso/keycloak-oidc","documentation/platform/sso/auth0-oidc","documentation/platform/sso/general-oidc"]},{"group":"LDAP","pages":["documentation/platform/ldap/overview","documentation/platform/ldap/jumpcloud","documentation/platform/ldap/general"]},{"group":"SCIM","pages":["documentation/platform/scim/overview","documentation/platform/scim/okta","documentation/platform/scim/azure","documentation/platform/scim/jumpcloud","documentation/platform/scim/group-mappings"]}]},{"group":"Self-host Infisical","pages":["self-hosting/overview",{"group":"Containerized installation methods","pages":["self-hosting/deployment-options/standalone-infisical","self-hosting/deployment-options/docker-swarm","self-hosting/deployment-options/docker-compose","self-hosting/deployment-options/kubernetes-helm"]},"self-hosting/configuration/envars","self-hosting/configuration/requirements",{"group":"Guides","pages":["self-hosting/configuration/schema-migrations","self-hosting/guides/mongo-to-postgres","self-hosting/guides/custom-certificates"]},{"group":"Reference architectures","pages":["self-hosting/reference-architectures/aws-ecs","self-hosting/reference-architectures/linux-deployment-ha"]},"self-hosting/ee","self-hosting/faq"]},{"group":"Command line","pages":["cli/overview","cli/usage",{"group":"Core commands","pages":["cli/commands/login","cli/commands/init","cli/commands/run","cli/commands/secrets","cli/commands/dynamic-secrets","cli/commands/export","cli/commands/token","cli/commands/service-token","cli/commands/vault","cli/commands/user","cli/commands/reset",{"group":"infisical scan","pages":["cli/commands/scan","cli/commands/scan-git-changes","cli/commands/scan-install"]}]},"cli/scanning-overview","cli/project-config","cli/faq"]},{"group":"Infrastructure Integrations","pages":[{"group":"Container orchestrators","pages":["integrations/platforms/kubernetes","integrations/platforms/docker-swarm-with-agent","integrations/platforms/ecs-with-agent"]},"integrations/platforms/infisical-agent",{"group":"Docker","pages":["integrations/platforms/docker-intro","integrations/platforms/docker","integrations/platforms/docker-pass-envs","integrations/platforms/docker-compose"]},"integrations/frameworks/terraform","integrations/platforms/ansible"]},{"group":"Native Integrations","pages":[{"group":"AWS","pages":["integrations/cloud/aws-parameter-store","integrations/cloud/aws-secret-manager","integrations/cloud/aws-amplify"]},"integrations/cloud/vercel","integrations/cloud/azure-key-vault","integrations/cloud/azure-app-configuration","integrations/cloud/azure-devops","integrations/cloud/gcp-secret-manager",{"group":"Cloudflare","pages":["integrations/cloud/cloudflare-pages","integrations/cloud/cloudflare-workers"]},"integrations/cloud/terraform-cloud","integrations/cloud/databricks",{"group":"View more","pages":["integrations/cloud/digital-ocean-app-platform","integrations/cloud/heroku","integrations/cloud/netlify","integrations/cloud/railway","integrations/cloud/flyio","integrations/cloud/render","integrations/cloud/laravel-forge","integrations/cloud/supabase","integrations/cloud/northflank","integrations/cloud/hasura-cloud","integrations/cloud/qovery","integrations/cloud/hashicorp-vault","integrations/cloud/cloud-66","integrations/cloud/windmill"]}]},{"group":"CI/CD Integrations","pages":["integrations/cicd/jenkins","integrations/cicd/githubactions","integrations/cicd/gitlab","integrations/cicd/bitbucket","integrations/cloud/teamcity",{"group":"View more","pages":["integrations/cicd/circleci","integrations/cicd/travisci","integrations/cicd/rundeck","integrations/cicd/codefresh","integrations/cloud/checkly","integrations/cicd/octopus-deploy"]}]},{"group":"Framework Integrations","pages":["integrations/frameworks/spring-boot-maven","integrations/frameworks/react","integrations/frameworks/vue","integrations/frameworks/express",{"group":"View more","pages":["integrations/frameworks/nextjs","integrations/frameworks/nestjs","integrations/frameworks/sveltekit","integrations/frameworks/nuxt","integrations/frameworks/gatsby","integrations/frameworks/remix","integrations/frameworks/vite","integrations/frameworks/fiber","integrations/frameworks/django","integrations/frameworks/flask","integrations/frameworks/laravel","integrations/frameworks/rails","integrations/frameworks/dotnet","integrations/platforms/pm2"]}]},{"group":"Build Tool Integrations","pages":["integrations/build-tools/gradle"]},{"group":"","pages":["sdks/overview"]},{"group":"SDK's","pages":["sdks/languages/node","sdks/languages/python","sdks/languages/go","sdks/languages/ruby","sdks/languages/java","sdks/languages/csharp"]},{"group":"Overview","pages":["api-reference/overview/introduction","api-reference/overview/authentication",{"group":"Examples","pages":["api-reference/overview/examples/integration"]}]},{"group":"Endpoints","pages":[{"group":"Identities","pages":["api-reference/endpoints/identities/create","api-reference/endpoints/identities/update","api-reference/endpoints/identities/delete","api-reference/endpoints/identities/get-by-id","api-reference/endpoints/identities/list"]},{"group":"Token Auth","pages":["api-reference/endpoints/token-auth/attach","api-reference/endpoints/token-auth/retrieve","api-reference/endpoints/token-auth/update","api-reference/endpoints/token-auth/revoke","api-reference/endpoints/token-auth/get-tokens","api-reference/endpoints/token-auth/create-token","api-reference/endpoints/token-auth/update-token","api-reference/endpoints/token-auth/revoke-token"]},{"group":"Universal Auth","pages":["api-reference/endpoints/universal-auth/login","api-reference/endpoints/universal-auth/attach","api-reference/endpoints/universal-auth/retrieve","api-reference/endpoints/universal-auth/update","api-reference/endpoints/universal-auth/revoke","api-reference/endpoints/universal-auth/create-client-secret","api-reference/endpoints/universal-auth/list-client-secrets","api-reference/endpoints/universal-auth/revoke-client-secret","api-reference/endpoints/universal-auth/get-client-secret-by-id","api-reference/endpoints/universal-auth/renew-access-token","api-reference/endpoints/universal-auth/revoke-access-token"]},{"group":"GCP Auth","pages":["api-reference/endpoints/gcp-auth/login","api-reference/endpoints/gcp-auth/attach","api-reference/endpoints/gcp-auth/retrieve","api-reference/endpoints/gcp-auth/update","api-reference/endpoints/gcp-auth/revoke"]},{"group":"AWS Auth","pages":["api-reference/endpoints/aws-auth/login","api-reference/endpoints/aws-auth/attach","api-reference/endpoints/aws-auth/retrieve","api-reference/endpoints/aws-auth/update","api-reference/endpoints/aws-auth/revoke"]},{"group":"Azure Auth","pages":["api-reference/endpoints/azure-auth/login","api-reference/endpoints/azure-auth/attach","api-reference/endpoints/azure-auth/retrieve","api-reference/endpoints/azure-auth/update","api-reference/endpoints/azure-auth/revoke"]},{"group":"Kubernetes Auth","pages":["api-reference/endpoints/kubernetes-auth/login","api-reference/endpoints/kubernetes-auth/attach","api-reference/endpoints/kubernetes-auth/retrieve","api-reference/endpoints/kubernetes-auth/update","api-reference/endpoints/kubernetes-auth/revoke"]},{"group":"OIDC Auth","pages":["api-reference/endpoints/oidc-auth/login","api-reference/endpoints/oidc-auth/attach","api-reference/endpoints/oidc-auth/retrieve","api-reference/endpoints/oidc-auth/update","api-reference/endpoints/oidc-auth/revoke"]},{"group":"Groups","pages":["api-reference/endpoints/groups/create","api-reference/endpoints/groups/update","api-reference/endpoints/groups/delete","api-reference/endpoints/groups/get","api-reference/endpoints/groups/get-by-id","api-reference/endpoints/groups/add-group-user","api-reference/endpoints/groups/remove-group-user","api-reference/endpoints/groups/list-group-users"]},{"group":"Organizations","pages":["api-reference/endpoints/organizations/memberships","api-reference/endpoints/organizations/update-membership","api-reference/endpoints/organizations/delete-membership","api-reference/endpoints/organizations/list-identity-memberships","api-reference/endpoints/organizations/workspaces"]},{"group":"Projects","pages":["api-reference/endpoints/workspaces/create-workspace","api-reference/endpoints/workspaces/delete-workspace","api-reference/endpoints/workspaces/get-workspace","api-reference/endpoints/workspaces/update-workspace","api-reference/endpoints/workspaces/secret-snapshots","api-reference/endpoints/workspaces/rollback-snapshot"]},{"group":"Project Users","pages":["api-reference/endpoints/project-users/invite-member-to-workspace","api-reference/endpoints/project-users/remove-member-from-workspace","api-reference/endpoints/project-users/memberships","api-reference/endpoints/project-users/get-by-username","api-reference/endpoints/project-users/update-membership"]},{"group":"Project Groups","pages":["api-reference/endpoints/project-groups/create","api-reference/endpoints/project-groups/delete","api-reference/endpoints/project-groups/get-by-id","api-reference/endpoints/project-groups/list","api-reference/endpoints/project-groups/update"]},{"group":"Project Identities","pages":["api-reference/endpoints/project-identities/add-identity-membership","api-reference/endpoints/project-identities/list-identity-memberships","api-reference/endpoints/project-identities/get-by-id","api-reference/endpoints/project-identities/update-identity-membership","api-reference/endpoints/project-identities/delete-identity-membership"]},{"group":"Project Roles","pages":["api-reference/endpoints/project-roles/create","api-reference/endpoints/project-roles/update","api-reference/endpoints/project-roles/delete","api-reference/endpoints/project-roles/get-by-slug","api-reference/endpoints/project-roles/list"]},{"group":"Project Templates","pages":["api-reference/endpoints/project-templates/create","api-reference/endpoints/project-templates/update","api-reference/endpoints/project-templates/delete","api-reference/endpoints/project-templates/get-by-id","api-reference/endpoints/project-templates/list"]},{"group":"Environments","pages":["api-reference/endpoints/environments/create","api-reference/endpoints/environments/update","api-reference/endpoints/environments/delete"]},{"group":"Folders","pages":["api-reference/endpoints/folders/list","api-reference/endpoints/folders/get-by-id","api-reference/endpoints/folders/create","api-reference/endpoints/folders/update","api-reference/endpoints/folders/delete"]},{"group":"Secret Tags","pages":["api-reference/endpoints/secret-tags/list","api-reference/endpoints/secret-tags/get-by-id","api-reference/endpoints/secret-tags/get-by-slug","api-reference/endpoints/secret-tags/create","api-reference/endpoints/secret-tags/update","api-reference/endpoints/secret-tags/delete"]},{"group":"Secrets","pages":["api-reference/endpoints/secrets/list","api-reference/endpoints/secrets/create","api-reference/endpoints/secrets/read","api-reference/endpoints/secrets/update","api-reference/endpoints/secrets/delete","api-reference/endpoints/secrets/create-many","api-reference/endpoints/secrets/update-many","api-reference/endpoints/secrets/delete-many","api-reference/endpoints/secrets/attach-tags","api-reference/endpoints/secrets/detach-tags"]},{"group":"Dynamic Secrets","pages":["api-reference/endpoints/dynamic-secrets/create","api-reference/endpoints/dynamic-secrets/update","api-reference/endpoints/dynamic-secrets/delete","api-reference/endpoints/dynamic-secrets/get","api-reference/endpoints/dynamic-secrets/list","api-reference/endpoints/dynamic-secrets/list-leases","api-reference/endpoints/dynamic-secrets/create-lease","api-reference/endpoints/dynamic-secrets/delete-lease","api-reference/endpoints/dynamic-secrets/renew-lease","api-reference/endpoints/dynamic-secrets/get-lease"]},{"group":"Secret Imports","pages":["api-reference/endpoints/secret-imports/list","api-reference/endpoints/secret-imports/create","api-reference/endpoints/secret-imports/update","api-reference/endpoints/secret-imports/delete"]},{"group":"Identity Specific Privilege","pages":["api-reference/endpoints/identity-specific-privilege/create-permanent","api-reference/endpoints/identity-specific-privilege/create-temporary","api-reference/endpoints/identity-specific-privilege/update","api-reference/endpoints/identity-specific-privilege/delete","api-reference/endpoints/identity-specific-privilege/find-by-slug","api-reference/endpoints/identity-specific-privilege/list"]},{"group":"Integrations","pages":["api-reference/endpoints/integrations/create-auth","api-reference/endpoints/integrations/list-auth","api-reference/endpoints/integrations/find-auth","api-reference/endpoints/integrations/delete-auth","api-reference/endpoints/integrations/delete-auth-by-id","api-reference/endpoints/integrations/create","api-reference/endpoints/integrations/update","api-reference/endpoints/integrations/delete","api-reference/endpoints/integrations/list-project-integrations"]},{"group":"Service Tokens","pages":["api-reference/endpoints/service-tokens/get"]},{"group":"Audit Logs","pages":["api-reference/endpoints/audit-logs/export-audit-log"]}]},{"group":"Infisical PKI","pages":[{"group":"Certificate Authorities","pages":["api-reference/endpoints/certificate-authorities/list","api-reference/endpoints/certificate-authorities/create","api-reference/endpoints/certificate-authorities/read","api-reference/endpoints/certificate-authorities/update","api-reference/endpoints/certificate-authorities/delete","api-reference/endpoints/certificate-authorities/renew","api-reference/endpoints/certificate-authorities/list-ca-certs","api-reference/endpoints/certificate-authorities/csr","api-reference/endpoints/certificate-authorities/cert","api-reference/endpoints/certificate-authorities/sign-intermediate","api-reference/endpoints/certificate-authorities/import-cert","api-reference/endpoints/certificate-authorities/issue-cert","api-reference/endpoints/certificate-authorities/sign-cert","api-reference/endpoints/certificate-authorities/crl"]},{"group":"Certificates","pages":["api-reference/endpoints/certificates/list","api-reference/endpoints/certificates/read","api-reference/endpoints/certificates/revoke","api-reference/endpoints/certificates/delete","api-reference/endpoints/certificates/cert-body","api-reference/endpoints/certificates/issue-certificate","api-reference/endpoints/certificates/sign-certificate"]},{"group":"Certificate Templates","pages":["api-reference/endpoints/certificate-templates/create","api-reference/endpoints/certificate-templates/update","api-reference/endpoints/certificate-templates/get-by-id","api-reference/endpoints/certificate-templates/delete"]},{"group":"Certificate Collections","pages":["api-reference/endpoints/pki-collections/create","api-reference/endpoints/pki-collections/read","api-reference/endpoints/pki-collections/update","api-reference/endpoints/pki-collections/delete","api-reference/endpoints/pki-collections/add-item","api-reference/endpoints/pki-collections/list-items","api-reference/endpoints/pki-collections/delete-item"]},{"group":"PKI Alerting","pages":["api-reference/endpoints/pki-alerts/create","api-reference/endpoints/pki-alerts/read","api-reference/endpoints/pki-alerts/update","api-reference/endpoints/pki-alerts/delete"]}]},{"group":"Infisical KMS","pages":[{"group":"Keys","pages":["api-reference/endpoints/kms/keys/list","api-reference/endpoints/kms/keys/create","api-reference/endpoints/kms/keys/update","api-reference/endpoints/kms/keys/delete","api-reference/endpoints/kms/keys/encrypt","api-reference/endpoints/kms/keys/decrypt"]}]},{"group":"Internals","pages":["internals/overview","internals/permissions","internals/components","internals/flows","internals/security","internals/service-tokens"]},{"group":"","pages":["changelog/overview"]},{"group":"Contributing","pages":[{"group":"Getting Started","pages":["contributing/getting-started/overview","contributing/getting-started/code-of-conduct","contributing/getting-started/pull-requests","contributing/getting-started/faq"]},{"group":"Contributing to platform","pages":["contributing/platform/developing","contributing/platform/backend/how-to-create-a-feature","contributing/platform/backend/folder-structure"]},{"group":"Contributing to SDK","pages":["contributing/sdk/developing"]}]}],"tabs":[{"name":"Integrations","url":"integrations","_id":"6746db41cbe3178400aa60df"},{"name":"CLI","url":"cli","_id":"6746db41cbe3178400aa60e0"},{"name":"API Reference","url":"api-reference","_id":"6746db41cbe3178400aa60e1"},{"name":"SDKs","url":"sdks","_id":"6746db41cbe3178400aa60e2"},{"name":"Changelog","url":"changelog","_id":"6746db41cbe3178400aa60e3"}],"footer":{"socials":{"x":"https://www.twitter.com/infisical/","linkedin":"https://www.linkedin.com/company/infisical/","github":"https://github.com/Infisical/infisical-cli","slack":"https://infisical.com/slack"},"links":[{"title":"PRODUCT","links":[{"label":"Secret Management","url":"https://infisical.com/"},{"label":"Secret Scanning","url":"https://infisical.com/radar"},{"label":"Share Secrets","url":"https://app.infisical.com/share-secret"},{"label":"Pricing","url":"https://infisical.com/pricing"},{"label":"Security","url":"https://infisical.com/docs/internals/security"},{"label":"Blog","url":"https://infisical.com/blog"},{"label":"Infisical vs Vault","url":"https://infisical.com/infisical-vs-hashicorp-vault"},{"label":"Forum","url":"https://questions.infisical.com/"}]},{"title":"USE CASES","links":[{"label":"Infisical Agent","url":"https://infisical.com/docs/documentation/getting-started/introduction"},{"label":"Kubernetes","url":"https://infisical.com/docs/integrations/platforms/kubernetes"},{"label":"Dynamic Secrets","url":"https://infisical.com/docs/documentation/platform/dynamic-secrets/overview"},{"label":"Terraform","url":"https://infisical.com/docs/integrations/frameworks/terraform"},{"label":"Ansible","url":"https://infisical.com/docs/integrations/platforms/ansible"},{"label":"Jenkins","url":"https://infisical.com/docs/integrations/cicd/jenkins"},{"label":"Docker","url":"https://infisical.com/docs/integrations/platforms/docker-intro"},{"label":"AWS ECS","url":"https://infisical.com/docs/integrations/platforms/ecs-with-agent"},{"label":"GitLab","url":"https://infisical.com/docs/integrations/cicd/gitlab"},{"label":"GitHub","url":"https://infisical.com/docs/integrations/cicd/githubactions"},{"label":"SDK","url":"https://infisical.com/docs/sdks/overview"}]},{"title":"DEVELOPERS","links":[{"label":"Changelog","url":"https://www.infisical.com/docs/changelog"},{"label":"Status","url":"https://status.infisical.com/"},{"label":"Feedback \u0026 Requests","url":"https://github.com/Infisical/infisical/issues"},{"label":"Trust of Center","url":"https://app.vanta.com/infisical.com/trust/hoop8cr78cuarxo9sztvs"},{"label":"Open Source Friends","url":"https://infisical.com/infisical-friends"},{"label":"How to contribute","url":"https://www.infisical.com/infisical-heroes"}]},{"title":"OTHERS","links":[{"label":"Customers","url":"https://infisical.com/customers/traba"},{"label":"Company Handbook","url":"https://infisical.com/wiki/handbook/overview"},{"label":"Careers","url":"https://infisical.com/careers"},{"label":"Terms of Service","url":"https://infisical.com/terms"},{"label":"Privacy Policy","url":"https://infisical.com/privacy"},{"label":"Subprocessors","url":"https://infisical.com/subprocessors"},{"label":"SLA","url":"https://infisical.com/sla"},{"label":"Team Email","url":"mailto:team@infisical.com"},{"label":"Sales","url":"mailto:sales@infisical.com"},{"label":"Support","url":"https://infisical.com/slack"}]}]},"feedback":{"thumbsRating":true,"suggestEdit":true,"raiseIssue":true},"analytics":{"posthog":{"apiKey":"phc_Q0xfB3LeOqo7ySk4DE6zLNwDzHFesKcmigknCy4fTdV"},"koala":{"publicApiKey":"pk_b50d7184e0e39ddd5cdb43cf6abeadd9b97d"}},"integrations":{"intercom":"hsg644ru"},"repo":{"github":{"owner":"infisical","repo":"infisical","contentDirectory":"docs","deployBranch":"main"}}},"pageMetadata":{"title":"Infisical Node.js SDK","description":null,"sidebarTitle":"Node.js","url":"https://github.com/Infisical/node-sdk-v2","icon":"node","href":"/sdks/languages/node"}}},"entitlements":{"AI_CHAT":{"status":"ENABLED"}}},"__N_SSG":true},"page":"/_sites/[subdomain]/[[...slug]]","query":{"subdomain":"infisical","slug":["sdks","languages","node"]},"buildId":"DLyUTdO3OSYUYl4V89rim","assetPrefix":"/docs","isFallback":false,"isExperimentalCompile":false,"gsp":true,"scriptLoader":[]}</script></html></body></html>