Organizations to add the new user to, with optional roles to bind within each. Every
organization ID and role ID/slug must already exist within the tenant, or the request
fails with 400 and no user is created.
{"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.3971","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"}},"basePath":"","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":"workos-sso-scim","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":"workos-enabled","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},{"name":"workos-signup","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/admin/user-management/create-a-new-user","slug":"/api-reference/admin/user-management/create-a-new-user","pageMetadata":{"openapi":"openapi-admin post /users","title":"Create a new user","description":null,"href":"/api-reference/admin/user-management/create-a-new-user"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"openapi-admin post /users","title":"Create a new user","description":null,"href":"/api-reference/admin/user-management/create-a-new-user"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create a new user","security":["e49fcb20-0c90-4189-a278-d625e62e10be"],"operationId":"createUser","tags":["User Management"],"requestBody":"321d9637-a016-496b-82e0-f0c003cb7084","responses":{"200":"0d87d834-7013-4af2-b448-aa9b8822818f","400":"9867858f-3874-498d-a1b3-aefcd6eee230","409":"92677916-609a-4d3a-ab92-9ab9e740355d","500":"4c64eff5-177c-4df2-beda-781063615946"},"method":"post","type":"path","servers":["e081c432-ccf8-4da1-bfe3-62957c8527b9"],"path":"/users","baseUrlOptions":["https://{tenant_id}.hanko.io/admin"],"title":"Create a new user","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"emails":{"description":"The email addresses of the new user","type":"array","items":{"type":"object","properties":{"address":{"type":"string","isRequired":true,"uniqueKey":"emails.items.[INDEX].address","typeLabel":"string"},"is_primary":{"type":"boolean","isRequired":true,"uniqueKey":"emails.items.[INDEX].is_primary","typeLabel":"boolean"},"is_verified":{"type":"boolean","uniqueKey":"emails.items.[INDEX].is_verified","typeLabel":"boolean"}},"required":["address","is_primary"],"uniqueKey":"emails.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"emails","typeLabel":"object[]"},"id":{"type":"string","description":"The ID of the new user","format":"uuid4","example":"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c","uniqueKey":"id","typeLabel":"string\u003cuuid4>"},"username":{"description":"The username of the new user","type":"string","uniqueKey":"username","typeLabel":"string"},"created_at":{"description":"Time of creation of the user","type":"string","format":"date-time","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"organizations":{"description":"Organizations to add the new user to, with optional roles to bind within each. Every\norganization ID and role ID/slug must already exist within the tenant, or the request\nfails with 400 and no user is created.\n","type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the organization","format":"uuid4","example":"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c","isRequired":true,"uniqueKey":"organizations.items.[INDEX].id","typeLabel":"string\u003cuuid4>"},"roles":{"description":"IDs or slugs of roles to bind to the user within this organization","type":"array","items":{"type":"string","uniqueKey":"organizations.items.[INDEX].roles.items.[INDEX]","typeLabel":"string"},"uniqueKey":"organizations.items.[INDEX].roles","typeLabel":"string[]"}},"required":["id"],"uniqueKey":"organizations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"organizations","typeLabel":"object[]"}},"required":["emails"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"emails":[{"address":"\u003cstring>","is_primary":true,"is_verified":true}],"id":"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c","username":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","organizations":[{"id":"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c","roles":["\u003cstring>"]}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"0d87d834-7013-4af2-b448-aa9b8822818f":{"description":"Details of the newly created user","content":{"application/json":{"schema":{"type":"object","required":["id","created_at","updated_at"],"properties":{"id":{"type":"string","description":"The ID of the user","format":"uuid4","example":"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid4>"},"created_at":{"description":"Time of creation of the user","type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"description":"Time of last update of the user","type":"string","format":"date-time","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"webauthn_credentials":{"description":"List of registered Webauthn credentials","type":"array","items":{"type":"object","required":["id","public_key","attestation_type","aaguid","created_at","backup_eligible","backup_state","mfa_only"],"properties":{"id":{"type":"string","description":"The ID of the credential","format":"uuid4","example":"f9bebc04-b894-4018-bdb8-8b520a532fef","isRequired":true,"uniqueKey":"webauthn_credentials.items.[INDEX].id","typeLabel":"string\u003cuuid4>"},"public_key":{"description":"The public key of the credential","type":"string","isRequired":true,"uniqueKey":"webauthn_credentials.items.[INDEX].public_key","typeLabel":"string"},"attestation_type":{"description":"The attestation type the credential was registered with","type":"string","isRequired":true,"uniqueKey":"webauthn_credentials.items.[INDEX].attestation_type","typeLabel":"string"},"aaguid":{"description":"The AAGUID of the authenticator the credentials was created on","type":"string","isRequired":true,"uniqueKey":"webauthn_credentials.items.[INDEX].aaguid","typeLabel":"string"},"created_at":{"description":"Time of creation of the credential","type":"string","format":"date-time","isRequired":true,"uniqueKey":"webauthn_credentials.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"backup_eligible":{"description":"Indicates if the credential can be backed up","type":"boolean","isRequired":true,"uniqueKey":"webauthn_credentials.items.[INDEX].backup_eligible","typeLabel":"boolean"},"backup_state":{"description":"Indicates if the credential is backed up","type":"boolean","isRequired":true,"uniqueKey":"webauthn_credentials.items.[INDEX].backup_state","typeLabel":"boolean"},"mfa_only":{"description":"Indicates if the credential can only be used as a MFA credential","type":"boolean","isRequired":true,"uniqueKey":"webauthn_credentials.items.[INDEX].mfa_only","typeLabel":"boolean"},"name":{"description":"A name that the user choose","type":"string","uniqueKey":"webauthn_credentials.items.[INDEX].name","typeLabel":"string"},"transports":{"description":"The ways the authenticator is connected","type":"array","items":{"type":"string","uniqueKey":"webauthn_credentials.items.[INDEX].transports.items.[INDEX]","typeLabel":"string"},"uniqueKey":"webauthn_credentials.items.[INDEX].transports","typeLabel":"string[]"},"last_used_at":{"description":"The time when the credential was last used","type":"string","format":"date-time","uniqueKey":"webauthn_credentials.items.[INDEX].last_used_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"webauthn_credentials.items.[INDEX]","typeLabel":"object"},"uniqueKey":"webauthn_credentials","typeLabel":"object[]"},"emails":{"description":"List of emails associated to the user","type":"array","items":{"type":"object","required":["id","address","is_verified","is_primary","created_at","updated_at"],"properties":{"id":{"type":"string","description":"The ID of the email","format":"uuid4","example":"802df042-1ac2-496d-af81-6ace729ed055","isRequired":true,"uniqueKey":"emails.items.[INDEX].id","typeLabel":"string\u003cuuid4>"},"address":{"description":"The email address","type":"string","format":"email","isRequired":true,"uniqueKey":"emails.items.[INDEX].address","typeLabel":"string\u003cemail>"},"is_verified":{"description":"Indicated the email has been verified.","type":"boolean","isRequired":true,"uniqueKey":"emails.items.[INDEX].is_verified","typeLabel":"boolean"},"is_primary":{"description":"Indicates it's the primary email address.","type":"boolean","isRequired":true,"uniqueKey":"emails.items.[INDEX].is_primary","typeLabel":"boolean"},"created_at":{"description":"Time of creation of the email","type":"string","format":"date-time","isRequired":true,"uniqueKey":"emails.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"description":"Time of last update of the email","type":"string","format":"date-time","isRequired":true,"uniqueKey":"emails.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"emails.items.[INDEX]","typeLabel":"object"},"uniqueKey":"emails","typeLabel":"object[]"},"username":{"description":"The username of the user","type":"object","properties":{"id":{"type":"string","description":"The ID of the username","format":"uuid4","example":"8cbed467-554b-4d17-b23f-bce1b4f1db92","uniqueKey":"username.id","typeLabel":"string\u003cuuid4>"},"created_at":{"description":"Time of creation of the username","type":"string","format":"date-time","uniqueKey":"username.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"description":"Time of last update of the username","type":"string","format":"date-time","uniqueKey":"username.updated_at","typeLabel":"string\u003cdate-time>"},"username":{"description":"The username of the user","type":"string","example":"john_doe_123","uniqueKey":"username.username","typeLabel":"string"}},"uniqueKey":"username","typeLabel":"object"},"organizations":{"description":"Organizations the user belongs to, and the roles held in each. Omitted if the user belongs to no organizations.","type":"array","items":{"type":"object","required":["id","name","roles"],"properties":{"id":{"type":"string","description":"The ID of the organization","format":"uuid4","example":"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c","isRequired":true,"uniqueKey":"organizations.items.[INDEX].id","typeLabel":"string\u003cuuid4>"},"name":{"description":"Name of the organization","type":"string","isRequired":true,"uniqueKey":"organizations.items.[INDEX].name","typeLabel":"string"},"roles":{"description":"Roles the user holds within this organization","type":"array","items":{"type":"object","required":["id","slug","name"],"properties":{"id":{"type":"string","description":"The ID of the role","format":"uuid4","example":"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c","isRequired":true,"uniqueKey":"organizations.items.[INDEX].roles.items.[INDEX].id","typeLabel":"string\u003cuuid4>"},"slug":{"description":"Machine-safe, human-readable identifier for the role","type":"string","isRequired":true,"uniqueKey":"organizations.items.[INDEX].roles.items.[INDEX].slug","typeLabel":"string"},"name":{"description":"Display name of the role","type":"string","isRequired":true,"uniqueKey":"organizations.items.[INDEX].roles.items.[INDEX].name","typeLabel":"string"}},"uniqueKey":"organizations.items.[INDEX].roles.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"organizations.items.[INDEX].roles","typeLabel":"object[]"}},"uniqueKey":"organizations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"organizations","typeLabel":"object[]"},"otp":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"otp.id","typeLabel":"string\u003cuuid>"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"otp.created_at","typeLabel":"string\u003cdate-time>"}},"required":["id","created_at"],"uniqueKey":"otp","typeLabel":"object"},"password":{"description":"The password credential of a user","type":"object","properties":{"id":{"type":"string","description":"The ID of the password credential","format":"uuid4","example":"28a7206b-e789-435a-b87c-108e034135c2","uniqueKey":"password.id","typeLabel":"string\u003cuuid4>"},"created_at":{"description":"Time of creation of the password credential","type":"string","format":"date-time","uniqueKey":"password.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"description":"Time of last update of the password credential","type":"string","format":"date-time","uniqueKey":"password.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"password","typeLabel":"object"},"identities":{"description":"A list of third party provider identities","type":"array","items":{"description":"A third party provider identity","type":"object","properties":{"id":{"type":"string","description":"The ID of the identity","format":"uuid4","example":"77f8d594-9765-4891-ab2b-f31a797b531d","uniqueKey":"identities.items.[INDEX].id","typeLabel":"string\u003cuuid4>"},"email_id":{"type":"string","description":"The ID of the email this identity is coupled with","format":"uuid4","example":"d4095586-8318-4a40-a840-b4260496f85a","uniqueKey":"identities.items.[INDEX].email_id","typeLabel":"string\u003cuuid4>"},"provider_id":{"description":"The user's third party provider account/user ID","type":"string","uniqueKey":"identities.items.[INDEX].provider_id","typeLabel":"string"},"provider_name":{"description":"The name of the third party provider this identity coupled with","type":"string","uniqueKey":"identities.items.[INDEX].provider_name","typeLabel":"string"},"created_at":{"description":"Time of creation of the password credential","type":"string","format":"date-time","uniqueKey":"identities.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"description":"Time of last update of the password credential","type":"string","format":"date-time","uniqueKey":"identities.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"identities.items.[INDEX]","typeLabel":"object"},"uniqueKey":"identities","typeLabel":"object[]"},"metadata":{"description":"User metadata","type":"object","properties":{"public_metadata":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"metadata.public_metadata.additionalProperties","typeLabel":"any"},"example":{"role":"admin"},"uniqueKey":"metadata.public_metadata","typeLabel":"object"},"private_metadata":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"metadata.private_metadata.additionalProperties","typeLabel":"any"},"example":{"internal_id":"e6c19cfb-09a2-41e5-a908-e33193b7ca0a"},"uniqueKey":"metadata.private_metadata","typeLabel":"object"},"unsafe_metadata":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"metadata.unsafe_metadata.additionalProperties","typeLabel":"any"},"example":{"birthday":"2025-05-12"},"uniqueKey":"metadata.unsafe_metadata","typeLabel":"object"}},"uniqueKey":"metadata","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","webauthn_credentials":[{"id":"f9bebc04-b894-4018-bdb8-8b520a532fef","public_key":"\u003cstring>","attestation_type":"\u003cstring>","aaguid":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","backup_eligible":true,"backup_state":true,"mfa_only":true,"name":"\u003cstring>","transports":["\u003cstring>"],"last_used_at":"2023-11-07T05:31:56Z"}],"emails":[{"id":"802df042-1ac2-496d-af81-6ace729ed055","address":"jsmith@example.com","is_verified":true,"is_primary":true,"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}],"username":{"id":"8cbed467-554b-4d17-b23f-bce1b4f1db92","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","username":"john_doe_123"},"organizations":[{"id":"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c","name":"\u003cstring>","roles":[{"id":"c339547d-e17d-4ba7-8a1d-b3d5a4d17c1c","slug":"\u003cstring>","name":"\u003cstring>"}]}],"otp":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","created_at":"2023-11-07T05:31:56Z"},"password":{"id":"28a7206b-e789-435a-b87c-108e034135c2","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"},"identities":[{"id":"77f8d594-9765-4891-ab2b-f31a797b531d","email_id":"d4095586-8318-4a40-a840-b4260496f85a","provider_id":"\u003cstring>","provider_name":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}],"metadata":{"public_metadata":{"role":"admin"},"private_metadata":{"internal_id":"e6c19cfb-09a2-41e5-a908-e33193b7ca0a"},"unsafe_metadata":{"birthday":"2025-05-12"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"9867858f-3874-498d-a1b3-aefcd6eee230":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"code","typeLabel":"integer\u003cint32>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":400,"message":"Bad Request"},"examples":{"Example":{"title":"Example","value":{"code":400,"message":"Bad Request"}}},"exampleType":"examples"}},"exampleType":"examples"},"92677916-609a-4d3a-ab92-9ab9e740355d":{"description":"Conflict","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"code","typeLabel":"integer\u003cint32>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":409,"message":"Conflict"},"examples":{"Example":{"title":"Example","value":{"code":409,"message":"Conflict"}}},"exampleType":"examples"}},"exampleType":"examples"},"4c64eff5-177c-4df2-beda-781063615946":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"code","typeLabel":"integer\u003cint32>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":500,"message":"Internal Server Error"},"examples":{"Example":{"title":"Example","value":{"code":500,"message":"Internal Server Error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"e49fcb20-0c90-4189-a278-d625e62e10be":{"BearerApiKeyAuth":{"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your API key. Must only be used when using Hanko Cloud.","type":"http","scheme":"bearer","bearerFormat":"API Key","scopes":[],"schemeName":"BearerApiKeyAuth"}}},"servers":{"e081c432-ccf8-4da1-bfe3-62957c8527b9":{"url":"https://{tenant_id}.hanko.io/admin","variables":{"tenant_id":{"default":"","description":"The (UU)ID of a tenant. Replace the default value with your tenant ID."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your API key. Must only be used when using Hanko Cloud.","type":"http","scheme":"bearer","bearerFormat":"API Key","scopes":[],"schemeName":"BearerApiKeyAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your API key. Must only be used when using Hanko Cloud.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerApiKeyAuth","name":"Authorization"}],"title":"BearerApiKeyAuth"}]},"originalFileLocation":"openapi-admin.yaml"},"subdomain":"hanko","siteName":"Hanko","title":"Create a new user - Hanko","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-09T14:45:05.146Z","originalFileLocation":"api-reference/admin/user-management/create-a-new-user.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=\"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=\"Create a new user - Hanko\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hanko\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hanko.io/api-reference/admin/user-management/create-a-new-user\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hanko.mintlify.app/_mintlify/api/og/v2?division=User+Management\u0026amp;title=Create+a+new+user\u0026amp;theme=0019bde39b8e96d0b6d738b4\u0026amp;signature=f61b898cb64e623fdd20beec338909250490b3db8e9303a69b05d57e82062332\">\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=\"Create a new user - Hanko\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hanko.mintlify.app/_mintlify/api/og/v2?division=User+Management\u0026amp;title=Create+a+new+user\u0026amp;theme=0019bde39b8e96d0b6d738b4\u0026amp;signature=f61b898cb64e623fdd20beec338909250490b3db8e9303a69b05d57e82062332\">\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/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/admin/user-management/create-a-new-user\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/admin/user-management/create-a-new-user.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hanko.io/#organization\",\"name\":\"Hanko\",\"url\":\"https://docs.hanko.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hanko/cvvCniGfSDqJRest/logo/light.svg?fit=max\u0026auto=format\u0026n=cvvCniGfSDqJRest\u0026q=85\u0026s=c11abcf43f80ac4a882d948d9a697da6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hanko.io#website\",\"name\":\"Hanko\",\"url\":\"https://docs.hanko.io\",\"publisher\":{\"@id\":\"https://docs.hanko.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hanko.io/api-reference/admin/user-management/create-a-new-user#webpage\",\"url\":\"https://docs.hanko.io/api-reference/admin/user-management/create-a-new-user\",\"name\":\"Create a new user\",\"dateModified\":\"2026-10-09T14:45:05.146Z\",\"isPartOf\":{\"@id\":\"https://docs.hanko.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hanko.io/api-reference/admin/user-management/create-a-new-user#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hanko.io/api-reference/admin/user-management/create-a-new-user#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Resources\",\"item\":\"https://docs.hanko.io/resources/examples\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API reference\",\"item\":\"https://docs.hanko.io/api-reference/flow/registration\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Admin\",\"item\":\"https://docs.hanko.io/api-reference/admin/status/status-page\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"User Management\",\"item\":\"https://docs.hanko.io/api-reference/admin/user-management/get-a-list-of-users\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Create a new user\",\"item\":\"https://docs.hanko.io/api-reference/admin/user-management/create-a-new-user\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hanko.io/api-reference/admin/user-management/create-a-new-user#apireference\",\"headline\":\"Create a new user\",\"name\":\"Create a new user\",\"url\":\"https://docs.hanko.io/api-reference/admin/user-management/create-a-new-user\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hanko.io/api-reference/admin/user-management/create-a-new-user#webpage\"},\"dateModified\":\"2026-10-09T14:45:05.146Z\",\"publisher\":{\"@id\":\"https://docs.hanko.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hanko.io#website\"}}]}\u003c/script>\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","description":null,"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","description":null,"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","pages":[{"title":"Passkey API Docs","href":"/passkey-api/introduction"}]},{"tab":"Hanko Authenticator Docs","pages":[{"title":"Hanko Authenticator Docs","href":"/hanko-authenticator/introduction"}]}]},"title":"Create a new user - Hanko","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}