The Auth API provides scalable API key management, team access and environment controls, plus mission-critical monitoring analytics. It’s built with speed, security and access to your data as our core principles.
Set up real-time triggers to automate your workflows
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"The Auth API Docs","colors":{"primary":"#0D9373","light":"#07C983","dark":"#0D9373"},"favicon":"/favicon.svg","logo":{"light":"https://mintcdn.com/theauthapi/ZRgpOpH3aPERXOqS/logo/light.svg?fit=max\u0026auto=format\u0026n=ZRgpOpH3aPERXOqS\u0026q=85\u0026s=2666a4c31f9d5fd792622d3e7e2178ec","dark":"https://mintcdn.com/theauthapi/ZRgpOpH3aPERXOqS/logo/dark.svg?fit=max\u0026auto=format\u0026n=ZRgpOpH3aPERXOqS\u0026q=85\u0026s=a2e9fda96091369790867c69e60b6fbb"},"api":{"openapi":["api-reference/openapi.json"],"mdx":{"server":"https://api.theauthapi.com","auth":{"method":"key","name":"x-api-key"}}},"navbar":{"links":[{"label":"Support","href":"mailto:support@theauthapi.com?subject=The%20Auth%20API%20Support%20Request"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.theauthapi.com"}},"footer":{"socials":{"x":"https://x.com/theauthapi","github":"https://github.com/thatapicompany","linkedin":"https://www.linkedin.com/company/thatapicompany"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"theauthapi","hasAudioNarration":false,"actualSubdomain":"theauthapi","customDomains":["docs.theauthapi.com"],"gitSource":{"type":"github","owner":"thatapicompany","repo":"theauthapi-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21c96f6b341bdf22e76c5b","collectionId":"3a7563a8-0a06-4046-9356-983e73323203","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21c96f6b341bdf22e76c5b:success","clientVersion":"0.0.3939","searchFilterCounts":[{"language":"default","tag":"API Reference","count":49},{"language":"default","tag":"Endpoint Examples","count":48},{"language":"default","tag":"Documentation","count":18},{"language":"default","tag":"Get Started","count":9},{"language":"default","tag":"Guides","count":5},{"language":"default","tag":"Libraries","count":2},{"language":"default","tag":"API Documentation","count":1},{"language":"default","tag":"Examples","count":1},{"language":"default","tag":"Security","count":1}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"introduction","slug":"/introduction","pageMetadata":{"title":"What is The Auth API?","description":"The Auth API provides scalable API key management, team access and environment controls, plus mission-critical monitoring analytics. It’s built with speed, security and access to your data as our core principles.","href":"/introduction"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"The Auth API provides scalable API key management, team access and environment controls, plus mission-critical monitoring analytics. It’s built with speed, security and access to your data as our core principles.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{Card,CardGroup,Heading}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`setting-up`,children:`Setting up`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`QuickStart`,icon:`truck-fast`,href:`/quickstart`,children:_jsx(_components.p,{children:`Don’t skip the quickstart guide!`})}),_jsx(Card,{title:`API Projects`,icon:`folder`,href:`/guides/projects`,children:_jsx(_components.p,{children:`Scoping access to a codebase or gateway.`})}),_jsx(Card,{title:`Authenticating Keys`,icon:`key`,href:`/guides/authenticating-a-key`,children:_jsx(_components.p,{children:`How to authenticate a key.`})}),_jsx(Card,{title:`Triggers`,icon:`webhook`,href:`/guides/events`,children:_jsx(_components.p,{children:`Set up real-time triggers to automate your workflows`})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"What is The Auth API?","description":"The Auth API provides scalable API key management, team access and environment controls, plus mission-critical monitoring analytics. It’s built with speed, security and access to your data as our core principles.","href":"/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Setting up","slug":"setting-up","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"theauthapi","siteName":"The Auth API Docs","title":"What is The Auth API? - The Auth API Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T02:42:33.000Z","originalFileLocation":"introduction.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"The Auth API provides scalable API key management, team access and environment controls, plus mission-critical monitoring analytics. It’s built with speed, security and access to your data as our core principles.\">\u003cmeta data-mint-head name=\"application-name\" content=\"The Auth API Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/theauthapi/8ga9K2-WuRpuP8hv/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/theauthapi/8ga9K2-WuRpuP8hv/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/theauthapi/8ga9K2-WuRpuP8hv/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/theauthapi/8ga9K2-WuRpuP8hv/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/theauthapi/8ga9K2-WuRpuP8hv/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/theauthapi/8ga9K2-WuRpuP8hv/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/theauthapi/8ga9K2-WuRpuP8hv/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/theauthapi/8ga9K2-WuRpuP8hv/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/theauthapi/8ga9K2-WuRpuP8hv/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"What is The Auth API? - The Auth API Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"The Auth API provides scalable API key management, team access and environment controls, plus mission-critical monitoring analytics. It’s built with speed, security and access to your data as our core principles.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"The Auth API Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.theauthapi.com/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://theauthapi.mintlify.app/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=What+is+The+Auth+API%3F\u0026amp;description=The+Auth+API+provides+scalable+API+key+management%2C+team+access+and+environment+controls%2C+plus+mission-critical+monitoring+analytics.+It%E2%80%99s+built+with+speed%2C+secu\u0026amp;theme=4cbfabde700b860f1caabce5\u0026amp;signature=0e7e1c372d887db3b115911add7f06424a394e82d6343621037ad3e18a96beca\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"What is The Auth API? - The Auth API Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The Auth API provides scalable API key management, team access and environment controls, plus mission-critical monitoring analytics. It’s built with speed, security and access to your data as our core principles.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://theauthapi.mintlify.app/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=What+is+The+Auth+API%3F\u0026amp;description=The+Auth+API+provides+scalable+API+key+management%2C+team+access+and+environment+controls%2C+plus+mission-critical+monitoring+analytics.+It%E2%80%99s+built+with+speed%2C+secu\u0026amp;theme=4cbfabde700b860f1caabce5\u0026amp;signature=0e7e1c372d887db3b115911add7f06424a394e82d6343621037ad3e18a96beca\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/theauthapi/8ga9K2-WuRpuP8hv/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"The Auth API Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0D9373\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.theauthapi.com/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.theauthapi.com/#organization\",\"name\":\"The Auth API Docs\",\"url\":\"https://docs.theauthapi.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/theauthapi/ZRgpOpH3aPERXOqS/logo/light.svg?fit=max\u0026auto=format\u0026n=ZRgpOpH3aPERXOqS\u0026q=85\u0026s=2666a4c31f9d5fd792622d3e7e2178ec\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.theauthapi.com#website\",\"name\":\"The Auth API Docs\",\"url\":\"https://docs.theauthapi.com\",\"publisher\":{\"@id\":\"https://docs.theauthapi.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.theauthapi.com/introduction#webpage\",\"url\":\"https://docs.theauthapi.com/introduction\",\"name\":\"What is The Auth API?\",\"description\":\"The Auth API provides scalable API key management, team access and environment controls, plus mission-critical monitoring analytics. It’s built with speed, security and access to your data as our core principles.\",\"dateModified\":\"2026-01-07T02:42:33.000Z\",\"isPartOf\":{\"@id\":\"https://docs.theauthapi.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.theauthapi.com/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.theauthapi.com/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Get Started\",\"item\":\"https://docs.theauthapi.com/quickstart\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"What is The Auth API?\",\"item\":\"https://docs.theauthapi.com/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.theauthapi.com/introduction#article\",\"headline\":\"What is The Auth API?\",\"name\":\"What is The Auth API?\",\"description\":\"The Auth API provides scalable API key management, team access and environment controls, plus mission-critical monitoring analytics. It’s built with speed, security and access to your data as our core principles.\",\"url\":\"https://docs.theauthapi.com/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.theauthapi.com/introduction#webpage\"},\"dateModified\":\"2026-01-07T02:42:33.000Z\",\"publisher\":{\"@id\":\"https://docs.theauthapi.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.theauthapi.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"The Auth API Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"The Auth API Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","anchors":[{"anchor":"Documentation","icon":"book-open-cover","groups":[{"group":"Get Started","pages":[{"title":"Start here 👉","description":"Add API key authentication, logging and events to your API in minutes.","href":"/quickstart"},{"title":"What is The Auth API?","href":"/introduction"},{"group":"Examples","pages":[{"title":"Building a middlware","description":"How to create your first middlware","icon":"hand","href":"/guides/node-middlware-demo"}]},{"group":"Guides","pages":[{"title":"Authenticating a key","icon":"key","href":"/guides/authenticating-a-key"},{"title":"Rate limiting","icon":"clock","href":"/guides/rate-limiting"},{"title":"Automatically expiring a key","icon":"clock","href":"/guides/adding-an-expiry-date"},{"title":"API Projects","icon":"folder","href":"/guides/projects"},{"title":"Listening for Events","icon":"webhook","href":"/guides/events"}]},{"group":"Security","pages":[{"title":"Access Tokens","href":"/security/access-tokens"}]}]}]},{"anchor":"Community","href":"https://discord.gg/KGZEUq5Wm6","icon":"discord"},{"anchor":"Blog Articles","href":"https://theauthapi.com/articles","icon":"newspaper"},{"anchor":"Postman Collection","href":"https://www.postman.com/thatapicompany/workspace/thatapicompany-public-documentation/collection/5578104-3992b420-6940-4377-bf56-599348c6cd01","icon":"rocket"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"tab":"Libraries","pages":[{"title":"Libraries","href":"/libraries/npm-package"}]}]},"title":"What is The Auth API? - The Auth API Docs","buildId":"dpl_5UDDZ9hnigTkoV7QtvQ39eUp84nu","deploymentId":"dpl_5UDDZ9hnigTkoV7QtvQ39eUp84nu","dynamics":[],"chunks":[]}