{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Hanko","description":"Documentation for Hanko’s open-source authentication products. Build secure authentication with passkeys, passwords, MFA, social login, SSO, and push authentication.","colors":{"primary":"#6575FF","light":"#6575FF","dark":"#0D001D"},"logo":{"light":"https://mintcdn.com/hanko/cvvCniGfSDqJRest/logo/light.svg?fit=max\u0026auto=format\u0026n=cvvCniGfSDqJRest\u0026q=85\u0026s=c11abcf43f80ac4a882d948d9a697da6","dark":"https://mintcdn.com/hanko/cvvCniGfSDqJRest/logo/dark.svg?fit=max\u0026auto=format\u0026n=cvvCniGfSDqJRest\u0026q=85\u0026s=2cbd45a5f965459329fa577fe505b871"},"favicon":"https://mintcdn.com/hanko/nDll7gWf2olRVk-k/favicon.png?fit=max\u0026auto=format\u0026n=nDll7gWf2olRVk-k\u0026q=85\u0026s=0220747b414c9c1af17f71869d87269a","api":{"playground":{"display":"interactive"}},"background":{"image":"https://mintcdn.com/hanko/nDll7gWf2olRVk-k/images/background.png?fit=max\u0026auto=format\u0026n=nDll7gWf2olRVk-k\u0026q=85\u0026s=cb6d5948c52e06bab12e957123881b4b","decoration":"gradient","color":{"dark":"#000000"}},"navbar":{"links":[{"href":"https://discord.gg/tAG6RrRqJD","label":"Discord"}],"primary":{"type":"button","label":"Hanko Cloud Console","href":"https://cloud.hanko.io"}},"footer":{"socials":{"x":"https://x.com/hanko_io","github":"https://github.com/teamhanko","linkedin":"https://www.linkedin.com/company/teamhanko"}},"fonts":{"family":"Geist"},"icons":{"library":"fontawesome"},"integrations":{"plausible":{"domain":"docs.hanko.io"}},"errors":{"404":{"redirect":false}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"thumbnails":{"fonts":{"family":"Geist"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hanko","hasAudioNarration":false,"actualSubdomain":"hanko","customDomains":["docs.hanko.io"],"gitSource":{"type":"github","owner":"teamhanko","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ac90617d69ee959eee80e2f","collectionId":"569f6772-f112-4e8d-8421-26b3fe30fd2e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ac90617d69ee959eee80e2f"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{},"buildId":"6ac90617d69ee959eee80e2f","clientVersion":"0.0.3894","searchFilterCounts":[{"language":"default","tag":"Hanko Docs","count":126},{"language":"default","tag":"Resources","count":67},{"language":"default","tag":"API reference","count":63},{"language":"default","tag":"Admin","count":49},{"language":"default","tag":"Guides","count":41},{"language":"default","tag":"Hanko Authenticator Docs","count":28},{"language":"default","tag":"Getting started","count":27},{"language":"default","tag":"Quickstarts","count":26},{"language":"default","tag":"Passkey API Docs","count":24},{"language":"default","tag":"API Reference","count":22}]},"assistantConfig":{"deflection":{"enabled":true,"email":"support@hanko.io"}},"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":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","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":"teamspace","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":"vite-origin","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":"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":"revalidation-jwt","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":"client-snapshot-docs-config","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}],"privacy":{"consentBanner":{"enabled":true}},"isAtlas":false,"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/public/introduction","slug":"/api-reference/public/introduction","pageMetadata":{"sidebarTitle":"Introduction","title":"Hanko APIs","description":"OpenAPI specifications for Hanko APIs","href":"/api-reference/public/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: \"OpenAPI specifications for Hanko APIs\"\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,path:`path`,svg:`svg`,..._provideComponents(),...props.components},{Card,CardGroup}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);return _jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Public API`,href:`/api-reference/`,icon:_jsxs(_components.svg,{xmlns:`http://www.w3.org/2000/svg`,className:`icon icon-tabler icon-tabler-api`,width:`24`,height:`24`,viewBox:`0 0 24 24`,strokeWidth:`2`,stroke:`currentColor`,fill:`none`,strokeLinecap:`round`,strokeLinejoin:`round`,children:[_jsx(_components.path,{stroke:`none`,d:`M0 0h24v24H0z`,fill:`none`}),_jsx(_components.path,{d:`M4 13h5`}),_jsx(_components.path,{d:`M12 16v-8h3a2 2 0 0 1 2 2v1a2 2 0 0 1 -2 2h-3`}),_jsx(_components.path,{d:`M20 8v8`}),_jsx(_components.path,{d:`M9 16v-5.5a2.5 2.5 0 0 0 -5 0v5.5`})]}),children:_jsx(_components.p,{children:`OpenAPI specs for Public API`})}),_jsx(Card,{title:`Admin API`,href:`/api-reference/admin/introduction`,icon:_jsxs(_components.svg,{xmlns:`http://www.w3.org/2000/svg`,className:`icon icon-tabler icon-tabler-api`,width:`24`,height:`24`,viewBox:`0 0 24 24`,strokeWidth:`2`,stroke:`currentColor`,fill:`none`,strokeLinecap:`round`,strokeLinejoin:`round`,children:[_jsx(_components.path,{stroke:`none`,d:`M0 0h24v24H0z`,fill:`none`}),_jsx(_components.path,{d:`M4 13h5`}),_jsx(_components.path,{d:`M12 16v-8h3a2 2 0 0 1 2 2v1a2 2 0 0 1 -2 2h-3`}),_jsx(_components.path,{d:`M20 8v8`}),_jsx(_components.path,{d:`M9 16v-5.5a2.5 2.5 0 0 0 -5 0v5.5`})]}),children:_jsx(_components.p,{children:`OpenAPI specs for Admin API`})})]})}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":{"sidebarTitle":"Introduction","title":"Hanko APIs","description":"OpenAPI specifications for Hanko APIs","href":"/api-reference/public/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"hanko","siteName":"Hanko","title":"Hanko APIs - Hanko","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-09T14:45:05.140Z","originalFileLocation":"api-reference/public/introduction.mdx"},"headHtml":"\u003cmeta data-mint-head name=\"description\" content=\"OpenAPI specifications for Hanko APIs\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hanko\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hanko/E70FYFIuCUxDugor/_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/hanko/E70FYFIuCUxDugor/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hanko/E70FYFIuCUxDugor/_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/hanko/E70FYFIuCUxDugor/_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/hanko/E70FYFIuCUxDugor/_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/hanko/E70FYFIuCUxDugor/_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/hanko/E70FYFIuCUxDugor/_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/hanko/E70FYFIuCUxDugor/_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/hanko/E70FYFIuCUxDugor/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Hanko APIs - Hanko\">\u003cmeta data-mint-head property=\"og:description\" content=\"OpenAPI specifications for Hanko APIs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hanko\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hanko.io/api-reference/public/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Hanko APIs - Hanko\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"OpenAPI specifications for Hanko APIs\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/hanko/E70FYFIuCUxDugor/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hanko\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6575FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hanko.io/api-reference/public/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/public/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hanko\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Hanko","nav":{"global":null,"tabs":[{"tab":"Hanko Docs","groups":[{"group":"Getting started","pages":[{"title":"Welcome to the Hanko documentation","sidebarTitle":"Introduction","icon":"hand-wave","mode":"wide","href":"/introduction"},{"sidebarTitle":"Set up Hanko Cloud","title":"Getting started with Hanko Cloud","icon":"play","href":"/setup-hanko-cloud"},{"group":"Quickstarts","icon":"rocket","pages":[{"title":"Hanko quickstart guides","sidebarTitle":"Overview","href":"/quickstarts/overview"},{"group":"Full Stack","pages":[{"sidebarTitle":"Next.js","title":"Integrate Hanko with Next.js","href":"/quickstarts/fullstack/next"},{"sidebarTitle":"Nuxt","title":"Integrate Hanko with Nuxt","href":"/quickstarts/fullstack/nuxt"},{"sidebarTitle":"Remix","title":"Integrate Hanko with Remix","href":"/quickstarts/fullstack/remix"},{"sidebarTitle":"SvelteKit","title":"Integrate Hanko with SvelteKit","href":"/quickstarts/fullstack/sveltekit"}]},{"group":"Frontend","pages":[{"sidebarTitle":"Angular","title":"Integrate Hanko with Angular","href":"/quickstarts/frontend/angular"},{"sidebarTitle":"JavaScript","title":"Integrate Hanko with JavaScript","href":"/quickstarts/frontend/javascript"},{"sidebarTitle":"React","title":"Integrate Hanko with React","href":"/quickstarts/frontend/react"},{"sidebarTitle":"Solid","title":"Integrate Hanko with Solid","href":"/quickstarts/frontend/solid"},{"sidebarTitle":"Svelte","title":"Integrate Hanko with Svelte","href":"/quickstarts/frontend/svelte"},{"sidebarTitle":"Vue","title":"Integrate Hanko with Vue","href":"/quickstarts/frontend/vue"}]},{"group":"Backend","pages":[{"sidebarTitle":"Go","title":"Integrate Hanko with a Go backend","href":"/quickstarts/backend/go"},{"sidebarTitle":"JavaScript","title":"Integrate Hanko with a JavaScript backend","href":"/quickstarts/backend/javascript"},{"sidebarTitle":"Java (Spring)","title":"Integrate Hanko with a Java/Spring backend","href":"/quickstarts/backend/java_spring"},{"sidebarTitle":"Python","title":"Integrate Hanko with a Python backend","href":"/quickstarts/backend/python"},{"sidebarTitle":"Rust","title":"Integrate Hanko with a Rust backend","href":"/quickstarts/backend/rust"}]}]}]},{"group":"Guides","pages":[{"group":"Hanko Elements","pages":[{"title":"Hanko Elements guide","sidebarTitle":"Introduction","href":"/guides/hanko-elements/introduction"},{"sidebarTitle":"Auth component","title":"Hanko Elements Auth component guide","href":"/guides/hanko-elements/auth-component"},{"sidebarTitle":"Login component","title":"Hanko Elements Login component guide","href":"/guides/hanko-elements/login-component"},{"sidebarTitle":"Registration component","title":"Hanko Elements Registration component","href":"/guides/hanko-elements/register-component"},{"sidebarTitle":"Profile component","title":"Hanko Elements Profile component","href":"/guides/hanko-elements/profile-component"},{"sidebarTitle":"Events component","title":"Events component guide","href":"/guides/hanko-elements/events-component"},{"title":"Using the Hanko Frontend SDK","sidebarTitle":"Using Frontend SDK","href":"/guides/hanko-elements/using-frontend-sdk"},{"sidebarTitle":"Styling","title":"Customize appearance of Hanko Elements","href":"/guides/hanko-elements/customize-appearance"},{"sidebarTitle":"Internationalization (i18n)","title":"Hanko Elements internationalization (i18n) guide","href":"/guides/hanko-elements/translations"}]},{"group":"User data","pages":[{"sidebarTitle":"Access from frontend","title":"Access user data from your frontend","href":"/guides/user-data/frontend"},{"sidebarTitle":"Access from backend","title":"Access user data from your backend","href":"/guides/user-data/backend"},{"title":"User metadata","href":"/guides/user-data/user-metadata"},{"title":"Attribute mapping","href":"/guides/user-data/attribute-mapping"},{"title":"Custom claims","href":"/guides/user-data/custom-claims"}]},{"group":"Social SSO","pages":[{"sidebarTitle":"Overview","title":"Using social SSO with Hanko","href":"/guides/social-sso/introduction"},{"title":"Sign in with Apple","sidebarTitle":"Apple","href":"/guides/social-sso/apple"},{"title":"Sign in with Discord","sidebarTitle":"Discord","href":"/guides/social-sso/discord"},{"title":"Sign in with Facebook","sidebarTitle":"Facebook","href":"/guides/social-sso/facebook"},{"title":"Sign in with GitHub","sidebarTitle":"GitHub","href":"/guides/social-sso/github"},{"title":"Sign in with Google","sidebarTitle":"Google","href":"/guides/social-sso/google"},{"title":"Sign in with LinkedIn","sidebarTitle":"LinkedIn","href":"/guides/social-sso/linkedin"},{"title":"Sign in with Microsoft","sidebarTitle":"Microsoft","href":"/guides/social-sso/microsoft"},{"title":"Custom providers","href":"/guides/social-sso/custom-providers"}]},{"group":"Enterprise SSO","pages":[{"sidebarTitle":"Overview","title":"Using SAML SSO with Hanko","href":"/guides/enterprise-sso/introduction"},{"sidebarTitle":"Auth0","title":"Set up SAML SSO with Auth0","href":"/guides/enterprise-sso/auth0"},{"sidebarTitle":"Microsoft Entra","title":"Set up SAML SSO with Microsoft Entra","href":"/guides/enterprise-sso/entra"},{"sidebarTitle":"Google Workspace","title":"Set up SAML SSO with Google Workspace","href":"/guides/enterprise-sso/google"},{"sidebarTitle":"Okta","title":"Set up SAML SSO with Okta","href":"/guides/enterprise-sso/okta"}]},{"group":"Import/Export","pages":[{"title":"Import and export users","href":"/guides/import_export/import-export-users"},{"sidebarTitle":"Firebase user migration","title":"Migrate Users from Firebase","href":"/guides/import_export/firebase"}]},{"sidebarTitle":"Webhooks","title":"Using Hanko webhooks","href":"/guides/webhooks"},{"group":"Email delivery","pages":[{"sidebarTitle":"Email customization","title":"How to customize Hanko's emails","href":"/guides/email-delivery/email-delivery"},{"sidebarTitle":"Custom SMTP server","title":"Send Hanko emails using your own SMTP server","href":"/guides/email-delivery/custom-smtp-server"}]},{"sidebarTitle":"Custom domain","title":"Custom domain","href":"/guides/custom-domain/custom-domain"},{"sidebarTitle":"Sessions and tokens","title":"Sessions and tokens in Hanko","href":"/guides/session-management"},{"group":"Migrations","pages":[{"sidebarTitle":"2.x.x to 3.0.0","title":"Migration Guide","href":"/guides/migrations/2.x.x-to-3.x.x"}]}]},{"group":"Using the Hanko API","pages":[{"sidebarTitle":"Understanding the Flow API","title":"Understanding the Hanko Flow API","href":"/using-the-api/understanding-the-flow-api"},{"title":"Build a custom login page","href":"/using-the-api/build-a-custom-login-page"}]},{"group":"Integrations","pages":[{"sidebarTitle":"Supabase","title":"Using Hanko with Supabase","href":"/integrations/supabase"},{"sidebarTitle":"Authorization with Permit.io","title":"Using Hanko with Permit.io","href":"/integrations/permit"}]},{"group":"Resources","pages":[{"title":"Examples","href":"/resources/examples"},{"group":"API reference","pages":[{"group":"Public","pages":[{"group":"Flow","pages":[{"openapi":"post /registration","title":"Registration","href":"/api-reference/flow/registration"},{"openapi":"post /login","title":"Login","href":"/api-reference/flow/login"},{"openapi":"post /profile","title":"Profile","href":"/api-reference/flow/profile"},{"openapi":"post /token_exchange","title":"Token exchange","href":"/api-reference/flow/token-exchange"}]},{"group":"Status","pages":[{"openapi":"openapi-public get /","title":"Status page","href":"/api-reference/public/status/status-page"}]},{"group":".well-known","pages":[{"openapi":"openapi-public get /.well-known/jwks.json","title":"Get JSON Web Key Set","href":"/api-reference/public/well-known/get-json-web-key-set"}]},{"group":"Third Party","pages":[{"openapi":"openapi-public get /thirdparty/callback","title":"Third party provider callback","href":"/api-reference/public/third-party/third-party-provider-callback"}]},{"group":"User Management","pages":[{"openapi":"openapi-public get /me","title":"Get the current user","href":"/api-reference/public/user-management/get-the-current-user-id"},{"openapi":"openapi-public post /logout","title":"Log out the current user","href":"/api-reference/public/user-management/log-out-the-current-user"}]},{"group":"SAML","pages":[{"openapi":"get /saml/metadata","title":"Get SAML Metadata","href":"/api-reference/public/saml/get-saml-metadata"},{"openapi":"post /saml/callback","title":"SAML identity provider callback","href":"/api-reference/public/saml/saml-identity-provider-callback"}]},{"group":"Session Management","pages":[{"openapi":"get /sessions/validate","title":"Validate a session","href":"/api-reference/public/session-management/validate-a-session"},{"openapi":"post /sessions/validate","title":"Validate a session","href":"/api-reference/public/session-management/validate-a-session-1"}]},{"group":"Organization Management","pages":[{"openapi":"openapi-public post /organizations/roles/check","title":"Check current user's role","href":"/api-reference/public/organization-management/check-current-users-role"}]}]},{"group":"Admin","pages":[{"group":"Status","pages":[{"openapi":"openapi-admin get /","title":"Status page","href":"/api-reference/admin/status/status-page"}]},{"group":"User Management","pages":[{"openapi":"openapi-admin get /users","title":"Get a list of users","href":"/api-reference/admin/user-management/get-a-list-of-users"},{"openapi":"openapi-admin post /users","title":"Create a new user","href":"/api-reference/admin/user-management/create-a-new-user"},{"openapi":"openapi-admin get /users/{id}","title":"Get a user by ID","href":"/api-reference/admin/user-management/get-a-user-by-id"},{"openapi":"openapi-admin delete /users/{id}","title":"Delete a user by ID","href":"/api-reference/admin/user-management/delete-a-user-by-id"},{"openapi":"openapi-admin patch /users/{id}","title":"Update a user by ID","href":"/api-reference/admin/user-management/update-a-user-by-id"}]},{"group":"User Metadata Management","pages":[{"openapi":"get /users/{id}/metadata","title":"Get metadata of a user","href":"/api-reference/admin/user-metadata-management/get-metadata-of-a-user"},{"openapi":"patch /users/{id}/metadata","title":"Patch metadata of a user","href":"/api-reference/admin/user-metadata-management/patch-metadata-of-a-user"}]},{"group":"Custom Claims Management","pages":[{"openapi":"get /users/{id}/custom_claims","title":"Get custom claims of a user","href":"/api-reference/admin/custom-claims-management/get-custom-claims-of-a-user"}]},{"group":"Email Management","pages":[{"openapi":"openapi-admin get /users/{id}/emails","title":"Get a list of emails for a user","href":"/api-reference/admin/email-management/get-a-list-of-emails"},{"openapi":"openapi-admin post /users/{id}/emails","title":"Create an email for a user","href":"/api-reference/admin/email-management/create-an-email-for-a-user"},{"openapi":"openapi-admin get /users/{id}/emails/{email_id}","title":"Get an email of a user","href":"/api-reference/admin/email-management/get-a-email-by-id"},{"openapi":"openapi-admin delete /users/{id}/emails/{email_id}","title":"Remove an email from a user","href":"/api-reference/admin/email-management/remove-a-email-by-id"},{"openapi":"openapi-admin post /users/{id}/emails/{email_id}/set_primary","title":"Set email as primary","href":"/api-reference/admin/email-management/set-an-email-as-primary"}]},{"group":"Password Management","pages":[{"openapi":"openapi-admin post /users/{id}/password","title":"Create a password for a user","href":"/api-reference/admin/password-management/create-password"},{"openapi":"openapi-admin get /users/{id}/password","title":"Get password metadata of a user","href":"/api-reference/admin/password-management/get-password"},{"openapi":"openapi-admin put /users/{id}/password","title":"Update the password for a user","href":"/api-reference/admin/password-management/update-password"},{"openapi":"openapi-admin delete /users/{id}/password","title":"Delete the password of a user","href":"/api-reference/admin/password-management/delete-password"}]},{"group":"WebAuthn credential Management","pages":[{"openapi":"openapi-admin get /users/{id}/webauthn_credentials","title":"Get a list of all WebAuthn credentials for a user","href":"/api-reference/admin/webauthn-credential-management/list-webauthn-credentials"},{"openapi":"openapi-admin get /users/{id}/webauthn_credentials/{credential_id}","title":"Get a WebAuthn credential of a user","href":"/api-reference/admin/webauthn-credential-management/get-webauthn-credential"},{"openapi":"openapi-admin delete /users/{id}/webauthn_credentials/{credential_id}","title":"Delete a WebAuthn credential from a user","href":"/api-reference/admin/webauthn-credential-management/delete-webauthn-credential"}]},{"group":"OTP Management","pages":[{"openapi":"openapi-admin get /users/{id}/otp","title":"Get the OTP secret metadata of a user","href":"/api-reference/admin/otp-management/get-otp"},{"openapi":"openapi-admin delete /users/{id}/otp","title":"Delete the OTP secret from a user","href":"/api-reference/admin/otp-management/delete-otp"}]},{"group":"Session Management","pages":[{"openapi":"openapi-admin post /sessions","title":"Create a new session token for a user","href":"/api-reference/admin/session-management/create-session"},{"openapi":"openapi-admin get /users/{id}/sessions","title":"Get users active sessions","href":"/api-reference/admin/session-management/list-sessions"},{"openapi":"openapi-admin delete /users/{id}/sessions/{session_id}","title":"Delete a session from a user","href":"/api-reference/admin/session-management/delete-session"}]},{"group":"Webhooks","pages":[{"openapi":"openapi-admin get /webhooks","title":"Get a list of webhooks","href":"/api-reference/admin/webhooks/get-a-list-of-webhooks"},{"openapi":"openapi-admin post /webhooks","title":"Create a new database webhook","href":"/api-reference/admin/webhooks/create-a-webhook"},{"openapi":"openapi-admin get /webhooks/{id}","title":"Get a webhook by ID","href":"/api-reference/admin/webhooks/get-a-webhook-by-id"},{"openapi":"openapi-admin put /webhooks/{id}","title":"Update a webhook by ID","href":"/api-reference/admin/webhooks/update-a-webhook"},{"openapi":"openapi-admin delete /webhooks/{id}","title":"Delete a webhook by ID","href":"/api-reference/admin/webhooks/delete-a-webhook"}]},{"group":"Audit Logs","pages":[{"openapi":"openapi-admin get /audit_logs","title":"Get a list of audit logs","href":"/api-reference/admin/audit-logs/get-a-list-of-audit-logs"}]},{"group":"Metrics","pages":[{"openapi":"openapi-admin get /metrics","title":"Get Prometheus metrics.","href":"/api-reference/admin/metrics/get-prometheus-metrics"}]},{"group":"Organization Management","pages":[{"openapi":"openapi-admin get /organizations","title":"Get a list of organizations","href":"/api-reference/admin/organization-management/get-a-list-of-organizations"},{"openapi":"openapi-admin post /organizations","title":"Create a new organization","href":"/api-reference/admin/organization-management/create-a-new-organization"},{"openapi":"openapi-admin get /organizations/{id}","title":"Get an organization by ID","href":"/api-reference/admin/organization-management/get-an-organization-by-id"},{"openapi":"openapi-admin patch /organizations/{id}","title":"Update an organization by ID","href":"/api-reference/admin/organization-management/update-an-organization-by-id"},{"openapi":"openapi-admin delete /organizations/{id}","title":"Delete an organization by ID","href":"/api-reference/admin/organization-management/delete-an-organization-by-id"},{"openapi":"openapi-admin get /organizations/{org_id}/users","title":"Get a list of organization members","href":"/api-reference/admin/organization-management/get-a-list-of-organization-members"},{"openapi":"openapi-admin post /organizations/{org_id}/users/{user_id}","title":"Add an organization member","href":"/api-reference/admin/organization-management/add-an-organization-member"},{"openapi":"openapi-admin delete /organizations/{org_id}/users/{user_id}","title":"Remove an organization member","href":"/api-reference/admin/organization-management/remove-an-organization-member"}]},{"group":"Role Management","pages":[{"openapi":"openapi-admin get /roles","title":"Get a list of roles","href":"/api-reference/admin/role-management/get-a-list-of-roles"},{"openapi":"openapi-admin post /roles","title":"Create a new role","href":"/api-reference/admin/role-management/create-a-new-role"},{"openapi":"openapi-admin get /roles/{id}","title":"Get a role by ID","href":"/api-reference/admin/role-management/get-a-role-by-id"},{"openapi":"openapi-admin patch /roles/{id}","title":"Update a role by ID","href":"/api-reference/admin/role-management/update-a-role-by-id"},{"openapi":"openapi-admin delete /roles/{id}","title":"Delete a role by ID","href":"/api-reference/admin/role-management/delete-a-role-by-id"},{"openapi":"openapi-admin get /organizations/{org_id}/users/{user_id}/roles","title":"Get a list of role bindings","href":"/api-reference/admin/role-management/get-a-list-of-role-bindings"},{"openapi":"openapi-admin post /organizations/{org_id}/users/{user_id}/roles","title":"Create a role binding","href":"/api-reference/admin/role-management/create-a-role-binding"},{"openapi":"openapi-admin delete /organizations/{org_id}/users/{user_id}/roles/{role_id_or_slug}","title":"Remove a role binding","href":"/api-reference/admin/role-management/remove-a-role-binding"}]}]}]},{"title":"Frontend SDK","url":"https://teamhanko.github.io/hanko/jsdoc/hanko-frontend-sdk/","href":"/resources/frontend-sdk"}]},{"group":"FAQ \u0026 support","pages":[{"title":"Get help","href":"/community-support/get-help"},{"title":"Troubleshoot","href":"/community-support/troubleshoot"},{"title":"FAQ","href":"/community-support/faq"}]}]},{"tab":"Passkey API Docs","groups":[{"group":"Getting started","pages":[{"title":"Introduction to Passkey API","sidebarTitle":"Introduction","mode":"wide","href":"/passkey-api/introduction"},{"sidebarTitle":"Set up Passkey API project","title":"Setting up a Passkey API project on Hanko Cloud","href":"/passkey-api/setup-passkey-project"},{"title":"Example implementation","href":"/passkey-api/example-implementation"},{"title":"Passkey MFA","href":"/passkey-api/mfa"},{"title":"Example payment transaction","href":"/passkey-api/example-transaction"},{"title":"Client-first login flow","href":"/passkey-api/client-first-login-flow"}]},{"group":"Integrations","pages":[{"title":"JavaScript/TypeScript SDK","href":"/passkey-api/js-sdk"}]},{"group":"Resources","pages":[{"title":"Examples","href":"/passkey-api/resources/examples"},{"title":"Tutorials","href":"/passkey-api/resources/tutorials"}]},{"group":"API Reference","pages":[{"group":"Signup","pages":[{"openapi":"openapi-passkeys post /{tenant_id}/registration/initialize","title":"Start Passkey Registration","href":"/passkey-api/reference/credentials/start-passkey-registration"},{"openapi":"openapi-passkeys post /{tenant_id}/registration/finalize","title":"Finish Passkey Registration","href":"/passkey-api/reference/credentials/finish-passkey-registration"}]},{"group":"Login","pages":[{"openapi":"openapi-passkeys post /{tenant_id}/login/initialize","title":"Start Login","href":"/passkey-api/reference/start-login"},{"openapi":"openapi-passkeys post /{tenant_id}/login/finalize","title":"Finish Login","href":"/passkey-api/reference/finish-login"}]},{"group":"Credentials","pages":[{"openapi":"openapi-passkeys get /{tenant_id}/credentials","title":"List Credentials","href":"/passkey-api/reference/credentials/list-credentials"},{"openapi":"openapi-passkeys patch /{tenant_id}/credentials/{credential_id}","title":"Update Credential","href":"/passkey-api/reference/credentials/update-credential"},{"openapi":"openapi-passkeys delete /{tenant_id}/credentials/{credential_id}","title":"Remove Credential","href":"/passkey-api/reference/remove-credential"}]},{"group":"Transactions","pages":[{"openapi":"openapi-passkeys post /{tenant_id}/transaction/initialize","title":"Initialize a transaction","href":"/passkey-api/reference/initialize-a-transaction"},{"openapi":"openapi-passkeys post /{tenant_id}/transaction/finalize","title":"Finalize transaction","href":"/passkey-api/reference/finalize-transaction"}]},{"group":"MFA","pages":[{"openapi":"openapi-passkeys post /{tenant_id}/mfa/login/initialize","title":"Start MFA Login","href":"/passkey-api/reference/credentials/start-mfa-login"},{"openapi":"openapi-passkeys post /{tenant_id}/mfa/login/finalize","title":"Finish MFA Login","href":"/passkey-api/reference/credentials/finish-mfa-login"},{"openapi":"openapi-passkeys post /{tenant_id}/mfa/registration/initialize","title":"Start MFA Registration","href":"/passkey-api/reference/credentials/start-mfa-registration"},{"openapi":"openapi-passkeys post /{tenant_id}/mfa/registration/finalize","title":"Finish MFA Registration","href":"/passkey-api/reference/credentials/finish-mfa-registration"}]},{"group":"Audit Logs","pages":[{"openapi":"openapi-passkeys get /{tenant_id}/audit_logs","title":"List audit log entries","href":"/passkey-api/reference/list-audit-logs"}]},{"openapi":"openapi-passkeys get /{tenant_id}/.well-known/jwks.json","title":"Well-known JWKS","href":"/passkey-api/reference/credentials/well-known-jwks"}]}]},{"tab":"Hanko Authenticator Docs","groups":[{"group":"Getting started","pages":[{"sidebarTitle":"Introduction","title":"Introduction to Hanko Authenticator","mode":"wide","href":"/hanko-authenticator/introduction"},{"sidebarTitle":"Core components","title":"Core components","href":"/hanko-authenticator/core-components"},{"sidebarTitle":"What is FIDO UAF?","title":"What is FIDO UAF?","href":"/hanko-authenticator/what-is-fido-uaf"}]},{"group":"Quickstarts","pages":[{"group":"Hanko Authenticator App","pages":[{"sidebarTitle":"Overview","title":"Getting started with Hanko Authenticator","href":"/hanko-authenticator/quickstart/authenticator-app"},{"sidebarTitle":"Registration","title":"Register a device using the Hanko Authenticator","href":"/hanko-authenticator/quickstart/authenticator-app-registration"},{"sidebarTitle":"Authentication","title":"Authenticate with a device using Hanko Authenticator","href":"/hanko-authenticator/quickstart/authenticator-app-authentication"},{"sidebarTitle":"Transactions","title":"Confirm transactions using Hanko Authenticator","href":"/hanko-authenticator/quickstart/authenticator-app-transactions"},{"sidebarTitle":"De-registration","title":"De-register a device","href":"/hanko-authenticator/quickstart/authenticator-app-de-registration"}]},{"group":"FIDO UAF Client SDK","pages":[{"sidebarTitle":"Overview","title":"Getting started with the Hanko FIDO UAF Client","href":"/hanko-authenticator/quickstart/uaf-client"},{"sidebarTitle":"Registration","title":"Register a device with the Hanko FIDO UAF Client","href":"/hanko-authenticator/quickstart/uaf-client-registration"},{"sidebarTitle":"Authentication","title":"Authenticate with a device using the Hanko FIDO UAF Client","href":"/hanko-authenticator/quickstart/uaf-client-authentication"},{"sidebarTitle":"Transactions","title":"Confirm transactions using the Hanko FIDO UAF Client","href":"/hanko-authenticator/quickstart/uaf-client-transactions"},{"sidebarTitle":"De-registration","title":"De-register a device using the Hanko FIDO UAF Client","href":"/hanko-authenticator/quickstart/uaf-client-de-registration"}]}]},{"group":"Guides","pages":[{"sidebarTitle":"Integration overview","title":"Integration guide","href":"/hanko-authenticator/guides/integration-overview"},{"sidebarTitle":"Registration screen","title":"Modifying your registration flow","href":"/hanko-authenticator/guides/registration-screen"},{"sidebarTitle":"Login screen","title":"Modifying your login flow","href":"/hanko-authenticator/guides/login-screen"},{"sidebarTitle":"Recovery","title":"Recovery techniques","href":"/hanko-authenticator/guides/recovery"},{"sidebarTitle":"Authenticator apps","title":"Hanko Authenticator apps","href":"/hanko-authenticator/guides/authenticator-apps"}]},{"group":"SDKs \u0026 Plugins","pages":[{"sidebarTitle":"Android","title":"FIDO UAF Client for Android","href":"/hanko-authenticator/sdks/android"},{"sidebarTitle":"iOS","title":"FIDO UAF Client for iOS","href":"/hanko-authenticator/sdks/ios"},{"sidebarTitle":"Keycloak plugin","title":"Hanko Keycloak plugin","href":"/hanko-authenticator/sdks/keycloak-plugin"}]},{"group":"API Reference","pages":[{"group":"Hanko Authenticator","pages":[{"openapi":"openapi-authenticator post /v1/uaf/requests","title":"Create a request for the Hanko Authenticator","href":"/hanko-authenticator/reference/create-a-request"},{"openapi":"openapi-authenticator get /v1/uaf/requests/{id}","title":"Get the request for the Hanko Authenticator","href":"/hanko-authenticator/reference/get-a-request"},{"openapi":"openapi-authenticator delete /v1/uaf/requests/{id}","title":"Cancel the request for the Hanko Authenticator","href":"/hanko-authenticator/reference/cancel-a-request"},{"openapi":"openapi-authenticator put /v1/uaf/requests/{id}","title":"Validate the request as retrieved from the Hanko Authenticator","href":"/hanko-authenticator/reference/validate-a-request"},{"openapi":"openapi-authenticator get /v1/uaf/requests/{id}/qrcode","title":"Get the QR code for a given Hanko Authenticator request","href":"/hanko-authenticator/reference/get-a-qr-code"}]},{"group":"Device Management","pages":[{"openapi":"openapi-authenticator get /mgmt/v1/registrations/{userId}","title":"Get all devices of a user","href":"/hanko-authenticator/reference/get-a-users-devices"},{"openapi":"openapi-authenticator post /mgmt/v1/registrations/rename/{deviceId}","title":"Change the name of a authentication device","href":"/hanko-authenticator/reference/rename-a-device"}]}]}]}]},"title":"Hanko APIs - Hanko","buildId":"dpl_8LJVMfxYNq6LJkohTrn2iyWT8umj","deploymentId":"dpl_8LJVMfxYNq6LJkohTrn2iyWT8umj","dynamics":[],"chunks":[]}
