# Hanko

## Docs

- [Get a list of audit logs](https://docs.hanko.io/api-reference/admin/audit-logs/get-a-list-of-audit-logs.md)
- [Create an email for a user](https://docs.hanko.io/api-reference/admin/email-management/create-an-email-for-a-user.md)
- [Get an email of a user](https://docs.hanko.io/api-reference/admin/email-management/get-a-email-by-id.md)
- [Get a list of emails for a user](https://docs.hanko.io/api-reference/admin/email-management/get-a-list-of-emails.md)
- [Remove an email from a user](https://docs.hanko.io/api-reference/admin/email-management/remove-a-email-by-id.md)
- [Set email as primary](https://docs.hanko.io/api-reference/admin/email-management/set-an-email-as-primary.md)
- [Get Prometheus metrics.](https://docs.hanko.io/api-reference/admin/metrics/get-prometheus-metrics.md)
- [Delete the OTP secret from a user](https://docs.hanko.io/api-reference/admin/otp-management/delete-otp.md)
- [Get the OTP secret metadata of a user](https://docs.hanko.io/api-reference/admin/otp-management/get-otp.md)
- [Create a password for a user](https://docs.hanko.io/api-reference/admin/password-management/create-password.md)
- [Delete the password of a user](https://docs.hanko.io/api-reference/admin/password-management/delete-password.md)
- [Get password metadata of a user](https://docs.hanko.io/api-reference/admin/password-management/get-password.md)
- [Update the password for a user](https://docs.hanko.io/api-reference/admin/password-management/update-password.md)
- [Create a new session token for a user](https://docs.hanko.io/api-reference/admin/session-management/create-session.md)
- [Delete a session from a user](https://docs.hanko.io/api-reference/admin/session-management/delete-session.md)
- [Get users active sessions](https://docs.hanko.io/api-reference/admin/session-management/list-sessions.md)
- [Status page](https://docs.hanko.io/api-reference/admin/status/status-page.md): Return information about the API status. Returns a 500 if there are issues with database connectivity.
- [Create a new user](https://docs.hanko.io/api-reference/admin/user-management/create-a-new-user.md)
- [Delete a user by ID](https://docs.hanko.io/api-reference/admin/user-management/delete-a-user-by-id.md)
- [Get a list of users](https://docs.hanko.io/api-reference/admin/user-management/get-a-list-of-users.md)
- [Get a user by ID](https://docs.hanko.io/api-reference/admin/user-management/get-a-user-by-id.md)
- [Update a user by ID](https://docs.hanko.io/api-reference/admin/user-management/update-a-user-by-id.md): Updates a subset of user-level attributes.
- [Get metadata of a user](https://docs.hanko.io/api-reference/admin/user-metadata-management/get-metadata-of-a-user.md)
- [Patch metadata of a user](https://docs.hanko.io/api-reference/admin/user-metadata-management/patch-metadata-of-a-user.md): Patch metadata of a user
- [Delete a WebAuthn credential from a user](https://docs.hanko.io/api-reference/admin/webauthn-credential-management/delete-webauthn-credential.md)
- [Get a WebAuthn credential of a user](https://docs.hanko.io/api-reference/admin/webauthn-credential-management/get-webauthn-credential.md)
- [Get a list of all WebAuthn credentials for a user](https://docs.hanko.io/api-reference/admin/webauthn-credential-management/list-webauthn-credentials.md)
- [Create a new database webhook](https://docs.hanko.io/api-reference/admin/webhooks/create-a-webhook.md)
- [Delete a webhook by ID](https://docs.hanko.io/api-reference/admin/webhooks/delete-a-webhook.md)
- [Get a list of webhooks](https://docs.hanko.io/api-reference/admin/webhooks/get-a-list-of-webhooks.md): Returns a list of all configured webhooks.
- [Get a webhook by ID](https://docs.hanko.io/api-reference/admin/webhooks/get-a-webhook-by-id.md)
- [Update a webhook by ID](https://docs.hanko.io/api-reference/admin/webhooks/update-a-webhook.md)
- [Login](https://docs.hanko.io/api-reference/flow/login.md): Initialize or advance a login flow.
- [Profile](https://docs.hanko.io/api-reference/flow/profile.md): Initialize or advance a profile flow.
- [Registration](https://docs.hanko.io/api-reference/flow/registration.md): Initialize or advance a registration flow.
- [Token exchange](https://docs.hanko.io/api-reference/flow/token-exchange.md): Initialize or advance a token exchange flow.
- [Add a new email address to the current user.](https://docs.hanko.io/api-reference/public/email-management/add-a-new-email-address-to-the-current-user.md)
- [Delete an email address](https://docs.hanko.io/api-reference/public/email-management/delete-an-email-address.md)
- [Get a list of emails of the current user.](https://docs.hanko.io/api-reference/public/email-management/get-a-list-of-emails-of-the-current-user.md)
- [Marks the email address as primary email](https://docs.hanko.io/api-reference/public/email-management/marks-the-email-address-as-primary-email.md)
- [Finalize passcode login](https://docs.hanko.io/api-reference/public/passcode/finalize-passcode-login.md): Finalize a passcode login.
- [Initialize passcode login](https://docs.hanko.io/api-reference/public/passcode/initialize-passcode-login.md): Initialize a passcode login.
- [Create/Set a password](https://docs.hanko.io/api-reference/public/password/createset-a-password.md): Create a or update an existing password for a user.
- [Do password login](https://docs.hanko.io/api-reference/public/password/do-password-login.md): Perform a password login.
- [Get a SAML provider](https://docs.hanko.io/api-reference/public/saml/get-a-saml-provider.md): Get a SAML service provider config for a provided domain.
- [Get SAML Metadata](https://docs.hanko.io/api-reference/public/saml/get-saml-metadata.md): Download SAML service provider metadata or public certificate.
- [SAML identity provider callback](https://docs.hanko.io/api-reference/public/saml/saml-identity-provider-callback.md): Callback endpoint called by the identity provider after successful login.
- [Validate a session](https://docs.hanko.io/api-reference/public/session-management/validate-a-session.md): Validate a session using a cookie header or an authorization header.
- [Validate a session](https://docs.hanko.io/api-reference/public/session-management/validate-a-session-1.md): Validate a session using a session token in a request body.
- [Status page](https://docs.hanko.io/api-reference/public/status/status-page.md): Return information about the API status. Returns a 500 if there are issues with database connectivity.
- [Initialize third party login](https://docs.hanko.io/api-reference/public/third-party/initialize-third-party-login.md): Initialize an OAuth-backed (authorization code grant type) login with a third party provider by redirecting to the specified provider login URL to retrieve an authorization code.
- [Third party provider callback](https://docs.hanko.io/api-reference/public/third-party/third-party-provider-callback.md): Callback endpoint called by the third party provider after successful login.
- [Exchange one time token for session](https://docs.hanko.io/api-reference/public/token/exchange-one-time-token-for-session.md): Provide a one time token (e.g. obtained through the [thirdparty callback](#tag/Third-Party/operation/thirdPartyCallback)) to retrieve a session JWT as cookie and/or via `X-Auth-Token` header.
- [Create a user](https://docs.hanko.io/api-reference/public/user-management/create-a-user.md): Used to create a new user. To disable this endpoint, `config.account.allow_signup` must be set to false.
- [Deletes the current user](https://docs.hanko.io/api-reference/public/user-management/deletes-the-current-user.md): Used to delete the current user. Note that `config.account.allow_deletion` must be set to true.
- [Get a user by ID](https://docs.hanko.io/api-reference/public/user-management/get-a-user-by-id.md)
- [Get the current user](https://docs.hanko.io/api-reference/public/user-management/get-the-current-user-id.md): Retrieve data for the current user (i.e. the subject of the JWT given in a cookie or as a bearer token).
- [Get user details by email](https://docs.hanko.io/api-reference/public/user-management/get-user-details-by-email.md): Retrieve details for user corresponding to the given `email`.
- [Log out the current user](https://docs.hanko.io/api-reference/public/user-management/log-out-the-current-user.md): Logs out the user by removing the authorization cookie.
- [Deletes a WebAuthn credential](https://docs.hanko.io/api-reference/public/webauthn/deletes-a-webauthn-credential.md): Deletes the specified WebAuthn credential.
- [Finalize WebAuthn login](https://docs.hanko.io/api-reference/public/webauthn/finalize-webauthn-login.md): Finalize a login with Webauthn.
- [Finalize WebAuthn registration](https://docs.hanko.io/api-reference/public/webauthn/finalize-webauthn-registration.md): Finalize a registration with Webauthn.
- [Get a list of WebAuthn credentials](https://docs.hanko.io/api-reference/public/webauthn/get-a-list-of-webauthn-credentials.md): Returns a list of WebAuthn credentials assigned to the current user.
- [Initialize WebAuthn login](https://docs.hanko.io/api-reference/public/webauthn/initialize-webauthn-login.md): Initialize a login with Webauthn.
- [Initialize WebAuthn registration](https://docs.hanko.io/api-reference/public/webauthn/initialize-webauthn-registration.md): Initialize a registration with Webauthn.
- [Updates a WebAuthn credential](https://docs.hanko.io/api-reference/public/webauthn/updates-a-webauthn-credential.md): Updates the specified WebAuthn credential. Only credentials assigned to the current user can be updated.
- [Get JSON Web Key Set](https://docs.hanko.io/api-reference/public/well-known/get-json-web-key-set.md): Retrieve a [JSON Web Key Set](https://www.rfc-editor.org/rfc/rfc7517#section-5) (JWKS) object containing the public `keys` used to verify JSON Web Tokens (JWT) issued by the Hanko API and signed using the RS256 signing algorithm.
- [Get public Hanko configuration](https://docs.hanko.io/api-reference/public/well-known/get-public-hanko-configuration.md): Retrieve public backend configuration options.
- [FAQ](https://docs.hanko.io/community-support/faq.md): A collection of common questions that we hear from Hanko users.
- [Get help](https://docs.hanko.io/community-support/get-help.md): Reach out to us with your questions, we're happy to help.
- [Troubleshoot](https://docs.hanko.io/community-support/troubleshoot.md): A guide to help you with common issues faced when working with Hanko.
- [Custom domain](https://docs.hanko.io/guides/custom-domain/custom-domain.md): Configure a custom domain for your Hanko Cloud project to improve compatibility and your users' experience.
- [Send Hanko emails using your own SMTP server](https://docs.hanko.io/guides/email-delivery/custom-smtp-server.md): Learn how to set up a custom SMTP server to send Hanko emails through your own SMTP server.
- [How to customize Hanko's emails](https://docs.hanko.io/guides/email-delivery/email-delivery.md): Send Hanko emails with your own text and style.
- [Set up SAML SSO with Auth0](https://docs.hanko.io/guides/enterprise-sso/auth0.md): Learn how to set up enterprise connections in Hanko for customers using Auth0 as SAML identity provider.
- [Set up SAML SSO with Microsoft Entra](https://docs.hanko.io/guides/enterprise-sso/entra.md): Learn how to set up enterprise connections in Hanko for customers using Microsoft Entra as SAML identity provider.
- [Set up SAML SSO with Google Workspace](https://docs.hanko.io/guides/enterprise-sso/google.md): Learn how to set up enterprise connections in Hanko for customers using Google Workspace as SAML identity provider.
- [Using SAML SSO with Hanko](https://docs.hanko.io/guides/enterprise-sso/introduction.md): Learn how SAML SSO enterprise connections work with Hanko.
- [Set up SAML SSO with Okta](https://docs.hanko.io/guides/enterprise-sso/okta.md): Learn how to set up enterprise connections in Hanko for customers using Okta as SAML identity provider.
- [Hanko Elements Auth component guide](https://docs.hanko.io/guides/hanko-elements/auth-component.md): A Web Component that handles user login and user registration.
- [Customize appearance of Hanko Elements](https://docs.hanko.io/guides/hanko-elements/customize-appearance.md): This guide will walk you through the UI customization of Hanko Elements components.
- [Events component guide](https://docs.hanko.io/guides/hanko-elements/events-component.md): A Web Component that allows to bind event handlers to certain events, without displaying UI elements.
- [Hanko Elements guide](https://docs.hanko.io/guides/hanko-elements/introduction.md): Hanko Elements are Web Components that can be used to quickly add registration, login, and profile settings functionality to web apps.
- [Hanko Elements Login component guide](https://docs.hanko.io/guides/hanko-elements/login-component.md): A Web Component that handles user login.
- [Hanko Elements Profile component](https://docs.hanko.io/guides/hanko-elements/profile-component.md): A Web Component that allows users to manage their account and security settings.
- [Hanko Elements Registration component](https://docs.hanko.io/guides/hanko-elements/register-component.md): A Web Component that handles user registration.
- [Hanko Elements internationalization (i18n) guide](https://docs.hanko.io/guides/hanko-elements/translations.md): Hanko Elements support multiple languages and translations can be modified to alter headlines, labels, descriptions and all other texts displayed in Hanko Elements.
- [Using the Hanko Frontend SDK](https://docs.hanko.io/guides/hanko-elements/using-frontend-sdk.md): The following examples will cover some common use-cases for the `hanko-frontend-sdk` instance returned by the `register()` function, but please take a look into the [frontend-sdk docs](https://teamhanko.github.io/hanko/jsdoc/hanko-frontend-sdk/) for details.
- [Import and export users](https://docs.hanko.io/guides/import-export-users.md): Learn how to import users from other platforms to Hanko, as well as how to export users from Hanko.
- [Migration Guide](https://docs.hanko.io/guides/migrations/2.x.x-to-3.x.x.md): Migration guide for upgrading from Hanko 2.x.x to 3.0.0
- [Sessions and tokens in Hanko](https://docs.hanko.io/guides/session-management.md): Learn how to manage Hanko authentication sessions, configure duration, validate tokens, limit concurrent sessions, customize JWT tokens, and handle revocation.
- [Sign in with Apple](https://docs.hanko.io/guides/social-sso/apple.md): Step-by-step guide to integrating Sign in with Apple using Hanko. Enable secure authentication and seamless onboarding for your app's users.
- [Sign in with Discord](https://docs.hanko.io/guides/social-sso/discord.md): Step-by-step guide to integrating Sign in with Discord using Hanko. Enable secure authentication and seamless onboarding for your app's users.
- [Sign in with Facebook](https://docs.hanko.io/guides/social-sso/facebook.md): Step-by-step guide to integrating Sign in with Facebook using Hanko. Enable secure authentication and seamless onboarding for your app's users.
- [Sign in with GitHub](https://docs.hanko.io/guides/social-sso/github.md): Step-by-step guide to integrating Sign in with GitHub using Hanko. Enable secure authentication and seamless onboarding for your app's users.
- [Sign in with Google](https://docs.hanko.io/guides/social-sso/google.md): Step-by-step guide to integrating Sign in with Google using Hanko. Enable secure authentication and seamless onboarding for your app's users.
- [Sign in with LinkedIn](https://docs.hanko.io/guides/social-sso/linkedin.md): Step-by-step guide to integrating Sign in with LinkedIn using Hanko. Enable secure authentication and seamless onboarding for your app's users.
- [Sign in with Microsoft](https://docs.hanko.io/guides/social-sso/microsoft.md): Step-by-step guide to integrating Sign in with Microsoft using Hanko. Enable secure authentication and seamless onboarding for your app's users.
- [Access user data from your backend](https://docs.hanko.io/guides/user-data/backend.md): Learn how to access Hanko user data in your backend code.
- [Access user data from your frontend](https://docs.hanko.io/guides/user-data/frontend.md): Learn how to access Hanko user data in your frontend code.
- [User metadata](https://docs.hanko.io/guides/user-data/user-metadata.md): Store custom JSON data on user profiles with private, public, or unsafe visibility. Learn how to manage it via APIs and include it in session JWTs.
- [Using Hanko webhooks](https://docs.hanko.io/guides/webhooks.md): Discover how to implement Hanko webhooks to receive real-time authentication event notifications. Learn to create, manage, and respond to user-related triggers.
- [Using Hanko with Permit.io](https://docs.hanko.io/integrations/permit.md): This guide will show you how to add an easily manageable authorization layer on top of your Hanko implementation, providing you with a simple way to determine what users can access within the application after logging in.
- [Using Hanko with Supabase](https://docs.hanko.io/integrations/supabase.md): This guide showcases how to add new user info, like user ID and email to the Supabase database, when users sign up with Hanko. Jump to [Nextjs guide](/quickstarts/fullstack/next) to learn how to add Hanko Auth in your Next App.
- [Welcome to the Hanko documentation](https://docs.hanko.io/introduction.md): Learn how to integrate Hanko to securely and seamlessly onboard and authenticate your users.
- [Client-first login flow](https://docs.hanko.io/passkey-api/client-first-login-flow.md): Learn how to start the login flow from your frontend.
- [Example implementation](https://docs.hanko.io/passkey-api/example-implementation.md): Learn how to utilize the Passkey API using raw HTTP requests without any SDK.
- [Example payment transaction](https://docs.hanko.io/passkey-api/example-transaction.md): Learn how to use passkeys to secure a payment transaction.
- [Introduction to Passkey API](https://docs.hanko.io/passkey-api/introduction.md): Add passkey support to your existing auth system with Hanko Passkey API.
- [JavaScript/TypeScript SDK](https://docs.hanko.io/passkey-api/js-sdk.md): A lean, type-safe, `fetch`-based API client for the Hanko Passkey API
- [Passkey MFA](https://docs.hanko.io/passkey-api/mfa.md): Learn how to implement multi-factor authentication (MFA) with Passkey using Passkey SDK.
- [Next.js with NextAuth (now known as Auth.js)](https://docs.hanko.io/passkey-api/next-auth.md): Learn how to add passkeys to your Next.js app which already uses Auth.js for authentication.
- [Finish MFA Login](https://docs.hanko.io/passkey-api/reference/credentials/finish-mfa-login.md): Finalize the login operation
- [Finish MFA Registration](https://docs.hanko.io/passkey-api/reference/credentials/finish-mfa-registration.md): Finish credential registration process
- [Finish Passkey Registration](https://docs.hanko.io/passkey-api/reference/credentials/finish-passkey-registration.md): Finish credential registration process
- [List Credentials](https://docs.hanko.io/passkey-api/reference/credentials/list-credentials.md): Get a list of webauthn credentials
- [Start MFA Login](https://docs.hanko.io/passkey-api/reference/credentials/start-mfa-login.md): Initialize a login flow for MFA
- [Start MFA Registration](https://docs.hanko.io/passkey-api/reference/credentials/start-mfa-registration.md): Initialize a registration for mfa credentials
- [Start Passkey Registration](https://docs.hanko.io/passkey-api/reference/credentials/start-passkey-registration.md): Initialize a registration for webauthn credentials
- [Update Credential](https://docs.hanko.io/passkey-api/reference/credentials/update-credential.md): Endpoint for updating a webauthn credential
- [Well-known JWKS](https://docs.hanko.io/passkey-api/reference/credentials/well-known-jwks.md): Endpoint for fetching JWKS
- [Finalize transaction](https://docs.hanko.io/passkey-api/reference/finalize-transaction.md): Finalize a transaction
- [Finish Login](https://docs.hanko.io/passkey-api/reference/finish-login.md): Finalize the login operation
- [Initialize a transaction](https://docs.hanko.io/passkey-api/reference/initialize-a-transaction.md): Initializes a new transaction for an existing user
- [List audit log entries](https://docs.hanko.io/passkey-api/reference/list-audit-logs.md): Get a list of audit logs
- [Remove Credential](https://docs.hanko.io/passkey-api/reference/remove-credential.md): Endpoint for removing a webauthn credential
- [Start Login](https://docs.hanko.io/passkey-api/reference/start-login.md): Initialize a login flow for passkeys
- [Examples](https://docs.hanko.io/passkey-api/resources/examples.md): Example apps showcasing integration of Hanko Passkey API with your favorite frameworks
- [Tutorials](https://docs.hanko.io/passkey-api/resources/tutorials.md): End to end tutorials showcasing integration of Hanko Passkey API with different frameworks and libraries.
- [Setting up a Passkey API project on Hanko Cloud](https://docs.hanko.io/passkey-api/setup-passkey-project.md): This guide will walk you through the initial set up process of a Passkey API project on Hanko Cloud.
- [Integrate Hanko with a Go backend](https://docs.hanko.io/quickstarts/backend/go.md): Learn how to validate Hanko session tokens in your Go backend to secure API endpoints and authenticate users.
- [Integrate Hanko with a Java/Spring backend](https://docs.hanko.io/quickstarts/backend/java_spring.md): Learn how to validate Hanko session tokens in your Java/Spring backend to secure API endpoints and authenticate users.
- [Integrate Hanko with a JavaScript backend](https://docs.hanko.io/quickstarts/backend/javascript.md): Learn how to validate Hanko session tokens in your JavaScript/Node.js backend to authenticate API requests.
- [Integrate Hanko with a Python backend](https://docs.hanko.io/quickstarts/backend/python.md)
- [Integrate Hanko with a Rust backend](https://docs.hanko.io/quickstarts/backend/rust.md)
- [Integrate Hanko with Angular](https://docs.hanko.io/quickstarts/frontend/angular.md): Learn how to quickly add authentication and user profile in your Angular app using Hanko.
- [Integrate Hanko with JavaScript](https://docs.hanko.io/quickstarts/frontend/javascript.md): Learn how to quickly add authentication and user profile in your vanilla Javascript app using Hanko.
- [Integrate Hanko with React](https://docs.hanko.io/quickstarts/frontend/react.md): Learn how to quickly add authentication and user profile in your React app using Hanko.
- [Integrate Hanko with Solid](https://docs.hanko.io/quickstarts/frontend/solid.md): Learn how to quickly add authentication and user profile in your Solid app using Hanko.
- [Integrate Hanko with Svelte](https://docs.hanko.io/quickstarts/frontend/svelte.md): Learn how to quickly add authentication and user profile in your Svelte app using Hanko.
- [Integrate Hanko with Vue](https://docs.hanko.io/quickstarts/frontend/vue.md): Learn how to quickly add authentication and user profile in your Vue app using Hanko.
- [Integrate Hanko with Next.js](https://docs.hanko.io/quickstarts/fullstack/next.md): Learn how to quickly add authentication and a user profile to your Next.js app using Hanko.
- [Integrate Hanko with Nuxt](https://docs.hanko.io/quickstarts/fullstack/nuxt.md): Learn how to quickly add authentication and user profile in your Nuxt app using Hanko.
- [Integrate Hanko with Remix](https://docs.hanko.io/quickstarts/fullstack/remix.md): Learn how to quickly add authentication and user profile in your Remix app using Hanko.
- [Integrate Hanko with SvelteKit](https://docs.hanko.io/quickstarts/fullstack/sveltekit.md): Learn how to quickly add authentication and user profile in your SvelteKit app using Hanko.
- [Hanko quickstart guides](https://docs.hanko.io/quickstarts/overview.md): Select your framework or programming language below to open the quickstart guide for it.
- [Examples](https://docs.hanko.io/resources/examples.md): Example apps showcasing integration of Hanko with your favorite frameworks
- [Frontend SDK](https://docs.hanko.io/resources/frontend-sdk.md)
- [Getting started with Hanko Cloud](https://docs.hanko.io/setup-hanko-cloud.md): This guide walks you through setting up your Hanko Cloud project and obtaining your API key to integrate Hanko into your app.
- [Build a custom login page](https://docs.hanko.io/using-the-api/build-a-custom-login-page.md): A step-by-step guide to create a custom login page using the Hanko FlowAPI and Hanko Frontend SDK.
- [Understanding the Hanko Flow API](https://docs.hanko.io/using-the-api/understanding-the-flow-api.md): Understand how Hanko's Flow API streamlines your authentication frontend code by shifting state-driven flow logic to the backend. Learn how to initialize and interact with flows, manage validation and technical errors, and tailor flow configurations to fit your application's needs.

## OpenAPI Specs

- [openapi-public](https://docs.hanko.io/openapi-public.yaml)
- [openapi-admin](https://docs.hanko.io/openapi-admin.yaml)
- [openapi-flow](https://docs.hanko.io/openapi-flow.yaml)
- [openapi-passkeys](https://docs.hanko.io/openapi-passkeys.yaml)